ILibraryAssetMetaData Class Reference

#include <ILibraryAssetMetaData.h>

Inheritance diagram for ILibraryAssetMetaData:

Public Types
enum	UserType {   kImageType = 0, kEPSType, kPDFType, kGeometryType,   kPageType, kTextType, kStructureType, kInDesignFileType }

Public Member Functions
virtual void	SetName (const PMString &name)=0
virtual PMString	GetName () const =0
virtual void	SetUserType (const UserType userType)=0
virtual UserType	GetUserType () const =0
virtual void	SetDescription (const PMString &description)=0
virtual PMString	GetDescription () const =0
virtual GlobalTime	GetCreationTime () const =0
virtual void	SetCreationTime (GlobalTime t)=0
virtual PMPoint	GetPosition () const =0
virtual void	SetPosition (PMPoint &pt)=0
virtual void	SetGenericProperty (PMString &propName, UIDRef &propValue)=0
virtual UIDRef	GetGenericProperty (PMString &propName)=0
virtual void	InitializeCreationTime ()=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

This secondary interface on the LibraryAsset boss controls reading and writing of the "meta" data of the asset (name, description, etc.). Note that this is NOT XMP data, but instead a format used internally by the Library palette.

Member Enumeration Documentation

enum ILibraryAssetMetaData::UserType

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 ILibraryAssetMetaData::GetCreationTime ( ) const

pure virtual

Get the creation time (and date) of the asset

Returns

the timestamp for the asset's creation

virtual PMString ILibraryAssetMetaData::GetDescription ( ) const

pure virtual

Get the asset's description.

Returns

the description given the asset

virtual UIDRef ILibraryAssetMetaData::GetGenericProperty ( PMString &  propName )

pure virtual

Get a generic property.

Parameters

propName

IN the name of the property

Returns

a UIDRef ro the property value

virtual PMString ILibraryAssetMetaData::GetName ( ) const

pure virtual

Get the asset's name.

Returns

the name given the asset

virtual PMPoint ILibraryAssetMetaData::GetPosition ( ) const

pure virtual

Get the asset's position on page when it was created. DEPRECATED

Returns

the position associated with the asset

virtual UserType ILibraryAssetMetaData::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 ILibraryAssetMetaData::InitializeCreationTime ( )

pure virtual

Initializes the creation time (and date) of the asset to the current date and time. * For Internal Use Only *

virtual void ILibraryAssetMetaData::SetCreationTime ( GlobalTime  t )

pure virtual

Set the creation time of the asset. This method is intended for use by code converters; clients in general should not re-set an existing creation time for an asset.

Parameters

t	IN the time to assign to the asset's creation time

virtual void ILibraryAssetMetaData::SetDescription ( const PMString &  description )

pure virtual

Sets the asset's description.

Parameters

description

IN string containing a new description for the asset

virtual void ILibraryAssetMetaData::SetGenericProperty ( PMString &  propName, UIDRef &  propValue  )

pure virtual

Set a generic property for the asset. The property must have previously been created.

Parameters

propName	IN the name of the property
propValue	IN UIDRef for the property value

virtual void ILibraryAssetMetaData::SetName ( const PMString &  name )

pure virtual

Set the asset's name.

Parameters

name	IN string containing a new name for the asset

virtual void ILibraryAssetMetaData::SetPosition ( PMPoint &  pt )

pure virtual

Assign the asset's position on page when it was created. DEPRECATED

Parameters

pt	IN the position (upper left) of the item

virtual void ILibraryAssetMetaData::SetUserType ( const UserType  userType )

pure virtual

Set the asset's User Type

Parameters

userType

IN User Type to assign to the asset