QtScriptBackend Class Reference

#include <QtScriptBackend.h>

Inheritance diagram for QtScriptBackend:

Public Slots
void	continueExecutionStep ()
QString	execute ()
void	executeStep ()
void	stop ()

Signals
void	engineCreated (QScriptEngine *e)
void	finished ()
void	scriptError (const QString &message)
void	scriptInfo (const QString &message)
void	sendDebug (const QString &message)
void	sendOutput (const QString &message)

Public Member Functions
	QtScriptBackend (QObject *parent)
	~QtScriptBackend ()
void	debug (const QString &message)
QScriptEngine *	engine () const
void	include (const QString &filePath)
IncludeManager &	includeManager () const
void	interrupt ()
bool	isRunning () const
void	loadFile (const QString &file)
void	output (const QString &message)
QScriptValue	registerGlobalObject (QObject *qobject, const QString &name)
void	setScript (const QString &script, Document *document)

Detailed Description

This class provides the script backend for script executions.

Usually, one script backend is associated with one document.

Definition at line 40 of file QtScriptBackend.h.

Constructor & Destructor Documentation

QtScriptBackend::QtScriptBackend ( QObject *  parent )

explicit

Default constructor.

Definition at line 94 of file QtScriptBackend.cpp.

QtScriptBackend::~QtScriptBackend

(

)

Default destructor.

Definition at line 100 of file QtScriptBackend.cpp.

Member Function Documentation

void QtScriptBackend::continueExecutionStep ( )

slot

Continue execution of interrupted script.

Definition at line 276 of file QtScriptBackend.cpp.

void QtScriptBackend::debug

(

const QString &

message

)

Output the given string message as debug output.

Parameters

message

the string to be print

Deprecated:

Definition at line 263 of file QtScriptBackend.cpp.

QScriptEngine * QtScriptBackend::engine

(

)

const

Returns

script engine

Definition at line 104 of file QtScriptBackend.cpp.

void QtScriptBackend::engineCreated ( QScriptEngine *  e )

signal

QString QtScriptBackend::execute ( )

slot

Execute the currently set script.

This method also sets and afterwards pops the execution context. Emits SIGNAL finished() when execution is finished.

Returns

result from script engine

TODO: Make that changeable.

Definition at line 164 of file QtScriptBackend.cpp.

void QtScriptBackend::executeStep ( )

slot

Execute the preset script up to a call of.

See also

interrupt(). This method also sets the execution context. Use

continueExecutionStep() to continue after interrupting.

Definition at line 205 of file QtScriptBackend.cpp.

void QtScriptBackend::finished ( )

signal

void QtScriptBackend::include

(

const QString &

filePath

)

Include script from other script file.

Definition at line 283 of file QtScriptBackend.cpp.

IncludeManager & QtScriptBackend::includeManager

(

)

const

Returns

reference to the include manager dialog

Definition at line 137 of file QtScriptBackend.cpp.

void QtScriptBackend::interrupt

(

)

Interrupt script execution.

This method should be used from the scrpting interface.

Definition at line 304 of file QtScriptBackend.cpp.

bool QtScriptBackend::isRunning

(

)

const

Return true if engine is currently evaluating a script, otherwise false.

Definition at line 249 of file QtScriptBackend.cpp.

void QtScriptBackend::loadFile

(

const QString &

file

)

See also

QtScriptEngine::loadFile().

Definition at line 109 of file QtScriptBackend.cpp.

void QtScriptBackend::output

(

const QString &

message

)

Output the given string message as program output.

Parameters

message

the string to be print

Deprecated:

Definition at line 269 of file QtScriptBackend.cpp.

QScriptValue QtScriptBackend::registerGlobalObject	(	QObject *	qobject,
		const QString &	name
	)

Register qobject as global object under name name at engine for next simulation run.

Definition at line 125 of file QtScriptBackend.cpp.

void QtScriptBackend::scriptError ( const QString &  message )

signal

void QtScriptBackend::scriptInfo ( const QString &  message )

signal

void QtScriptBackend::sendDebug ( const QString &  message )

signal

void QtScriptBackend::sendOutput ( const QString &  message )

signal

void QtScriptBackend::setScript	(	const QString &	script,
		Document *	document
	)

Set the script script and the corresponding document document to be executed on next run.

Definition at line 257 of file QtScriptBackend.cpp.

void QtScriptBackend::stop ( )

slot

Abort script evaluation.

Definition at line 142 of file QtScriptBackend.cpp.

---

The documentation for this class was generated from the following files:

• QtScriptBackend.h
• QtScriptBackend.cpp