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

#include <ILibraryAssetProxy.h>

Public Types

enum  UserType {
  kImageType, kEPSType, kPDFType, kGeometryType,
  kPageType, kTextType, kStructureType, kInDesignFileType
}
 

Public Member Functions

virtual void Update ()=0
 
virtual LibraryAssetID GetID () const =0
 
virtual PMString GetName () const =0
 
virtual GlobalTime GetCreationTime () const =0
 
virtual UserType GetUserType () const =0
 
virtual AGMImageRecordGetThumbnailImage ()=0
 
virtual ILibraryAssetQueryActualAsset () const =0
 
virtual void PurgeMemory () const =0
 

Detailed Description

Library Panel's cache of information about a library asset.

Member Enumeration Documentation

What type an asset is. Determined by a heuristic algorithm, and ca be reassigned by the user. Do not change the order of the items in this enum, or logic that handles the dropdown menu will break.
Enumerator
kImageType 

Asset is an image

kEPSType 

Asset is an EPS

kPDFType 

Asset is a PDF

kGeometryType 

Asset is a non-placed graphic pageitem (line, box, oval...)

kPageType 

Asset is an entire page of items

kTextType 

Asset is a textframe

kStructureType 

Asset is an item from the structure panel

kInDesignFileType 

Asset is a placed InDesign file

Member Function Documentation

virtual GlobalTime ILibraryAssetProxy::GetCreationTime () const
pure virtual

Get the creation time (and date) of the asset.

Returns
the timestamp for the asset's creation
virtual LibraryAssetID ILibraryAssetProxy::GetID () const
pure virtual

Get the ID number of this asset.

Returns
the LibraryAssetID for the asset
virtual PMString ILibraryAssetProxy::GetName () const
pure virtual

Get the asset's name.

Returns
the name given the asset
virtual AGMImageRecord* ILibraryAssetProxy::GetThumbnailImage ()
pure virtual

Get a pointer to the asset's thumbnail image.

Returns
pointer to AGMImageRecord for the thumbnail
virtual UserType ILibraryAssetProxy::GetUserType () const
pure virtual

Get the asset's User Type. NOTE: User Type is just for user classification. It may or may not be accurate.

Returns
the UserType given the asset
virtual void ILibraryAssetProxy::PurgeMemory () const
pure virtual

Free any memory associated with cached values.

virtual ILibraryAsset* ILibraryAssetProxy::QueryActualAsset () const
pure virtual

Query the actual asset this proxy points to.

Returns
ILibraryAsset pointer for the asset. Caller must Release.
virtual void ILibraryAssetProxy::Update ()
pure virtual

Updates the state of the proxy to reflect any changes made to the actual asset.