PstLstUIDList Class Reference

Inheritance diagram for PstLstUIDList:

Public Member Functions
	PstLstUIDList (IPMUnknown *boss)
virtual	~PstLstUIDList ()
virtual void	Append (const UID &uid)
virtual void	Remove (const UID &uid)
virtual const UIDList *	GetUIDList ()
virtual UIDRef	GetRef (int32 index)
virtual IDataBase *	GetDataBase ()
virtual void	ReadWrite (IPMStream *s, ImplementationID prop)
Public Member Functions inherited from CPMUnknown< IPstLstUIDList >
IPMUnknown *	QueryInterface (PMIID interfaceID) const
void	AddRef () const
void	Release () const
void	PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
void	PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
	CPMUnknown (const CPMUnknown &)=delete
CPMUnknown &	operator= (const CPMUnknown &)=delete

Additional Inherited Members
Public Types inherited from IPstLstUIDList
enum	{ kDefaultIID = IID_IPSTLSTUIDLIST }
Protected Member Functions inherited from CPMUnknown< IPstLstUIDList >
	CPMUnknown (IPMUnknown *boss)
Protected Attributes inherited from CPMUnknown< IPstLstUIDList >
HelperInterface	fHelperInterface

Detailed Description

A persistent IPstLstUIDList implementation, which is aggregated in kDrawablePageItemBoss. When this plug-in is loaded, a page item will carry this UID list which contains UIDs of all associated persistent list items. UIDs of persistent list items are added to the list by processing kPstLstNewDataCmdBoss. PstLstUIDList allows adding/removing of a UID to/from the list. In the UI plug-in (persistentlistui), a user can see this list of UIDs as children of drawable page item node on the plug-in's panel.

Constructor & Destructor Documentation

PstLstUIDList::PstLstUIDList

(

IPMUnknown *

boss

)

Constructor.

Parameters

boss	interface ptr from boss object on which this interface is aggregated.

PstLstUIDList::~PstLstUIDList ( )

virtual

Destructor. The UIDList is deleted.

Member Function Documentation

void PstLstUIDList::Append ( const UID &  uid )

virtual

Appends a UID of an object to the UID list of persistent list items.

NOTE: This method must be called from within a command, as it internally dirties the database. Client code must process the kPstLstNewDataCmdBoss instead of calling this method directly.

Parameters

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

See Also

kPstLstNewDataCmdBoss

Implements IPstLstUIDList.

IDataBase * PstLstUIDList::GetDataBase ( void  )

virtual

Gets the database associated with the persistent list.

Returns

the database that stores the UID list

Implements IPstLstUIDList.

UIDRef PstLstUIDList::GetRef ( int32  index )

virtual

Given an index, this routine will return the corresponding object's UIDRef.

Parameters

index

IN The index of the object in the persistent item list.

Returns

The UIDRef of the desired object.

Implements IPstLstUIDList.

const UIDList * PstLstUIDList::GetUIDList ( )

virtual

Gets the list of persistent list items maintained.

Returns

UIDList maintained by this class.

Implements IPstLstUIDList.

void PstLstUIDList::ReadWrite ( IPMStream *  s, ImplementationID  prop  )

virtual

Because this is a persistent interface, it must support the ReadWrite method. This method is used for both writing data out to the database and reading data from the database. The infomation it reads/writes include the current selected UID and the whole UID list of persistent list items associated.

Parameters

s	IN Contains the stream to read or write.
prop	IN The implementation ID to read or write

void PstLstUIDList::Remove ( const UID &  uid )

virtual

Removes a UID of an object from the UID list of persistent list items.

NOTE: This method must be called from within a command, as it internally dirties the database. Client code must process the kPstLstDeleteDataCmdBoss instead of calling this method directly.

Parameters

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

See Also

kPstLstDeleteDataCmdBoss

Implements IPstLstUIDList.