ScriptInterface Class Reference

#include <ScriptInterface.hh>

List of all members.

Signals
virtual void	scriptInfo (QString)
	Emit this signal if a scriptable function is executed.
virtual void	executeScript (QString)
virtual void	getScriptingEngine (QScriptEngine *&)
virtual void	getAvailableFunctions (QStringList &)
virtual void	getDescription (QString, QString &, QStringList &, QStringList &)
Public Member Functions
virtual	~ScriptInterface ()
	Destructor.
Private Slots
virtual void	slotScriptInfo (QString, QString)
virtual void	slotExecuteScript (QString)
virtual void	slotExecuteFileScript (QString)

---

Detailed Description

Interface for all Plugins which provide scriptable Functions. These Functions should follow some guidelines :

1. Todo

Definition at line 64 of file ScriptInterface.hh.

---

Member Function Documentation

virtual void ScriptInterface::executeScript

(

QString

)

[inline, virtual, signal]

Emit this signal to execute a script

Parameters:

_script

The script to execute

Definition at line 83 of file ScriptInterface.hh.

virtual void ScriptInterface::getAvailableFunctions

(

QStringList &

)

[inline, virtual, signal]

With this signal you can get a list of all available scripting functions

Parameters:

_functions

All available functions

Definition at line 93 of file ScriptInterface.hh.

virtual void ScriptInterface::getDescription	(	QString	,
		QString &	,
		QStringList &	,
		QStringList &
	)			[inline, virtual, signal]

With this signal you can get descriptions about a given function if available

Parameters:

	_function	name of the function (e.g. plugin.function)
	_description	a description for the function
	_parameters	list of names for the parameters
	_descriptions	list of descriptions for the parameters (_descriptions[i] corresponds to _parameters[i])

Definition at line 102 of file ScriptInterface.hh.

virtual void ScriptInterface::getScriptingEngine

(

QScriptEngine *&

)

[inline, virtual, signal]

Emit this signal to get the core scripting engine

Parameters:

_engine

The scripting Engine

Definition at line 88 of file ScriptInterface.hh.

virtual void ScriptInterface::scriptInfo

(

QString

)

[inline, virtual, signal]

Emit this signal if a scriptable function is executed.

e.g. selectAllVertices( ObjectId )

Parameters:

_functionName

the called function

Definition at line 78 of file ScriptInterface.hh.

virtual void ScriptInterface::slotExecuteFileScript

(

QString

)

[inline, private, virtual, slot]

Call this slot to open the given file and execute the script in it

Definition at line 124 of file ScriptInterface.hh.

virtual void ScriptInterface::slotExecuteScript

(

QString

)

[inline, private, virtual, slot]

Slot for a scripting plugin. Gets the Script and executes it.

Parameters:

_script

Script to execute

Definition at line 119 of file ScriptInterface.hh.

virtual void ScriptInterface::slotScriptInfo	(	QString	,
		QString
	)			[inline, private, virtual, slot]

Slot for a scripting plugin. Gets the Script and executes it.

Parameters:

	_pluginName	Name of the plugin that executed a scriptable function
	_functionName	Name of the executed function

Definition at line 112 of file ScriptInterface.hh.

---

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

• BasePlugin/ScriptInterface.hh