InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
FrmLblPrefsScriptProvider Class Reference
Inheritance diagram for FrmLblPrefsScriptProvider:
PrefsScriptProviderSingletonScriptProviderRepresentScriptProviderCScriptProviderCPMUnknown< IScriptProvider >IScriptProviderIPMUnknown

Public Member Functions

 FrmLblPrefsScriptProvider (IPMUnknown *boss)
 
 ~FrmLblPrefsScriptProvider ()
 
virtual ErrorCode HandleMethod (ScriptID methodID, IScriptRequestData *data, IScript *script)
 
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 IScriptQueryPrefScript (const IScriptRequestData *data, IScript *parent, const ScriptID &propID)
 
- Static Protected Member Functions inherited from PrefsScriptProvider
static IPMUnknownQueryPreferences (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 the FrameLabel properties. See the Provider statement for kFrmLblPrefsScriptProviderBoss in FrmLbl.fr for the list of scripting objects on which the FrameLabel properties is available.

Constructor & Destructor Documentation

FrmLblPrefsScriptProvider::FrmLblPrefsScriptProvider (IPMUnknownboss)

Constructor.

Parameters
bossinterface ptr from boss object on which this interface is aggregated.
FrmLblPrefsScriptProvider::~FrmLblPrefsScriptProvider ()
inline

Destructor.

Member Function Documentation

ErrorCode FrmLblPrefsScriptProvider::AccessProperty (ScriptID propID,
IScriptRequestDatadata,
IScriptscript 
)
virtual

Called if a provider can handle a property.

Parameters
propIDidentifies the ID of the property to handle.
dataidentifies an interface pointer used to extract data.
scriptidentifies an interface pointer on the script object representing the parent of the application object.

Reimplemented from PrefsScriptProvider.

ErrorCode FrmLblPrefsScriptProvider::HandleMethod (ScriptID methodID,
IScriptRequestDatadata,
IScriptscript 
)
virtual

Called if a provider can handle a method/event.

Parameters
methodIDidentifies the ID of the method/event to handle.
dataidentifies an interface pointer used to extract data.
scriptidentifies an interface pointer on the script object representing the parent of the application object.

Reimplemented from RepresentScriptProvider.