InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ILibrarySuite Class Referenceabstract
Inheritance diagram for ILibrarySuite:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ILIBRARYSUITE }
 

Public Member Functions

virtual bool16 CanAddToLibrary (ILibrary *library, IControlView *view) const =0
 
virtual bool16 CanUpdateLibraryItem (ILibrary *library, const AssetIDList &assetList, IControlView *view) const =0
 
virtual bool16 CanAddPageToLibrary (ILibrary *library, IControlView *view) const =0
 
virtual bool16 CanPlaceLibraryItems (const AssetIDList &assetList, ILibrary *library, IControlView *view) const =0
 
virtual ErrorCode DoAddToLibrary (ILibrary *library, AssetIDList *newAssetIDList, IControlView *view)=0
 
virtual ErrorCode DoUpdateLibraryItem (ILibrary *library, AssetIDList *assetIDList, IControlView *view)=0
 
virtual ErrorCode DoAddPageToLibrary (ILibrary *library, AssetIDList *newAssetIDList, IControlView *view, bool16 bSeparateAssets=kFalse)=0
 
virtual ErrorCode DoPlaceLibraryItems (const AssetIDList &assetList, ILibrary *library, UIDList &out_placedItemList, IControlView *view)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Function Documentation

virtual bool16 ILibrarySuite::CanAddPageToLibrary (ILibrarylibrary,
IControlViewview 
) const
pure virtual

Can the contents of current page be added to the library? Return kTrue or kFalse.

Parameters
library
assetIDListsingle-element list containing the ID of the asset to update
view- Control View to use
Returns
bool16
virtual bool16 ILibrarySuite::CanAddToLibrary (ILibrarylibrary,
IControlViewview 
) const
pure virtual

Can the selection be added to the library? Return kTrue or kFalse.

Parameters
library
view- Control View to use
Returns
bool16
virtual bool16 ILibrarySuite::CanPlaceLibraryItems (const AssetIDListassetList,
ILibrarylibrary,
IControlViewview 
) const
pure virtual

Can the library assets be placed? Return kTrue or kFalse.

Parameters
assetList[IN] the assets to place.
library
view- Control View to use
Returns
bool16
virtual bool16 ILibrarySuite::CanUpdateLibraryItem (ILibrarylibrary,
const AssetIDListassetList,
IControlViewview 
) const
pure virtual

Can the selection be used to update the item in the library? Return kTrue or kFalse.

Parameters
library
view- Control View to use
Returns
bool16
virtual ErrorCode ILibrarySuite::DoAddPageToLibrary (ILibrarylibrary,
AssetIDListnewAssetIDList,
IControlViewview,
bool16 bSeparateAssets = kFalse 
)
pure virtual

Add the contents of current page to the library.

Parameters
library
newAssetIDList[OUT] receives the assets created
view- Control View to use
bSeparateAssets- if kTrue, add each item as a separate asset; else add all as a single asset
Returns
ErrorCode
virtual ErrorCode ILibrarySuite::DoAddToLibrary (ILibrarylibrary,
AssetIDListnewAssetIDList,
IControlViewview 
)
pure virtual

Add the selection to the library.

Parameters
library
newAssetIDList[OUT] receives the assets created
view- Control View to use
Returns
ErrorCode
virtual ErrorCode ILibrarySuite::DoPlaceLibraryItems (const AssetIDListassetList,
ILibrarylibrary,
UIDListout_placedItemList,
IControlViewview 
)
pure virtual

Place items from library into a document.

Parameters
&assetList
*library
out_placedItemList[OUT] receives UIDs of items after placed in document.
view- Control View to use
Returns
ErrorCode
virtual ErrorCode ILibrarySuite::DoUpdateLibraryItem (ILibrarylibrary,
AssetIDListassetIDList,
IControlViewview 
)
pure virtual

Update an asset in the library, using the selection.

Parameters
library
assetIDList[IN] single-element list containing the ID of the asset to update
view- Control View to use
Returns
ErrorCode