IScriptRunner Class Reference

#include <IScriptRunner.h>

Inheritance diagram for IScriptRunner:

Public Types
enum	{ kDefaultIID = IID_ISCRIPTRUNNER }

Public Member Functions
virtual bool16	CanHandleFile (const IDFile &idFile) const =0
virtual ErrorCode	RunFile (const IDFile &idFile, const RunScriptParams &params)=0
virtual ErrorCode	RunScript (const PMString &scriptText, const RunScriptParams &params)=0
virtual ErrorCode	InvokeFunction (const IScriptCoreFunctor *scriptFunction, const RunScriptParams &params)=0
virtual ErrorCode	EditFile (const IDFile &idFile) const =0
virtual ErrorCode	ShowFile (const IDFile &idFile) const =0
virtual bool16	ScriptHasDescription (const IDFile &idFile) const =0
virtual PMString	GetScriptDescription (const IDFile &idFile) const =0
virtual PMRsrcID	GetFileIcon (const IDFile &idFile) const =0
virtual bool16	CheckForUserCancel () const =0
virtual ErrorCode	CancelScriptExecution () const =0
virtual ErrorCode	HandleIdleTasks () const =0
virtual ErrorCode	ProcessScheduledCmds () const =0
virtual bool16	IsScriptRunning () const =0
virtual ErrorCode	GetRunningScriptFile (IDFile &idFile) const =0
virtual ErrorCode	DisplayErrorMessage (ErrorCode errorNumber, const PMString &errorString, int32 lineNumber, const PMString &sourceCode, const PMString &offendingText, const IDFile &scriptFile) 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

The Scripts panel and any other client that wants to execute a script uses this interface. Implemented by each scripting language supported by InDesign.

Member Function Documentation

virtual ErrorCode IScriptRunner::CancelScriptExecution ( ) const

pure virtual

Cancel the execution of the currently running script

Implemented in CScriptRunner.

virtual bool16 IScriptRunner::CanHandleFile ( const IDFile &  idFile ) const

pure virtual

Return kTrue if this runner can execute this file

Parameters

idFile

the script file to check

Implemented in CScriptRunner.

virtual bool16 IScriptRunner::CheckForUserCancel ( ) const

pure virtual

Returns

kTrue if user is trying to cancel script execution

Implemented in CScriptRunner.

virtual ErrorCode IScriptRunner::DisplayErrorMessage ( ErrorCode  errorNumber, const PMString &  errorString, int32  lineNumber, const PMString &  sourceCode, const PMString &  offendingText, const IDFile &  scriptFile  ) const

pure virtual

Display a script error alert

Parameters

errorNumber	- the error number (must != kSuccess)
errorString	- a description of the error (must != "")
lineNumber	- 1-based index of the line of the script on which the error occurred (ignored if == 0)
sourceCode	- the line of the script that contains the error (ignored if == "")
offendingText	- the code snippet that caused the error (ignored if == "")
scriptFile	- the script file that contains the error (ignored if empty)

Returns

kSuccess

Implemented in CScriptRunner.

virtual ErrorCode IScriptRunner::EditFile ( const IDFile &  idFile ) const

pure virtual

Edit a script file.

Parameters

idFile

the script file to edit

Implemented in CScriptRunner.

virtual PMRsrcID IScriptRunner::GetFileIcon ( const IDFile &  idFile ) const

pure virtual

Returns

a file icon for a script.

Parameters

idFile

the script file to get an icon for

Implemented in CScriptRunner.

virtual ErrorCode IScriptRunner::GetRunningScriptFile ( IDFile &  idFile ) const

pure virtual

Get the currently running script.

Parameters

idFile

the script file that is currently running

Implemented in CScriptRunner.

virtual PMString IScriptRunner::GetScriptDescription ( const IDFile &  idFile ) const

pure virtual

Get a script's description.

Parameters

idFile

the script file from which to get a description

Implemented in CScriptRunner.

virtual ErrorCode IScriptRunner::HandleIdleTasks ( ) const

pure virtual

Handle any periodic tasks requested by the system

Implemented in CScriptRunner.

virtual ErrorCode IScriptRunner::InvokeFunction ( const IScriptCoreFunctor *  scriptFunction, const RunScriptParams &  params  )

pure virtual

Invoke a function.

Parameters

scriptFunction	is the function IN
params	contains settings and data for script execution IN/OUT

Returns

is kSuccess or an error code

Implemented in CScriptRunner.

virtual bool16 IScriptRunner::IsScriptRunning ( ) const

pure virtual

Returns

kTrue if a script is currently running

Implemented in CScriptRunner.

virtual ErrorCode IScriptRunner::ProcessScheduledCmds ( ) const

pure virtual

Process any commands that were scheduled during a script request

Implemented in CScriptRunner.

virtual ErrorCode IScriptRunner::RunFile ( const IDFile &  idFile, const RunScriptParams &  params  )

pure virtual

Execute a script file. Should only be called if CanHandleFile returns kTrue.

Parameters

idFile	the script file to execute IN
params	contains settings and data for script execution IN/OUT

Returns

is kSuccess or an error code

Implemented in CScriptRunner.

virtual ErrorCode IScriptRunner::RunScript ( const PMString &  scriptText, const RunScriptParams &  params  )

pure virtual

Execute a script given the text of the script.

Parameters

scriptText	the script text to execute IN
params	contains settings and data for script execution IN/OUT

Returns

is kSuccess or an error code

Implemented in CScriptRunner.

virtual bool16 IScriptRunner::ScriptHasDescription ( const IDFile &  idFile ) const

pure virtual

Return kTrue if a script has a description.

Parameters

idFile

the script file to check for a description

Implemented in CScriptRunner.

virtual ErrorCode IScriptRunner::ShowFile ( const IDFile &  idFile ) const

pure virtual

Show a script file in the Mac Finder/Windows shell

Parameters

idFile

the script file to show

Implemented in CScriptRunner.