IScriptManager Class Reference

#include <IScriptManager.h>

Inheritance diagram for IScriptManager:

Public Types
enum	{ kDefaultIID = IID_ISCRIPTMANAGER }

Public Member Functions
virtual ErrorCode	Install ()=0
virtual ErrorCode	UnInstall ()=0
virtual bool16	IsScriptActive () const =0
virtual uint32	GetNumEngines () const =0
virtual IScriptEngine *	QueryNthEngine (uint32 n) const =0
virtual IScriptEngine *	QueryDefaultEngine () const =0
virtual ErrorPolicy	GetErrorPolicy (ScriptID requestID=kInvalidScriptID) const =0
virtual SetPropertiesOrderPolicy	GetSetPropertiesOrderPolicy () const =0
virtual FormatNamePolicy	GetFormatNamePolicy (ScriptElementType element, const RequestContext &context) const =0
virtual PMString	GetTypeAsString (const TypeInfo &ti, const ObjectScriptElement *pObjSI, int32 includeInfo) const =0
virtual PMString	GetTypeAsString (const TypeInfo &ti, const RequestContext &context, int32 includeInfo) const =0
virtual int32	GetBaseIndex () const =0
virtual ErrorCode	PublishDescription (const RequestContext &)=0
virtual ScriptVersion	GetMinimumDOMVersion (const PMLocaleId &locale) const =0
virtual ScriptVersion	GetMaximumDOMVersion (const PMLocaleId &locale) const =0
virtual ScriptID	GetLanguageEnumerator () const =0
virtual PMString	GetName () const =0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

Every scripting language supported by InDesign must implement this interface to provide basic information about support for the scripting language.

Most implementations will want to inherit from CScriptManager.

Member Function Documentation

virtual int32 IScriptManager::GetBaseIndex ( ) const

pure virtual

Returns

the base for an object's index; in other words, the index of the first object. Typically 0 (the default) or 1.

Implemented in CScriptManager.

virtual ErrorPolicy IScriptManager::GetErrorPolicy ( ScriptID  requestID = kInvalidScriptID ) const

pure virtual

Returns the policy for returning errors during a request

Parameters

requestID

the property or event ID for which the error policy is being requested (pass kInvalidScriptID to retrieve the default policy)

Implemented in CScriptManager.

virtual FormatNamePolicy IScriptManager::GetFormatNamePolicy ( ScriptElementType  element, const RequestContext &  context  ) const

pure virtual

Access to policies for formatting the name of script elements

Parameters

element	is the element type for which the format name policies are being requested
context	for the policy

Returns

the policy

Implemented in CScriptManager.

virtual ScriptID IScriptManager::GetLanguageEnumerator ( ) const

pure virtual

Returns

this client's enumerator for the kScriptLanguageEnumScriptElement (or kInvalidScriptID if not applicable)

Implemented in CScriptManager.

virtual ScriptVersion IScriptManager::GetMaximumDOMVersion ( const PMLocaleId &  locale ) const

pure virtual

Returns

this client's maximum script DOM version (the last DOM version supported by this client for the given product/feature set/locale)

Implemented in CScriptManager.

virtual ScriptVersion IScriptManager::GetMinimumDOMVersion ( const PMLocaleId &  locale ) const

pure virtual

Returns

this client's minimum script DOM version (the first DOM version supported by this client for the given product/feature set/locale)

Implemented in CScriptManager.

virtual PMString IScriptManager::GetName ( ) const

pure virtual

Returns

this client's name

Implemented in CScriptManager.

virtual uint32 IScriptManager::GetNumEngines ( ) const

pure virtual

Get the number of engines for this client

Implemented in CScriptManager.

virtual SetPropertiesOrderPolicy IScriptManager::GetSetPropertiesOrderPolicy ( ) const

pure virtual

Returns the policy for the order to set properties when setting multiple properties at once

Implemented in CScriptManager.

virtual PMString IScriptManager::GetTypeAsString ( const TypeInfo &  ti, const ObjectScriptElement *  pObjSI, int32  includeInfo  ) const

pure virtual

Convert a script info type into a string representation. This is the preferred overload.

Parameters

ti	is the type info to convert
the	object context for the conversion (must not be nil)
includeInfo	options are defined in enum TypeFormattingInfo

Returns

the string representation

Implemented in CScriptManager.

virtual PMString IScriptManager::GetTypeAsString ( const TypeInfo &  ti, const RequestContext &  context, int32  includeInfo  ) const

pure virtual

Convert a script info type into a string representation. Use this overload only if no ObjectScriptElement is relevant.

Parameters

ti	is the type info to convert
context	for the conversion
includeInfo	options are defined in enum TypeFormattingInfo

Returns

the string representation

Implemented in CScriptManager.

virtual ErrorCode IScriptManager::Install ( )

pure virtual

Tells the script manager to install

Implemented in CScriptManager.

virtual bool16 IScriptManager::IsScriptActive ( ) const

pure virtual

Determine whether a script is running under this manager

Implemented in CScriptManager.

virtual ErrorCode IScriptManager::PublishDescription ( const RequestContext &  )

pure virtual

Publish any information about the object model

Implemented in CScriptManager.

virtual IScriptEngine* IScriptManager::QueryDefaultEngine ( ) const

pure virtual

Query the default engine for this client

Implemented in CScriptManager.

virtual IScriptEngine* IScriptManager::QueryNthEngine ( uint32  n ) const

pure virtual

Query the nth engine for this client

Implemented in CScriptManager.

virtual ErrorCode IScriptManager::UnInstall ( )

pure virtual

Tells the script manager to uninstall

Implemented in CScriptManager.