InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ILibraryAsset Class Referenceabstract

#include <ILibraryAsset.h>

Inheritance diagram for ILibraryAsset:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ILIBRARYASSET }
 

Public Member Functions

virtual LibraryAssetID GetID () const =0
 
virtual UID GetUID () const =0
 
virtual ILibraryAssetCollectionGetCollection ()=0
 
virtual bool16 HasWriteAccess () const =0
 
virtual bool16 AcquireWriteAccess ()=0
 
virtual void ReleaseWriteAccess ()=0
 
virtual void SetID (const LibraryAssetID &id)=0
 
virtual void SetCollection (ILibraryAssetCollection *assetCollection)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

The main interface to the LibraryAsset boss. Gets basic information about the asset and also controls write access.

Member Function Documentation

virtual bool16 ILibraryAsset::AcquireWriteAccess ()
pure virtual

Get exclusive write access to the asset. NOTE: Write access must be acquired before doing any operation that changes the asset.

Returns
whether write access to the asset has been acquired
virtual ILibraryAssetCollection* ILibraryAsset::GetCollection ()
pure virtual

Gets the asset collection this asset belongs to.

Returns
a pointer to the asset's owning ILibraryAssetCollection
virtual LibraryAssetID ILibraryAsset::GetID () const
pure virtual

Get the ID number of this asset.

Returns
the LibraryAssetID for the asset
virtual UID ILibraryAsset::GetUID () const
pure virtual

Get the asset UID.

Returns
the UID for the asset
virtual bool16 ILibraryAsset::HasWriteAccess () const
pure virtual

Test for exclusive write access to the asset. NOTE: Write access must be acquired before doing any operation that changes the asset.

Returns
whether write access to the asset has been acquired
virtual void ILibraryAsset::ReleaseWriteAccess ()
pure virtual

Release exclusive write access to the asset.

virtual void ILibraryAsset::SetCollection (ILibraryAssetCollectionassetCollection)
pure virtual
  • For Internal Use Only *
virtual void ILibraryAsset::SetID (const LibraryAssetIDid)
pure virtual
  • For Internal Use Only *