Archicad 29 C++ API
Loading...
Searching...
No Matches
ACAPI::Library::LibraryManager Class Referencefinal

LibraryManager is the central point of the Library and the LibPart management. More...

#include <LibraryManager.hpp>

Inheritance diagram for ACAPI::Library::LibraryManager:
ACAPI::Object

Classes

class  Modifier
 The Modifier object of the LibraryManager. More...
 

Public Member Functions

Result< void > ModifyLibraryList (const std::function< GSErrCode(Modifier &)> &modifierFunc)
 Executed the passed modifier scope in a NotUndoable command.
 
std::vector< LibraryFindLibraries (const std::function< bool(const Library &)> &selector) const
 Find Libraries using a custom selector function.
 
Result< LibraryFindLibrary (const std::function< bool(const Library &)> &selector) const
 Find Library using a custom selector function.
 
Result< LibraryGetLibraryByName (const GS::UniString &name) const
 Returns the Library with the given name.
 
Result< LibraryGetEmbeddedLibrary () const
 A faster way to get the embedded library.
 
Result< LibraryGetLibraryOfLibPart (const LibPart &libPart) const
 Returns the Library containing the Library Part.
 
std::vector< LibPartFindLibParts (const std::function< bool(const LibPart &)> &selector) const
 Find LibParts using a custom selector function.
 
Result< LibPartFindLibPart (const std::function< bool(const LibPart &)> &selector) const
 Find Library Part using a custom selector function.
 
Result< LibPartGetLibPartByName (const GS::UniString &name) const
 Returns a library part with the filename.
 
Result< LibPartGetLibPartByGSMObject (const GSMObject &gsmObject) const
 Returns the Library Part of the GSMObject.
 
Result< LibraryTreePathGetLibraryTreePathOfLibPart (const LibPart &libPart) const
 Returns the LibraryTreePath of the LibPart.
 
Result< GS::Guid > GetTWID (const LibraryTreePath &libraryTreePath) const
 Returns the Teamwork Identifier of the Library Tree location.
 
Result< GSMObjectGetGSMObjectOfLibPart (const LibPart &libPart) const
 Returns the .gsm object representation of the Library Part.
 
Result< GSMObjectLoadGSMObjectFromFile (const IO::Location &location) const
 Loads a .gsm object from a file.
 
Result< LibPartGetLibPartByLibInd (Int32 libPartIndex) const
 Returns a library part with the given index.
 
Result< Int32 > GetLibIndOfLibPart (const LibPart &libPart) const
 Returns the index of the library part.
 
- Public Member Functions inherited from ACAPI::Object
 Object (std::shared_ptr< Impl::ObjectImpl > impl)
 Constructs a new object.
 
const API_TokenGetToken () const
 Get the token for this object.
 

Friends

Result< LibraryManagerGetLibraryManager ()
 Creates a LibraryManager instance.
 

Additional Inherited Members

- Protected Member Functions inherited from ACAPI::Object
 ~Object ()
 Default destructor.
 
- Protected Attributes inherited from ACAPI::Object
std::shared_ptr< Impl::ObjectImplmImpl
 Impl object given by constructor.
 

Detailed Description

LibraryManager is the central point of the Library and the LibPart management.

Since
Archicad 28

Friends And Related Symbol Documentation

◆ GetLibraryManager

Result< LibraryManager > GetLibraryManager ( )
friend

Creates a LibraryManager instance.

Returns
The new LibraryManager instance if a plan is loaded otherwise APIERR_NOPLAN.
Remarks
This is the entry point of the Library Management on the API.