IScriptCollection Class Reference

This abstract class provides methods for the script manipulations. More...

#include <IScriptCollection.h>

Inherits QObject.

Inherited by ScriptCollection.

Public Types
typedef QList< IScriptUnit * >	Scripts

Public Slots
virtual IScriptUnit *	create ()=0
virtual Scripts	createFromDirectory (const QString &directory)=0
virtual IScriptUnit *	createFromFile (const QString &fileName)=0
virtual void	remove (IScriptUnit *script)=0
virtual IScriptUnit *	scriptByFileName (const QString &fileName)=0

Signals
void	scriptAdded (IScriptUnit *script)
void	scriptRemoved (IScriptUnit *script)

Public Member Functions
	IScriptCollection ()
virtual Scripts	scripts () const =0
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
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

Properties
QList< IScriptUnit * >	scripts
Properties inherited from QObject
	objectName

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)

Detailed Description

This abstract class provides methods for the script manipulations.

Usig this interface you can add scripts from files or even directories. All scripts that are loaded into application should be loaded using this interface.

You can get reference to the IScriptCollection using IScriptingService::scripts().

See Also

ScriptConsoleView

Member Typedef Documentation

typedef QList<IScriptUnit *> IScriptCollection::Scripts

A script unit collection.

Constructor & Destructor Documentation

IScriptCollection::IScriptCollection ( )

inline

Initializes a new instance of the IScriptCollection class.

Member Function Documentation

virtual Scripts IScriptCollection::scripts ( ) const

pure virtual

Gets all loaded scripts.

Implemented in ScriptCollection.

virtual IScriptUnit* IScriptCollection::create ( )

pure virtualslot

Creates a new script unit and adds it to the collection. Note, that it takes ownership for the created script.

See Also

scriptAdded

virtual IScriptUnit* IScriptCollection::createFromFile ( const QString &  fileName )

pure virtualslot

Tries to read script from the file and create a script unit, based on that script. Note, that it takes ownership for the created script.

See Also

scriptAdded

virtual void IScriptCollection::remove ( IScriptUnit *  script )

pure virtualslot

Removes and deallocates a script from the collection;

See Also

scriptRemoved

virtual Scripts IScriptCollection::createFromDirectory ( const QString &  directory )

pure virtualslot

Tries to read all script files, ended with .js from the directory and create script units, based on that scripts. Note, that it takes ownership for the created scripts.

See Also

scriptAdded

virtual IScriptUnit* IScriptCollection::scriptByFileName ( const QString &  fileName )

pure virtualslot

Gets script by its file name (if any);

void IScriptCollection::scriptAdded ( IScriptUnit *  script )

signal

This signal is emitted when a script is added to the collection.

See Also

createFromDirectory, createFromFile, create

void IScriptCollection::scriptRemoved ( IScriptUnit *  script )

signal

This signal is emitted when a script is removed from the collection.

See Also

remove