#include <PrefsScriptProvider.h>

Inheritance diagram for SingletonScriptProvider:

Protected Types
typedef RepresentScriptProvider	Inherited

Protected Types inherited from RepresentScriptProvider
typedef CScriptProvider	Inherited

Protected Types inherited from CScriptProvider
typedef CPMUnknown < IScriptProvider >	Inherited

Protected Member Functions
	SingletonScriptProvider (IPMUnknown *boss)

virtual	~SingletonScriptProvider ()

virtual void	GetObject (IScriptRequestData data, IScript parent)

virtual int32	GetNumObjects (const IScriptRequestData data, IScript parent)

virtual ErrorCode	AppendNthObject (const IScriptRequestData data, IScript parent, int32 n, ScriptList &objectList)

virtual ErrorCode	AccessProperty (ScriptID propID, IScriptRequestData data, IScript script)

void	DefineSingleton (const ScriptID &objectID, const ScriptID &propID, const ClassID &bossID)

virtual ErrorCode	AccessSingleton (ScriptID propID, IScriptRequestData data, IScript parent)

virtual bool16	CanAccessSingleton (ScriptID propID, IScript *parent) const

virtual IScript *	QuerySingleton (const IScriptRequestData data, IScript parent, const ScriptID &propID)

Protected Member Functions inherited from RepresentScriptProvider
	RepresentScriptProvider (IPMUnknown *boss)

virtual ErrorCode	GetObjectByIndex (IScriptRequestData data, IScript parent)

virtual ErrorCode	GetObjectByName (IScriptRequestData data, IScript parent)

virtual ErrorCode	GetObjectByID (IScriptRequestData data, IScript parent)

virtual ErrorCode	GetObjectByRange (IScriptRequestData data, IScript parent)

virtual ErrorCode	GetObjectPrevious (IScriptRequestData data, IScript parent)

virtual ErrorCode	GetObjectNext (IScriptRequestData data, IScript parent)

virtual ErrorCode	GetObjectFirst (IScriptRequestData data, IScript parent)

virtual ErrorCode	GetObjectLast (IScriptRequestData data, IScript parent)

virtual ErrorCode	GetObjectMiddle (IScriptRequestData data, IScript parent)

virtual ErrorCode	GetObjectAny (IScriptRequestData data, IScript parent)

virtual ErrorCode	GetObjectAll (IScriptRequestData data, IScript parent)

virtual ErrorCode	GetObjectWhose (IScriptRequestData data, IScript parent)

virtual ErrorCode	HandleMethod (ScriptID methodID, IScriptRequestData data, IScript script)

virtual ErrorCode	AppendAllObjects (const IScriptRequestData data, IScript parent, ScriptList &objectList)

virtual ErrorCode	AppendObjectsWhose (const IScriptRequestData data, IScript parent, ScriptID propID, const ScriptData &propData, bool16 bFirstMatchOnly, ScriptList &objectList)

virtual int32	GetObjectIndex (const IScriptRequestData data, IScript parent, IScript *script)

virtual ErrorCode	CountObjects (ScriptID methodID, IScriptRequestData data, IScript parent)

virtual ErrorCode	AccessObject (ScriptID propID, IScriptRequestData data, IScript script)

virtual ErrorCode	AccessID (ScriptID propID, IScriptRequestData data, IScript script)

virtual ErrorCode	AccessIndex (ScriptID propID, IScriptRequestData data, IScript script)

virtual ErrorCode	AccessLabel (ScriptID propID, IScriptRequestData data, IScript script)

virtual ErrorCode	AccessClass (ScriptID propID, IScriptRequestData data, IScript script)

virtual ErrorCode	AccessPropertiesProperty (ScriptID propID, IScriptRequestData data, IScript script)

virtual ErrorCode	ExtractLabel (ScriptID methodID, IScriptRequestData data, IScript script)

virtual ErrorCode	InsertLabel (ScriptID methodID, IScriptRequestData data, IScript script)

ErrorCode	GetIndex (const IScriptRequestData data, IScript parent, const ScriptData &accessorData, int32 &index)

Protected Member Functions inherited from CScriptProvider
	CScriptProvider (IPMUnknown *boss)

virtual void	HandleMethodOnObjects (ScriptID methodID, IScriptRequestData *data, const ScriptList &scriptList)

virtual void	AccessPropertyOnObjects (ScriptID propID, IScriptRequestData *data, const ScriptList &scriptList)

