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

#include <IUIDData.h>

Inheritance diagram for IUIDData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IUIDDATA }
 

Public Member Functions

virtual IDataBaseGetItemDataBase () const =0
 
virtual UID GetItemUID () const =0
 
UID Get () const
 
virtual const UIDRefGetRef () const =0
 
Set - three alternate ways to set the value
virtual void Set (const IPMUnknown *item)=0
 
virtual void Set (IDataBase *db, UID id)=0
 
virtual void Set (const UIDRef &ref)=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

IUIDData is a data interface that holds onto a UIDRef (a <database, UID> pair) that can be used to uniquely describe a persistent object.

See Also
IPersistUIDData

Member Function Documentation

UID IUIDData::Get (void ) const
inline

standard signature (Get()) method

virtual IDataBase* IUIDData::GetItemDataBase () const
pure virtual

Get the database of the object

Returns
IDataBase* the database the object belongs to
virtual UID IUIDData::GetItemUID () const
pure virtual

Get the UID of the object

virtual const UIDRef& IUIDData::GetRef () const
pure virtual

Get the UIDRef of the object

virtual void IUIDData::Set (const IPMUnknownitem)
pure virtual

Set the value of the object. The pointer is for use inside the Set function only; the IPMUnknown* will be converted to a <database, UID> pair and held in that form, so that the object is not referenced.

Parameters
itemthe new object
virtual void IUIDData::Set (IDataBasedb,
UID id 
)
pure virtual

Set the value of the object.

Parameters
dbthe database the object is in
UIDthe object within the database
virtual void IUIDData::Set (const UIDRefref)
pure virtual

Set the value of the object.

Parameters
refthe <database, UID> pair that describes the object