InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IScriptVersionInfo Class Referenceabstract
Inheritance diagram for IScriptVersionInfo:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ISCRIPTVERSIONINFO }
 

Public Member Functions

virtual const ScriptVersionGetCurrentScriptDOMVersion () const =0
 
virtual ScriptVersionList GetKnownScriptDOMVersions (const ScriptClient &client=kInvalidClass) const =0
 
virtual const ScriptVersionGetApplicableDOMVersion (const RequestContext &context) const =0
 
virtual PMString GetApplicableUIVersion (const RequestContext &context) const =0
 
virtual void GetApplicableGUIDs (const RequestContext &context, GUID *appGUID, GUID *singleUserTypeLibGUID=nil, GUID *multiUserTypeLibGUID=nil) const =0
 
virtual IDFile GetApplicableDescriptionFolder (const RequestContext &context, bool16 createFolder=kFalse) const =0
 
virtual const ScriptVersionGetMinimumINXImportDOMVersion (const RequestContext &context) const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Function Documentation

virtual IDFile IScriptVersionInfo::GetApplicableDescriptionFolder (const RequestContextcontext,
bool16 createFolder = kFalse 
) const
pure virtual

Get the folder where a client should publish its description (e.g., AppleScript Dictionary, Visual Basic TypeLibrary)

Parameters
contextspecifies the version of the DOM to be published
createFolderindicates whether this call should create the folder if it doesn't already exist
virtual const ScriptVersion& IScriptVersionInfo::GetApplicableDOMVersion (const RequestContextcontext) const
pure virtual

Get the version of the scripting DOM actually used to handle a particular request. For example, suppose a request specifies version 3.5 of the DOM, but the only known valid DOM versions are 3.0 and 4.0; 3.0 would be returned.

Parameters
contextspecifies the context of the request
virtual void IScriptVersionInfo::GetApplicableGUIDs (const RequestContextcontext,
GUID * appGUID,
GUID * singleUserTypeLibGUID = nil,
GUID * multiUserTypeLibGUID = nil 
) const
pure virtual

Get the GUIDs associated with a version of the scripting DOM

Parameters
contextspecifies the version of the DOM
appGUIDif non-nil, returns the GUID of the application
singleUserTypeLibGUIDif non-nil, returns the GUID of the single-user type library
multiUserTypeLibGUIDif non-nil, returns the GUID of the multi-user type library
virtual PMString IScriptVersionInfo::GetApplicableUIVersion (const RequestContextcontext) const
pure virtual

Get the UI string associated with a version of the scripting DOM

Parameters
contextspecifies the version of the DOM
virtual const ScriptVersion& IScriptVersionInfo::GetCurrentScriptDOMVersion () const
pure virtual

Return the version number of the scripting document object model (DOM) corresponding to the current version of the application.

virtual ScriptVersionList IScriptVersionInfo::GetKnownScriptDOMVersions (const ScriptClientclient = kInvalidClass) const
pure virtual

Return a list of known scripting DOM versions.

Parameters
clientindicates the list should be confined to a specific client
virtual const ScriptVersion& IScriptVersionInfo::GetMinimumINXImportDOMVersion (const RequestContextcontext) const
pure virtual

Get the lowest DOM Version that can read files written by a given DOM Version

Parameters
theDOM version being used to generate INX
Returns
the lowest DOM version that can read the generated INX