QCAD Application Framework
CAD Application Development and Automation.
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Static Protected Attributes
RScriptHandler Class Reference
Core Module

Abstract base class for all script handlers. More...

#include <RScriptHandler.h>

Inheritance diagram for RScriptHandler:
RScriptHandlerEcma

List of all members.

Public Member Functions

virtual void abort ()=0
virtual void createActionApplicationLevel (const QString &scriptFile, RGuiAction *guiAction)=0
template<class T >
void createActionApplicationLevelT (const QString &scriptFile, RGuiAction *guiAction)
 Creates a new application level action by instantiating class T.
virtual void createActionDocumentLevel (const QString &scriptFile, RGuiAction *guiAction, RDocumentInterface *documentInterface=NULL)=0
 Creates a script based action for this script handler.
template<class T >
void createActionDocumentLevelT (const QString &scriptFile, RGuiAction *guiAction, RDocumentInterface *documentInterface)
 Creates a new document level action by instantiating class T and attaching the action to the document interface of the currently active document.
virtual RFileImporterAdapter * createFileImporter (const QString &className, RDocument &document)=0
 Creates a file importer from the given class name and for the given document.
virtual void doScript (const QString &scriptFile, const QStringList &arguments=QStringList())=0
 Runs the given script file.
virtual void eval (const QString &script, const QString &fileName=QString())=0
 Evaluates the given script code.
virtual QList< QString > getSupportedFileExtensions ()=0
virtual bool hasUncaughtExceptions ()=0
virtual void init (const QString &autostartFile=QString::null, const QStringList &arguments=QStringList())
 Looks up and initializes the autostart script(s) available for this script handler.
virtual bool isRunning ()=0
 RScriptHandler ()
virtual ~RScriptHandler ()

Static Public Member Functions

static void triggerActionApplicationLevel (const QString &scriptFile, RGuiAction *guiAction=NULL)
 Runs the given script file as application level action.

Static Protected Attributes

static QString autostartScriptName = "autostart"

Detailed Description

Abstract base class for all script handlers.

Constructor & Destructor Documentation

RScriptHandler::RScriptHandler ( )
inline
virtual RScriptHandler::~RScriptHandler ( )
inlinevirtual

Member Function Documentation

virtual void RScriptHandler::abort ( )
pure virtual

Implemented in RScriptHandlerEcma.

virtual void RScriptHandler::createActionApplicationLevel ( const QString &  scriptFile,
RGuiAction *  guiAction 
)
pure virtual

Implemented in RScriptHandlerEcma.

template<class T >
void RScriptHandler::createActionApplicationLevelT ( const QString &  scriptFile,
RGuiAction *  guiAction 
)
inline

Creates a new application level action by instantiating class T.

Application level actions typically do not effect any documents. Application level actions cannot be attached to a document interface or anywhere else, so the action is instantiated, beginEvent is called and then the action is terminated immediately (finishEvent is called).

virtual void RScriptHandler::createActionDocumentLevel ( const QString &  scriptFile,
RGuiAction *  guiAction,
RDocumentInterface *  documentInterface = NULL 
)
pure virtual

Creates a script based action for this script handler.

Implemented in RScriptHandlerEcma.

template<class T >
void RScriptHandler::createActionDocumentLevelT ( const QString &  scriptFile,
RGuiAction *  guiAction,
RDocumentInterface *  documentInterface 
)
inline

Creates a new document level action by instantiating class T and attaching the action to the document interface of the currently active document.

Document level actions typically effect only the current document. Document level actions stay active until they are explicitly finished.

virtual RFileImporterAdapter* RScriptHandler::createFileImporter ( const QString &  className,
RDocument &  document 
)
pure virtual

Creates a file importer from the given class name and for the given document.

Implemented in RScriptHandlerEcma.

virtual void RScriptHandler::doScript ( const QString &  scriptFile,
const QStringList &  arguments = QStringList() 
)
pure virtual

Runs the given script file.

Implemented in RScriptHandlerEcma.

virtual void RScriptHandler::eval ( const QString &  script,
const QString &  fileName = QString() 
)
pure virtual

Evaluates the given script code.

Implemented in RScriptHandlerEcma.

virtual QList<QString> RScriptHandler::getSupportedFileExtensions ( )
pure virtual
Returns:
The file extensions of script files that are supported by this script handler.

Implemented in RScriptHandlerEcma.

virtual bool RScriptHandler::hasUncaughtExceptions ( )
pure virtual

Implemented in RScriptHandlerEcma.

void RScriptHandler::init ( const QString &  autostartFile = QString::null,
const QStringList &  arguments = QStringList() 
)
virtual

Looks up and initializes the autostart script(s) available for this script handler.

This method calls initScript for all files with a supported file extension (see getSupportedFileExtensions).

virtual bool RScriptHandler::isRunning ( )
pure virtual
Returns:
true if the script handle currently is running a script, false otherwise.

Implemented in RScriptHandlerEcma.

void RScriptHandler::triggerActionApplicationLevel ( const QString &  scriptFile,
RGuiAction *  guiAction = NULL 
)
static

Runs the given script file as application level action.

Member Data Documentation

QString RScriptHandler::autostartScriptName = "autostart"
staticprotected
The documentation for this class was generated from the following files: