#include <IUIDRefListData.h>
|
| enum | { kDefaultIID = IID_IUIDREFLISTDATA } |
| |
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
| 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.
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.
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.
Return a pointer to the list. The pointer continues to be owned by this object.
- Returns
- K2Vector(<UIDRef> - the list
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 UIDList & | itemList | ) | |
| pure virtual |
Insert an items from uidlist to the list.
- Parameters
| 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 |
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 |
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.