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

#include <IPstLstData.h>

Inheritance diagram for IPstLstData:
IPMUnknownCPMUnknown< IPstLstData >PstLstDataPstLstDataPersist

Public Types

enum  { kDefaultIID = IID_IPSTLSTDATA }
 

Public Member Functions

virtual void SetName (const WideString &theLabel)=0
 
virtual const WideStringGetName ()=0
 
virtual void SetParent (const UID parent)=0
 
virtual UID GetParent () 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

This plug-in adds a UID list interface IPstLstUIDList to kDrawablePageItemBoss. A user can create multiple kPstLstDataBoss items and associate them with a page item by maintaining a list of UIDs through the IPstLstUIDList interface. Unlike the BasicPersistentInterface sample, which adds a persistent data interface directly to the kDrawablePageItemBoss, this sample allows more flexibility for adding custom data to a page item.

Member Function Documentation

virtual const WideString& IPstLstData::GetName ()
pure virtual

Gets the data in the persistent list item.

Returns
The data member (name) carried by the persistent list item.

Implemented in PstLstData, and PstLstDataPersist.

virtual UID IPstLstData::GetParent () const
pure virtual

Return reference to the boss object that owns this boss object.

Returns
the UID of the boss object that owns this boss object.

Implemented in PstLstData, and PstLstDataPersist.

virtual void IPstLstData::SetName (const WideStringtheLabel)
pure virtual

Sets the data in the persistent list item.

Parameters
theLabelThe data member (name) to be set

Implemented in PstLstData, and PstLstDataPersist.

virtual void IPstLstData::SetParent (const UID parent)
pure virtual

Set reference to the boss object that owns this boss object.

Parameters
parentUID of the boss object that owns this boss.

Implemented in PstLstData, and PstLstDataPersist.