InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Protected Member Functions | List of all members
CScriptManager Class Reference

#include <CScriptManager.h>

Inheritance diagram for CScriptManager:
CPMUnknown< IScriptManager >IScriptManagerIPMUnknown

Public Member Functions

 CScriptManager (IPMUnknown *boss)
 
virtual ErrorCode Install ()
 
virtual ErrorCode UnInstall ()
 
virtual bool16 IsScriptActive () const
 
virtual uint32 GetNumEngines () const
 
virtual IScriptEngine * QueryNthEngine (uint32 n) const
 
virtual IScriptEngine * QueryDefaultEngine () const
 
virtual ErrorPolicy GetErrorPolicy (ScriptID requestID=kInvalidScriptID) const
 
virtual SetPropertiesOrderPolicy GetSetPropertiesOrderPolicy () const
 
virtual FormatNamePolicy GetFormatNamePolicy (ScriptElementType element, const RequestContext &context) const
 
virtual PMString GetTypeAsString (const TypeInfo &ti, const ObjectScriptElement *pObjSI, int32 includeInfo) const
 
virtual PMString GetTypeAsString (const TypeInfo &ti, const RequestContext &context, int32 includeInfo) const
 
virtual int32 GetBaseIndex () const
 
virtual ErrorCode PublishDescription (const RequestContext &)
 
virtual ScriptVersion GetMinimumDOMVersion (const PMLocaleId &locale) const
 
virtual ScriptVersion GetMaximumDOMVersion (const PMLocaleId &locale) const
 
virtual ScriptID GetLanguageEnumerator () const
 
virtual PMString GetName () const
 
- Public Member Functions inherited from CPMUnknown< IScriptManager >
IPMUnknown * QueryInterface (PMIID interfaceID) const
 
void AddRef () const
 
void Release () const
 
void PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
 
void PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
 
 CPMUnknown (const CPMUnknown &)=delete
 
CPMUnknown & operator= (const CPMUnknown &)=delete
 

Protected Member Functions

virtual void AppendTypeAsString (const ObjectScriptElement *pObjSI, const RequestContext &context, const TypeInfo &ti, int32 includeInfo, PMString &typeString) const
 
virtual bool16 AppendBaseTypeAsString (const RequestContext &context, const TypeInfo &ti, int32 includeInfo, PMString &typeString) const
 
virtual bool16 AppendRangeDataAsString (const RequestContext &context, const TypeInfo &ti, int32 includeInfo, PMString &typeString) const
 
virtual bool16 AppendDefaultValueAsString (const RequestContext &context, const TypeInfo &ti, int32 includeInfo, PMString &typeString) const
 
virtual bool16 AppendObjectTypeAsString (const RequestContext &context, const TypeInfo &ti, int32 includeInfo, PMString &typeString) const
 
virtual bool16 AppendEnumTypeAsString (const RequestContext &context, const TypeInfo &ti, int32 includeInfo, PMString &typeString) const
 
virtual bool16 AppendTypeDefAsString (const ObjectScriptElement *pObjSI, const RequestContext &context, const TypeInfo &ti, int32 includeInfo, PMString &typeString) const
 
virtual bool16 AppendArrayString (const RequestContext &context, const TypeInfo &ti, int32 includeInfo, PMString &typeString) const
 
virtual bool16 AppendStructString (const RequestContext &context, const TypeInfo &ti, int32 includeInfo, PMString &typeString) const
 
void SetDefaultErrorPolicy (ErrorPolicy policy)
 
void SetSpecificErrorPolicy (ScriptID requestID, ErrorPolicy policy)
 
void SetSetPropertiesOrderPolicy (SetPropertiesOrderPolicy policy)
 
- Protected Member Functions inherited from CPMUnknown< IScriptManager >
 CPMUnknown (IPMUnknown *boss)
 

Additional Inherited Members

- Public Types inherited from IScriptManager
enum  { kDefaultIID = IID_ISCRIPTMANAGER }
 
- Protected Attributes inherited from CPMUnknown< IScriptManager >
HelperInterface fHelperInterface
 

Detailed Description

Base implementation for IScriptManager

Member Function Documentation

virtual bool16 CScriptManager::AppendArrayString (const RequestContext & context,
const TypeInfo & ti,
int32 includeInfo,
PMString & typeString 
) const
protectedvirtual

Appends the string for an array. Some client-specific implementations may want to override this method.

virtual bool16 CScriptManager::AppendBaseTypeAsString (const RequestContext & context,
const TypeInfo & ti,
int32 includeInfo,
PMString & typeString 
) const
protectedvirtual

Appends base type as a string. Most client-specific implementations WILL want to override this method.

virtual bool16 CScriptManager::AppendDefaultValueAsString (const RequestContext & context,
const TypeInfo & ti,
int32 includeInfo,
PMString & typeString 
) const
protectedvirtual

Appends default value as a string. Some client-specific implementations may want to override this method.

