PnlTrvOptions Class Reference

Inheritance diagram for PnlTrvOptions:

Public Member Functions
	PnlTrvOptions (IPMUnknown *boss)
virtual	~PnlTrvOptions ()
virtual void	AddOption (const WideString &newVal, const int32 indexWhere)
virtual WideString	GetNthOption (const int32 index)
virtual void	GetOptionListCopy (K2Vector< WideString > &outList)
virtual void	ReadWrite (IPMStream *s, ImplementationID prop)
Public Member Functions inherited from CPMUnknown< IPnlTrvOptions >
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 IPnlTrvOptions
enum	{ kDefaultIID = IID_IPNLTRVOPTIONS }
Protected Member Functions inherited from CPMUnknown< IPnlTrvOptions >
	CPMUnknown (IPMUnknown *boss)
Protected Attributes inherited from CPMUnknown< IPnlTrvOptions >
HelperInterface	fHelperInterface

Detailed Description

Class to persist a list of options to the session workspace. PnlTrvOptions is a persistent implementation of interface IPnlTrvOptions.

Constructor & Destructor Documentation

This macro creates a persistent class factory for the given class name and registers the ID with the host * PnlTrvOptions::PnlTrvOptions

(

IPMUnknown *

boss

)

Constructor

Parameters

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

virtual PnlTrvOptions::~PnlTrvOptions ( )

inlinevirtual

Destructor

Member Function Documentation

void PnlTrvOptions::AddOption ( const WideString &  newVal, const int32  indexWhere  )

virtual

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

Parameters

newVal

[IN] new value. indexWhere [IN] position you want the option

Implements IPnlTrvOptions.

WideString PnlTrvOptions::GetNthOption ( const int32  index )

virtual

Retrieves list option specified by index.

Parameters

index

[IN] specifies index of desired option.

Returns

Returns option as string.

Implements IPnlTrvOptions.

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

inlinevirtual

Retrieves current list option (for Undo). We only have one option hence the list is overkill, but if you store more options, then you'd only need to modify this method.

Returns

Returns option as string.

Implements IPnlTrvOptions.

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

virtual

Persistence related method; reads from or writes to given stream

Parameters

s	[IN] the persistent in and out stream.
prop	[IN] the implementation ID.