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

#include <IPnlTrvOptions.h>

Inheritance diagram for IPnlTrvOptions:
IPMUnknownCPMUnknown< IPnlTrvOptions >PnlTrvOptions

Public Types

enum  { kDefaultIID = IID_IPNLTRVOPTIONS }
 

Public Member Functions

virtual void AddOption (const WideString &newVal, const int32 indexWhere)=0
 
virtual WideString GetNthOption (const int32 index)=0
 
virtual void GetOptionListCopy (K2Vector< WideString > &outList)=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

From SDK sample; persistent interface added in to the session workspace, holding options for this plug-in.

Member Function Documentation

virtual void IPnlTrvOptions::AddOption (const WideStringnewVal,
const int32 indexWhere 
)
pure virtual

Append an option to the persistent list. If the index you specify is outwith the length, then it'll get appended to the list

Parameters
newVal[IN] new value to add to existing list of options
indexWhere[IN] where you want it in the list of options, zero based

Implemented in PnlTrvOptions.

virtual WideString IPnlTrvOptions::GetNthOption (const int32 index)
pure virtual

Return option at given index in list

Parameters
index[IN] zero-based index
Returns
PMString giving option at specified position

Implemented in PnlTrvOptions.

virtual void IPnlTrvOptions::GetOptionListCopy (K2Vector< WideString > & outList)
pure virtual

Retrieves current list of options as clone

Parameters
outListOUT contains copy of list of options

Implemented in PnlTrvOptions.