virtual bool16 CScriptManager::AppendEnumTypeAsString (const RequestContext & context,
const TypeInfo & ti,
int32 includeInfo,
PMString & typeString 
) const
protectedvirtual

Appends enum type as a string. Some client-specific implementations may want to override this method.

virtual bool16 CScriptManager::AppendObjectTypeAsString (const RequestContext & context,
const TypeInfo & ti,
int32 includeInfo,
PMString & typeString 
) const
protectedvirtual

Appends object type as a string. Some client-specific implementations may want to override this method.

virtual bool16 CScriptManager::AppendRangeDataAsString (const RequestContext & context,
const TypeInfo & ti,
int32 includeInfo,
PMString & typeString 
) const
protectedvirtual

Appends range data as a string. Some client-specific implementations may want to override this method.

virtual bool16 CScriptManager::AppendStructString (const RequestContext & context,
const TypeInfo & ti,
int32 includeInfo,
PMString & typeString 
) const
protectedvirtual

Appends the string for a struct. Some client-specific implementations may want to override this method.

virtual void CScriptManager::AppendTypeAsString (const ObjectScriptElement * pObjSI,
const RequestContext & context,
const TypeInfo & ti,
int32 includeInfo,
PMString & typeString 
) const
protectedvirtual

Appends type as a string. Most client-specific implementations will NOT need to override this method.

virtual bool16 CScriptManager::AppendTypeDefAsString (const ObjectScriptElement * pObjSI,
const RequestContext & context,
const TypeInfo & ti,
int32 includeInfo,
PMString & typeString 
) const
protectedvirtual

Appends typedef as a string. Some client-specific implementations may want to override this method.

virtual int32 CScriptManager::GetBaseIndex () const
virtual
Returns
the base for an object's index. Some client-specific implementations may want to override this method.

Implements IScriptManager.

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

Returns the policy for returning errors during a request. Most client-specific implementations will NOT need to override this method.

Implements IScriptManager.

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

Access to policies for formatting the name of script elements. Some client-specific implementations may want to override this method.

Implements IScriptManager.

virtual ScriptID CScriptManager::GetLanguageEnumerator () const
virtual
Returns
this client's enumerator for the kScriptLanguageEnumScriptElement. Scripting language client implementations MUST override this method.

Implements IScriptManager.

virtual ScriptVersion CScriptManager::GetMaximumDOMVersion (const PMLocaleId & locale) const
virtual
Returns
this client's maximum script DOM version (the last DOM version supported by this client for the given product/feature set/locale). Most client-specific implementations will NOT need to override this method.

Implements IScriptManager.

virtual ScriptVersion CScriptManager::GetMinimumDOMVersion (const PMLocaleId & locale) const
virtual
Returns
this client's minimum script DOM version (the first DOM version supported by this client for the given product/feature set/locale). Most client-specific implementations WILL need to override this method.

Implements IScriptManager.

virtual PMString CScriptManager::GetName () const
virtual
Returns
this client's name. Scripting language client implementations MUST override this method.

Implements IScriptManager.

virtual uint32 CScriptManager::GetNumEngines () const
virtual

Get the number of engines for this client

Implements IScriptManager.

virtual SetPropertiesOrderPolicy CScriptManager::GetSetPropertiesOrderPolicy () const
virtual

Returns the policy for the order to set properties when setting multiple properties at once. Most client-specific implementations will NOT need to override this method.

Implements IScriptManager.

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

Convert a script info type into a string representation. Most client-specific implementations will NOT need to override this method.

Implements IScriptManager.

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

Convert a script info type into a string representation. Most client-specific implementations will NOT need to override this method.

Implements IScriptManager.

virtual ErrorCode CScriptManager::Install ()
virtual

Tells the script manager to install. Most client-specific implementations WILL want to override this method.

Implements IScriptManager.

virtual bool16 CScriptManager::IsScriptActive () const
virtual

Determine whether a script is running under this manager. Most client-specific implementations will NOT need to override this method.

Implements IScriptManager.

virtual ErrorCode CScriptManager::PublishDescription (const RequestContext & )
virtual

Publish any information about the object model. Some client-specific implementations may want to override this method.

Implements IScriptManager.

virtual IScriptEngine* CScriptManager::QueryDefaultEngine () const
virtual

Query the default engine for this client

Implements IScriptManager.

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

Query the nth engine for this client

Implements IScriptManager.

void CScriptManager::SetDefaultErrorPolicy (ErrorPolicy policy)
protected

Sets the default policy for returning errors

void CScriptManager::SetSetPropertiesOrderPolicy (SetPropertiesOrderPolicy policy)
protected

Sets the policy for the order to use when setting multiple properties

void CScriptManager::SetSpecificErrorPolicy (ScriptID requestID,
ErrorPolicy policy 
)
protected

Sets the policy for returning errors during a specific property or event

virtual ErrorCode CScriptManager::UnInstall ()
virtual

Tells the script manager to uninstall. Most client-specific implementations WILL want to override this method.

Implements IScriptManager.