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

Public Member Functions

 XDocBkPrefsScriptProvider (IPMUnknown *boss)
 
 ~XDocBkPrefsScriptProvider ()
 
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; shows how to implement a script provider for xdocbkworkflow preference,

See Scripting Resources defined in the plug-in's .fr file.

See Also
kXDocBkPrefsScriptProviderBoss - the scriptable boss
kXDocBkPrefObjectScriptElement - the script object that exposes kXDocBkPrefsScriptProviderBoss in the Scripting DOM
XDocBk.fr

Constructor & Destructor Documentation

XDocBkPrefsScriptProvider::XDocBkPrefsScriptProvider (IPMUnknownboss)
Constructor.

Parameters
bossinterface pointer from boss object on which this interface is aggregated.
XDocBkPrefsScriptProvider::~XDocBkPrefsScriptProvider ()

Destructor.

Member Function Documentation

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

Reimplemented from PrefsScriptProvider.