InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
XDocBkOptions Class Reference
Inheritance diagram for XDocBkOptions:
CPMUnknown< IXDocBkOptions >IXDocBkOptionsIPMUnknown

Public Member Functions

 XDocBkOptions (IPMUnknown *boss)
 
virtual ~XDocBkOptions ()
 
virtual void AddOption (const WideString &newVal, const int32 indexWhere)
 
virtual WideString GetNthOption (const int32 index)
 
virtual int32 GetOptionCount ()
 
virtual void ReadWrite (IPMStream *s, ImplementationID prop)
 
- Public Member Functions inherited from CPMUnknown< IXDocBkOptions >
IPMUnknownQueryInterface (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
 
CPMUnknownoperator= (const CPMUnknown &)=delete
 

Additional Inherited Members

- Public Types inherited from IXDocBkOptions
enum  { kDefaultIID = IID_IXDOCBKOPTIONS }
 
- Protected Member Functions inherited from CPMUnknown< IXDocBkOptions >
 CPMUnknown (IPMUnknown *boss)
 
- Protected Attributes inherited from CPMUnknown< IXDocBkOptions >
HelperInterface fHelperInterface
 

Detailed Description

Class to persist a list of options to the session workspace. XDocBkOptions is a persistent implementation of interface IXDocBkOptions.

Constructor & Destructor Documentation

This macro creates a persistent class factory for the given class name and registers the ID with the host * XDocBkOptions::XDocBkOptions (IPMUnknownboss)

Constructor.

Parameters
bossIN interface ptr from boss object on which this interface is aggregated.
virtual XDocBkOptions::~XDocBkOptions ()
inlinevirtual

Destructor

Member Function Documentation

void XDocBkOptions::AddOption (const WideStringnewVal,
const int32 indexWhere 
)
virtual

Method to add in an options to the list of persistent options

See Also
IXDocBkOptions

Implements IXDocBkOptions.

WideString XDocBkOptions::GetNthOption (const int32 index)
virtual

GetNthOption

See Also
IXDocBkOptions

Implements IXDocBkOptions.

void XDocBkOptions::ReadWrite (IPMStreams,
ImplementationID prop 
)
virtual

Persistence related method; reads from or writes to given stream

Parameters
sIN the persistent in and out stream.
propIN the implementation ID