Plasma::ScriptEngine Class Reference

#include <Plasma/Scripting/ScriptEngine>

Inheritance diagram for Plasma::ScriptEngine:

Public Member Functions
	~ScriptEngine ()
virtual bool	init ()
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

Protected Member Functions
	ScriptEngine (QObject *parent=0)
virtual QString	mainScript () const
virtual const Package *	package () const
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)

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)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

The base class for scripting interfaces to be used in loading plasmoids of a given language.

All ScriptEngines should export as consistent an interface as possible so that the learning curve is limited. In particular, the following API should be made available in the script environment:

TODO: define the actual scripting APIas ... PlasmaApplet - the applet of this plasmoid LoadUserInterface(String uiFile) - loads and returns a given UI file LoadImage - loads an image resource out of the plasmoid's package PlasmaSvg - creates and returns an Svg file

Definition at line 65 of file scriptengine.h.

Constructor & Destructor Documentation

Plasma::ScriptEngine::~ScriptEngine

(

)

Definition at line 47 of file scriptengine.cpp.

Plasma::ScriptEngine::ScriptEngine ( QObject *  parent = 0 )

explicitprotected

Definition at line 41 of file scriptengine.cpp.

Member Function Documentation

bool Plasma::ScriptEngine::init ( )

virtual

Called when it is safe to initialize the internal state of the engine.

Definition at line 52 of file scriptengine.cpp.

QString Plasma::ScriptEngine::mainScript ( ) const

protectedvirtual

Returns

absolute path to the main script file for this plasmoid

Reimplemented in Plasma::AppletScript, Plasma::WallpaperScript, Plasma::DataEngineScript, and Plasma::RunnerScript.

Definition at line 62 of file scriptengine.cpp.

const Package * Plasma::ScriptEngine::package ( ) const

protectedvirtual

Returns

the Package associated with this plasmoid which can be used to request resources, such as images and interface files.

Reimplemented in Plasma::AppletScript, Plasma::WallpaperScript, Plasma::DataEngineScript, and Plasma::RunnerScript.

Definition at line 57 of file scriptengine.cpp.

---

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

• scriptengine.h
• scriptengine.cpp