virtual void	AccessProperties (IScriptRequestData data, IScript script)

virtual ErrorCode	PreAccessProperty (ScriptID propID, IScriptRequestData data, IScript script)

virtual ErrorCode	PostAccessProperty (ScriptID propID, IScriptRequestData data, IScript script)

virtual ErrorCode	PreAccessProperties (IScriptRequestData data, IScript script)

virtual ErrorCode	PostAccessProperties (IScriptRequestData data, IScript script)

virtual ErrorCode	AccessParent (ScriptID propID, IScriptRequestData data, IScript script)

Protected Member Functions inherited from CPMUnknown< IScriptProvider >
	CPMUnknown (IPMUnknown *boss)

Additional Inherited Members
Public Types inherited from IScriptProvider
enum	{ kDefaultIID = IID_ISCRIPTPROVIDER }

Public Member Functions inherited from CPMUnknown< IScriptProvider >
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

Protected Attributes inherited from CPMUnknown< IScriptProvider >
HelperInterface	fHelperInterface

Detailed Description

A base implementation of IScriptProvider for script providers that represent singleton objects to subclass.

Member Typedef Documentation

typedef RepresentScriptProvider SingletonScriptProvider::Inherited

protected

Subclasses of this implementation will represent their singleton object

Constructor & Destructor Documentation

SingletonScriptProvider::SingletonScriptProvider ( IPMUnknown * boss )

protected

Constructor

virtual SingletonScriptProvider::~SingletonScriptProvider ( )

inlineprotectedvirtual

Destructor

Member Function Documentation

virtual ErrorCode SingletonScriptProvider::AccessProperty	(	ScriptID	propID,
		IScriptRequestData *	data,
		IScript *	script
	)

protectedvirtual

Override baseclass implementation to handle the ParentProperty on supported parents

Reimplemented from RepresentScriptProvider.

Reimplemented in PrefsScriptProvider, SnipRunScriptProvider, FrmLblPrefsScriptProvider, SnapPrefsScriptProvider, BPIPrefsScriptProvider, PrnSelScriptProvider, TranFxScriptProvider, PnlTrvScriptProvider, XDocBkPrefsScriptProvider, and CusDtLnkOptionScriptProvider.

virtual ErrorCode SingletonScriptProvider::AccessSingleton	(	ScriptID	propID,
		IScriptRequestData *	data,
		IScript *	parent
	)

protectedvirtual

Returns a singleton object

Parameters

propID	- the property of the parent corresponding to the desired singleton object
data	- script event data for this request
parent	- the parent object

virtual ErrorCode SingletonScriptProvider::AppendNthObject	(	const IScriptRequestData *	data,
		IScript *	parent,
		int32	n,
		ScriptList &	objectList
	)

protectedvirtual

Appends the nth singleton object of the parent

Implements RepresentScriptProvider.

Reimplemented in PrefsScriptProvider.

virtual bool16 SingletonScriptProvider::CanAccessSingleton	(	ScriptID	propID,
		IScript *	parent
	)		const

protectedvirtual

Returns kTrue if this script provider supports the singleton object

Parameters

propID	- the property of the parent corresponding to the desired singleton object
parent	- the parent object

void SingletonScriptProvider::DefineSingleton	(	const ScriptID &	objectID,
		const ScriptID &	propID,
		const ClassID &	bossID
	)

protected

Call in constructor for each singleton object that the subclass implementation represents

Parameters

objectID	- the id of the singleton object
propID	- the id of the property used to access the singleton object from a parent
bossID	- the id of the singleton object's script object boss

virtual int32 SingletonScriptProvider::GetNumObjects	(	const IScriptRequestData *	data,
		IScript *	parent
	)

protectedvirtual

Returns the number of this kind of singleton object on the parent (should always == 1)

Implements RepresentScriptProvider.

Reimplemented in PrefsScriptProvider.

virtual void SingletonScriptProvider::GetObject	(	IScriptRequestData *	data,
		IScript *	parent
	)

protectedvirtual

Override baseclass implementation to handle the one and only object on any parent

Reimplemented from RepresentScriptProvider.

virtual IScript* SingletonScriptProvider::QuerySingleton	(	const IScriptRequestData *	data,
		IScript *	parent,
		const ScriptID &	propID
	)

protectedvirtual

Creates a singleton object

Parameters

propID	- the property of the parent corresponding to the desired singleton object
parent	- the parent object

Protected Types

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation