IPstLstUIDList Class Reference

#include <IPstLstUIDList.h>

Inheritance diagram for IPstLstUIDList:

Public Types
enum	{ kDefaultIID = IID_IPSTLSTUIDLIST }

Public Member Functions
virtual const UIDList *	GetUIDList ()=0
virtual UIDRef	GetRef (int32 index)=0
virtual IDataBase *	GetDataBase ()=0
virtual void	Append (const UID &uid)=0
virtual void	Remove (const UID &uid)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

An interface that maintains a list of UIDs of kPstLstDataBoss data objects created by this plug-in.

Member Function Documentation

virtual void IPstLstUIDList::Append ( const UID &  uid )

pure virtual

This function appends an uid of an object onto the UID list that it maintains.

Parameters

uid	the UID of the object to be appened to the UID list.

Implemented in PstLstUIDList.

virtual IDataBase* IPstLstUIDList::GetDataBase ( )

pure virtual

Returns

the database that stores the UID list

Implemented in PstLstUIDList.

virtual UIDRef IPstLstUIDList::GetRef ( int32  index )

pure virtual

Given an index, this routine will returns its corresponding UIDRef of the object as referenced by the index.

Parameters

index

the index of the object in the UID list that the user is interested in.

Returns

the UIDRef of the object that the user is inquiring about.

Implemented in PstLstUIDList.

virtual const UIDList* IPstLstUIDList::GetUIDList ( )

pure virtual

Returns

UID list this class maintains.

Implemented in PstLstUIDList.

virtual void IPstLstUIDList::Remove ( const UID &  uid )

pure virtual

This function removes an uid of an object from the UID list that it maintains.

Parameters

uid	the UID of the object to be removed from the UID list.

Implemented in PstLstUIDList.