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

Public Member Functions

 BscMEScriptProvider (IPMUnknown *boss)
 
 ~BscMEScriptProvider ()
 
virtual ErrorCode HandleMethod (ScriptID methodID, IScriptRequestData *data, IScript *parent)
 
virtual ErrorCode AccessProperty (ScriptID propID, IScriptRequestData *data, IScript *parent)
 

Protected Member Functions

virtual int32 GetNumObjects (const IScriptRequestData *data, IScript *parent)
 
virtual ErrorCode AppendNthObject (const IScriptRequestData *data, IScript *parent, int32 n, ScriptList &objectList)
 
- Protected Member Functions inherited from RepresentScriptProvider
 RepresentScriptProvider (IPMUnknown *boss)
 
virtual void GetObject (IScriptRequestData *data, IScript *parent)
 
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 AppendAllObjects (const IScriptRequestData *data, IScript *parent, ScriptList &objectList)
 
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 IScriptProvider
enum  { kDefaultIID = IID_ISCRIPTPROVIDER }
 
- Protected Types inherited from RepresentScriptProvider
typedef CScriptProvider Inherited
 
- Protected Attributes inherited from CPMUnknown< IScriptProvider >
HelperInterface fHelperInterface
 

Detailed Description

There is already well implemented scripting DOM in InDesign server for Middle Eastern (ME) text. BscMEScriptProvider provides the scripting method to access the ME features. It illustrates how to handle script elements such as page and paragraph, apply text attributes for ME text, apply world-ready composer on text.

Constructor & Destructor Documentation

BscMEScriptProvider::BscMEScriptProvider (IPMUnknownboss)
inline
Constructor.

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

Destructor. Does nothing.

Member Function Documentation

ErrorCode BscMEScriptProvider::AccessProperty (ScriptID propID,
IScriptRequestDatadata,
IScriptparent 
)
virtual
This method is 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.
parentidentifies an interface pointer on the script object representing the parent of the application object.

Reimplemented from RepresentScriptProvider.

ErrorCode BscMEScriptProvider::AppendNthObject (const IScriptRequestDatadata,
IScriptparent,
int32 n,
ScriptList & objectList 
)
protectedvirtual
int32 BscMEScriptProvider::GetNumObjects (const IScriptRequestDatadata,
IScriptparent 
)
protectedvirtual
Binds the C implementation class onto its ImplementationID making the C code callable by the application *ErrorCode BscMEScriptProvider::HandleMethod (ScriptID methodID,
IScriptRequestDatadata,
IScriptparent 
)
virtual
This method is called if a provider can handle an method.

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

Reimplemented from RepresentScriptProvider.