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

#include <IUIDRefListData.h>

Inheritance diagram for IUIDRefListData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IUIDREFLISTDATA }
 

Public Member Functions

virtual UIDRef at (int32 index) const =0
 
virtual const K2Vector< UIDRef > * GetList () const =0
 
virtual void clear ()=0
 
virtual void insert (K2Vector< UIDRef >::iterator pos, UIDRef newItem)=0
 
virtual void insert (const UIDList &itemList)=0
 
virtual void push_back (UIDRef newItem)=0
 
virtual int32 size () const =0
 
virtual void Remove (int32 pos)=0
 
virtual int32 Location (UIDRef which)=0
 
virtual K2Vector< UIDRef >
::iterator 
begin ()=0
 
virtual K2Vector< UIDRef >
::const_iterator 
begin () const =0
 
virtual K2Vector< UIDRef >
::iterator 
end ()=0
 
virtual K2Vector< UIDRef >
::const_iterator 
end () const =0
 
virtual K2Vector< UIDRef >
::reverse_iterator 
rbegin ()=0
 
virtual K2Vector< UIDRef >
::reverse_iterator 
rend ()=0
 
virtual void CopyFrom (const IUIDRefListData *iUIDRefListData)=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

Data interface for storing a list of UIDRef objects. Use IUIDRefListData if you have a list of objects that are from different databases. If all the objects in the list are going to be from the same database, IUIDListData is more efficient.

See Also
IUIDListData
UIDList
UIDRef

Member Function Documentation

virtual UIDRef IUIDRefListData::at (int32 index) const
pure virtual

Return the n'th object in the list.

Parameters
index- which object to return (0-based).
Returns
UIDRef - a reference to the object. This can be instantiated.
virtual K2Vector<UIDRef>::iterator IUIDRefListData::begin ()
pure virtual

Return an iterator on the start of the list.

Returns
iterator on the start of the list.
virtual K2Vector<UIDRef>::const_iterator IUIDRefListData::begin () const
pure virtual

Return an iterator on the start of the list.

Returns
iterator on the start of the list.
virtual void IUIDRefListData::clear ()
pure virtual

Remove all items from the list.

virtual K2Vector<UIDRef>::iterator IUIDRefListData::end ()
pure virtual

Return an iterator on the end of the list.

Returns
iterator on the end of the list.
virtual K2Vector<UIDRef>::const_iterator IUIDRefListData::end () const
pure virtual

Return an iterator on the end of the list.

Returns
iterator on the end of the list.
virtual const K2Vector<UIDRef>* IUIDRefListData::GetList () const
pure virtual

Return a pointer to the list. The pointer continues to be owned by this object.

Returns
K2Vector(<UIDRef> - the list
virtual void IUIDRefListData::insert (K2Vector< UIDRef >::iterator pos,
UIDRef newItem 
)
pure virtual

Insert an item to the list.

Parameters
pos- where in the list to put the item
newItem- new entry to add.
virtual void IUIDRefListData::insert (const UIDListitemList)
pure virtual

Insert an items from uidlist to the list.

Parameters
uidList- stores items.
virtual int32 IUIDRefListData::Location (UIDRef which)
pure virtual

Find an item in the list.

Parameters
which- looks for a matching item
Returns
int32 - index where item was found, or -1 if item not in list
virtual void IUIDRefListData::push_back (UIDRef newItem)
pure virtual

Append an item to the end of the list.

Parameters
newItem- new entry to add
virtual K2Vector<UIDRef>::reverse_iterator IUIDRefListData::rbegin ()
pure virtual

Return a reverse iterator you can use to start iterating the list. It will start at the end of the list and walk back.

Returns
iterator on the start of the list.
virtual void IUIDRefListData::Remove (int32 pos)
pure virtual

Remove an item from the list.

Parameters
pos- index of which item to remove
virtual K2Vector<UIDRef>::reverse_iterator IUIDRefListData::rend ()
pure virtual

Return a reverse iterator to the "end" of the list. Use this to check the end condition on a reverse iteration through the list.

virtual int32 IUIDRefListData::size () const
pure virtual

Return the number of items in the list.

Returns
int32 - number of items in the list.