Script Class Reference

#include <script.h>

Inheritance diagram for Script:

Public Member Functions
	Script (QString file)
	~Script ()
void	activate ()
void	addObject (QString name, QObject *object)
void	addObjects (QMap< QString, QObject * > objects)
void	deactivate ()
QString	errorMessage ()
bool	exists ()
QString	fileName ()
bool	isActivated ()
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

This class represents the activated script and is used by the ScriptManager to activate/deactivate scripts.

Author

Avgoustinos Kadis avgou.nosp@m.stin.nosp@m.os.ka.nosp@m.dis@.nosp@m.kdema.nosp@m.il.n.nosp@m.et

Definition at line 31 of file script.h.

Constructor & Destructor Documentation

Script::Script

(

QString

file

)

Script class constructor.

Parameters

file	The path to the script file to be activated (executed)

Definition at line 23 of file script.cpp.

Script::~Script

(

)

Definition at line 30 of file script.cpp.

Member Function Documentation

void Script::activate

(

)

Activates the script.

Definition at line 42 of file script.cpp.

void Script::addObject	(	QString	name,
		QObject *	object
	)

Add an object to be accessible by the script.

Parameters

name	Name to appear in the script
object	Object to be accessible by the script

Definition at line 110 of file script.cpp.

void Script::addObjects

(

QMap< QString, QObject * >

objects

)

Adds more than one scripting Objects to the script.

Parameters

objects

Map of the objects to add

Definition at line 116 of file script.cpp.

void Script::deactivate

(

)

Deactivate the script.

Definition at line 90 of file script.cpp.

QString Script::errorMessage

(

)

Returns an html error message if there have been errors in the script.

Definition at line 121 of file script.cpp.

bool Script::exists

(

)

Checks if the script file assigned to the Script object exists as a file on the given path.

Returns

True if the script file exists False if it does not exist

Definition at line 97 of file script.cpp.

QString Script::fileName

(

)

Returns the file that was given as parameter to the constructor.

Definition at line 104 of file script.cpp.

bool Script::isActivated

(

)

Returns true if the script was successfully activated; false otherwise.

Definition at line 36 of file script.cpp.

---

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

• script.h
• script.cpp