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

#include <IUIDListData.h>

Inheritance diagram for IUIDListData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IUIDLISTDATA }
 

Public Member Functions

virtual void Set (UIDList *array)=0
 
virtual IDataBaseGetDataBase ()=0
 
virtual const UIDRef GetItemRef (int32 index) const =0
 
virtual const UIDListGetRef () const =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 a list of UID values (UIDList). Use this when all the objects in the list are from the same database. Use IUIDRefListData if objects in the list can be from more than one database.

See Also
UIDList
UIDRef
IUIDRefListData

Member Function Documentation

virtual IDataBase* IUIDListData::GetDataBase ()
pure virtual
Return the database that the items in the list are in.

Returns
IDataBase* - which database the UIDs are in
virtual const UIDRef IUIDListData::GetItemRef (int32 index) const
pure virtual
Return the n'th item in the list.

Parameters
index- which item in the list to return (0-based)
Returns
UIDRef - the value of the item as an object reference. This can be instantiated.
virtual const UIDList* IUIDListData::GetRef () const
pure virtual
Return a pointer to the list. The pointer is still owned by this object, so if you need to 

make changes you should copy the list. The pointer is nil if the list has never been set. There is no need to delete it.

Returns
UIDList* - the list
virtual void IUIDListData::Set (UIDListarray)
pure virtual
Set the value of the list. This object will acquire ownership of the array, and will delete it.

Parameters
array- the new value of the list