#include <PrefsScriptProvider.h>

Inheritance diagram for PrefsScriptProvider:

Public Types
typedef SingletonScriptProvider	Inherited

Public Member Functions
	PrefsScriptProvider (IPMUnknown *boss)

virtual	~PrefsScriptProvider ()

Protected Member Functions
virtual int32	GetNumObjects (const IScriptRequestData data, IScript parent)

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

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

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

void	DefinePreference (const ScriptID &objectID, const ScriptID &propID, const ClassID &bossID=kBasePrefsScriptObjectBoss)

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

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

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

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

virtual	~SingletonScriptProvider ()

virtual void	GetObject (IScriptRequestData data, IScript parent)

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	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)

Static Protected Member Functions
static IPMUnknown *	QueryPreferences (const IScriptRequestData data, const IScript prefsScript, const PMIID &prefInterfaceID)

Additional Inherited Members
Protected Types inherited from SingletonScriptProvider
typedef RepresentScriptProvider	Inherited

Protected Attributes inherited from CPMUnknown< IScriptProvider >
HelperInterface	fHelperInterface

Detailed Description

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

Member Typedef Documentation

typedef SingletonScriptProvider PrefsScriptProvider::Inherited

Subclasses of this implementation will represent their preferences object

Constructor & Destructor Documentation

PrefsScriptProvider::PrefsScriptProvider ( IPMUnknown * boss )

inline

Constructor

virtual PrefsScriptProvider::~PrefsScriptProvider ( )

inlinevirtual

Destructor

Member Function Documentation

virtual ErrorCode PrefsScriptProvider::AccessPreference	(	ScriptID	propID,
		IScriptRequestData *	data,
		IScript *	parent
	)

protectedvirtual

Returns a preferences object

Parameters

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

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

protectedvirtual

Override baseclass implementation to handle the ParentProperty on supported parents

Reimplemented from SingletonScriptProvider.

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

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

protectedvirtual

Appends every preferences object of the parent

Reimplemented from RepresentScriptProvider.

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

protectedvirtual

Appends the nth preferences object of the parent

Reimplemented from SingletonScriptProvider.

virtual bool16 PrefsScriptProvider::CanAccessPreference	(	ScriptID	propID,
		IScript *	parent
	)		const

protectedvirtual

Returns kTrue if this script provider supports the preferences object

Parameters

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

void PrefsScriptProvider::DefinePreference	(	const ScriptID &	objectID,
		const ScriptID &	propID,
		const ClassID &	bossID = `kBasePrefsScriptObjectBoss`
	)

protected

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

Parameters

objectID	- the id of the preferences object
propID	- the id of the property used to access the preferences object from a parent
bossID	- the id of the preferences objects script object boss

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

protectedvirtual

Returns the number of this kind of preferences object on the parent

Reimplemented from SingletonScriptProvider.

static IPMUnknown* PrefsScriptProvider::QueryPreferences	(	const IScriptRequestData *	data,
		const IScript *	prefsScript,
		const PMIID &	prefInterfaceID
	)

staticprotected

Returns an interface on the preferences boss in the appropriate workspace (doc or session) containing the preferences script object

virtual IScript* PrefsScriptProvider::QueryPrefScript	(	const IScriptRequestData *	data,
		IScript *	parent,
		const ScriptID &	propID
	)

protectedvirtual

Creates a preferences object

Parameters

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

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation