Inheritance diagram for TranFxScriptProvider:

Public Member Functions
	TranFxScriptProvider (IPMUnknown *boss)

	~TranFxScriptProvider ()

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

Public Member Functions inherited from PrefsScriptProvider
	PrefsScriptProvider (IPMUnknown *boss)

virtual	~PrefsScriptProvider ()

Protected Member Functions
ErrorCode	GetTransparencyEffectProperty (IScript script, const ScriptID &propID, IScriptRequestData data)

ErrorCode	SetTransparencyEffectProperty (IScript script, const ScriptID &propID, IScriptRequestData data)

ErrorCode	GetBool (bool16 &value, const ScriptID &scriptID, IScriptRequestData *data, bool16 isRequired=kTrue) const

ErrorCode	GetPMReal (PMReal &outValue, const ScriptID &scriptID, IScriptRequestData *data, bool16 isRequired=kTrue) const

ErrorCode	GetEnumeration (ScriptID &outValue, const ScriptID &scriptID, IScriptRequestData *data, bool16 isRequired=kTrue) const

IScript *	QueryScript (const ScriptID &scriptID, IScriptRequestData *data, bool16 isRequired=kTrue) const

Protected Member Functions inherited from PrefsScriptProvider
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)

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)

Additional Inherited Members
Public Types inherited from PrefsScriptProvider
typedef SingletonScriptProvider	Inherited

Protected Types inherited from SingletonScriptProvider
typedef RepresentScriptProvider	Inherited

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

Protected Attributes inherited from CPMUnknown< IScriptProvider >
HelperInterface	fHelperInterface

Detailed Description

From SDK sample, implements IScriptProvider.

Constructor & Destructor Documentation

TranFxScriptProvider::TranFxScriptProvider ( IPMUnknown * boss )

Constructor.

Parameters

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

TranFxScriptProvider::~TranFxScriptProvider ( )

inline

Destructor.

Member Function Documentation

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

virtual

Called if a provider can handle a property.

Parameters

propID	identifies the ID of the property to handle.
data	identifies an interface pointer used to extract data.
script	identifies an interface pointer on the script object representing the parent of the application object.

Reimplemented from PrefsScriptProvider.

ErrorCode TranFxScriptProvider::GetBool	(	bool16 &	value,
		const ScriptID &	scriptID,
		IScriptRequestData *	data,
		bool16	isRequired = `kTrue`
	)		const

protected

Get the given boolean parameter from the script event data.

Parameters

value	OUT the parameter value
scriptID	IN identifies the desired parameter
data	IN the script event data
isRequired	kTrue if required, kFalse if optional

Returns: kSuccess on success, other ErrorCode otherwise

IScript * TranFxScriptProvider::QueryScript	(	const ScriptID &	scriptID,
		IScriptRequestData *	data,
		bool16	isRequired = `kTrue`
	)		const

protected

Return the IScript interface of the given object parameter in the script event data.

Parameters

scriptID	identifies the desired parameter
data	the script event data
isRequired	kTrue if required, kFalse if optional

Returns: IScript interface of the desired object, nil if not found in the script data.

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation