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

#include <IPersistUIDListData.h>

Inheritance diagram for IPersistUIDListData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IPERSISTUIDLISTDATA }
 

Public Member Functions

virtual void Set (PersistUIDList *array)=0
 
virtual const PersistUIDListGetUIDList () const =0
 
virtual IDataBaseGetDataBase () const =0
 
virtual int32 Length () const =0
 
virtual const UIDRef GetItemRef (int32 index) const =0
 
virtual void Remove (int32 at)=0
 
virtual void Append (const UID t)=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

Interface for storing list of UID values (as PersistUIDList).

See Also
PersistUIDList
UIDList

Member Function Documentation

virtual void IPersistUIDListData::Append (const UID t)
pure virtual

Appends an item to the list.

Parameters
tUID to append to the list.
virtual IDataBase* IPersistUIDListData::GetDataBase () const
pure virtual

Returns the database the UIDs all belong to.

Returns
IDataBase* the database the UIDs belong to
virtual const UIDRef IPersistUIDListData::GetItemRef (int32 index) const
pure virtual

Returns the UIDRef of the n'th UID in the list.

Parameters
indexthe index number of the item to return
Returns
UIDRef of the item
virtual const PersistUIDList* IPersistUIDListData::GetUIDList () const
pure virtual

Returns a pointer to the list.

Returns
A pointer to the list.
virtual int32 IPersistUIDListData::Length () const
pure virtual
Returns
the number of UIDs in the list
virtual void IPersistUIDListData::Remove (int32 at)
pure virtual

Removes a UID from the list.

Parameters
atindex into the list of the UID to remove.
virtual void IPersistUIDListData::Set (PersistUIDListarray)
pure virtual

Set the list to the incoming value. Set takes ownership of the pointer, and IPersistUIDListData will be responsible for deleting it.

Parameters
arraythe new list of UIDs. IPersistUIDListData takes ownership of the pointer, and IPersistUIDListData will be responsible for deleting it.