BPIPrefsScriptProvider Class Reference

Inheritance diagram for BPIPrefsScriptProvider:

Public Member Functions
	BPIPrefsScriptProvider (IPMUnknown *boss)
	~BPIPrefsScriptProvider ()
virtual ErrorCode	AccessProperty (ScriptID propID, IScriptRequestData *data, IScript *script)
Public Member Functions inherited from PrefsScriptProvider
	PrefsScriptProvider (IPMUnknown *boss)
virtual	~PrefsScriptProvider ()

Additional Inherited Members
Public Types inherited from PrefsScriptProvider
typedef SingletonScriptProvider	Inherited
Protected Types inherited from SingletonScriptProvider
typedef RepresentScriptProvider	Inherited
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)
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; Handles scripting of BasicPersistInterface preference that stores the default value of the p_BPIData property used to label page items. The Provider statement for kBPIPrefsScriptProviderBoss in BPI.fr adds the preferences into the application and the document scripting objects. Consequently this script provider is passed an IScript interface on a kWorkspaceBoss or kDocWorkspaceBoss.

Constructor & Destructor Documentation

BPIPrefsScriptProvider::BPIPrefsScriptProvider

(

IPMUnknown *

boss

)

Constructor.

Parameters

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

BPIPrefsScriptProvider::~BPIPrefsScriptProvider ( )

inline

Destructor.

Member Function Documentation

ErrorCode BPIPrefsScriptProvider::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 a script object.

Reimplemented from PrefsScriptProvider.