Kross

View on LXR

Kross
Manager

#include <manager.h>

Inheritance diagram for Kross::Manager:

Signals
void	finished (Kross::Action *)

void	started (Kross::Action *)

Public Slots
QObject *	action (const QString &name)

void	addQObject (QObject *obj, const QString &name=QString())

void	deleteModules ()

bool	executeScriptFile (const QUrl &file=QUrl())

bool	hasAction (const QString &name)

QStringList	interpreters () const

QObject *	module (const QString &modulename)

QObject *	qobject (const QString &name) const

QStringList	qobjectNames () const

Public Member Functions
	Manager ()

virtual	~Manager ()

ActionCollection *	actionCollection () const

bool	hasHandlerAssigned (const QByteArray &typeName) const

bool	hasInterpreterInfo (const QString &interpretername) const

Interpreter *	interpreter (const QString &interpretername) const

InterpreterInfo *	interpreterInfo (const QString &interpretername) const

QHash< QString, InterpreterInfo * >	interpreterInfos () const

const QString	interpreternameForFile (const QString &file)

MetaTypeHandler *	metaTypeHandler (const QByteArray &typeName) const

void	registerMetaTypeHandler (const QByteArray &typeName, MetaTypeHandler::FunctionPtr *handler)

void	registerMetaTypeHandler (const QByteArray &typeName, MetaTypeHandler::FunctionPtr2 *handler)

void	registerMetaTypeHandler (const QByteArray &typeName, MetaTypeHandler *handler)

void	setStrictTypesEnabled (bool enabled)

bool	strictTypesEnabled () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

bool	blockSignals (bool block)

const QObjectList &	children () const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const

bool	disconnect (const QObject receiver, const char method) const

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, QFlags< Qt::FindChildOption > options) const

QList< T >	findChildren (const QString &name, QFlags< Qt::FindChildOption > options) const

QList< T >	findChildren (const QRegExp &regExp, QFlags< Qt::FindChildOption > options) const

QList< T >	findChildren (const QRegularExpression &re, QFlags< Qt::FindChildOption > options) const

bool	inherits (const char *className) const

void	installEventFilter (QObject *filterObj)

bool	isWidgetType () const

bool	isWindowType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

QString	objectName () const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const

QVariant	property (const char *name) const

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval, Qt::TimerType timerType)

QThread *	thread () const

Public Member Functions inherited from Kross::ChildrenInterface
void	addObject (QObject *object, const QString &name=QString(), Options options=NoOption)

bool	hasObject (const QString &name) const

QObject *	object (const QString &name) const

Options	objectOption (const QString &name) const

QHash< QString, Options >	objectOptions () const

QHash< QString, QObject * >	objects () const

Static Public Member Functions
static Manager &	self ()

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction 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)

Additional Inherited Members
Public Types inherited from Kross::ChildrenInterface
enum	Options { NoOption = 0x00, AutoConnectSignals = 0x01, LastOption = 0x1000000 }

Properties inherited from QObject
	objectName

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Detailed Description

The Manager class is a singleton that provides the main entry point to deal with the Kross Scripting Framework.

Use Interpreter to just work with some implementated interpreter like python or ruby. While Action implements a flexible abstract container to deal with single script files.

Definition at line 50 of file manager.h.

Constructor & Destructor Documentation

Manager::Manager ( )

explicit

The constructor.

Use self() to access the Manager singleton instance and don't call this direct.

Definition at line 126 of file manager.cpp.

Manager::~Manager ( )

virtual

Destructor.

Definition at line 225 of file manager.cpp.

Member Function Documentation

QObject * Manager::action ( const QString & name )

slot

Returns: the Action QObject instance defined with name which is child of this Manager instance. If there exists no such Action yet, create one.

Definition at line 291 of file manager.cpp.

ActionCollection * Manager::actionCollection ( ) const

Returns: the root ActionCollection instance. Each collection could have children of other collections and/or Action instances.

Definition at line 281 of file manager.cpp.

void Manager::deleteModules ( )

slot

External modules are dynamically loadable and are normally deleted when the kross library is unloaded.

Applications may choose to call deleteModules() instead to control deletion of the modules at another time.

Definition at line 333 of file manager.cpp.

bool Manager::executeScriptFile ( const QUrl & file = QUrl() )

slot

Execute a script file.

Parameters

file	The script file that should be executed.

Definition at line 339 of file manager.cpp.

void Kross::Manager::finished ( Kross::Action * )

signal

This signal is emitted when the execution of a script is finished.

bool Manager::hasAction ( const QString & name )

slot

Returns: true if there exists a Action QObject instance which is child of this Manager instance and is defined as name else false is returned.

Definition at line 286 of file manager.cpp.

bool Manager::hasHandlerAssigned ( const QByteArray & typeName ) const

Returns: whether typeName has a handler assigned or not.

Definition at line 394 of file manager.cpp.

bool Manager::hasInterpreterInfo ( const QString & interpretername ) const

Returns: true if there exists an interpreter with the name interpretername else false.

Definition at line 239 of file manager.cpp.

Interpreter * Manager::interpreter ( const QString & interpretername ) const

Return the Interpreter instance defined by the interpretername.

Parameters

interpretername The name of the interpreter. e.g. "python" or "ruby".

Returns: The Interpreter instance or NULL if there does not exists an interpreter with such an interpretername.

Definition at line 267 of file manager.cpp.

InterpreterInfo * Manager::interpreterInfo ( const QString & interpretername ) const

Returns: the InterpreterInfo* matching to the defined interpretername or NULL if there does not exists such a interpreter.

Definition at line 244 of file manager.cpp.

QHash< QString, InterpreterInfo * > Manager::interpreterInfos ( ) const

Returns: a map with InterpreterInfo* instances used to describe interpreters.

Definition at line 234 of file manager.cpp.

const QString Manager::interpreternameForFile ( const QString & file )

Return the name of the Interpreter that feels responsible for the defined file .

Parameters

file	The filename we should try to determinate the interpretername for.

Returns: The name of the Interpreter which will be used to execute the file or QString() if we failed to determinate a matching interpreter for the file.

Definition at line 249 of file manager.cpp.

QStringList Manager::interpreters ( ) const

slot

Returns: a list of names of all supported scripting interpreters. The list may contain for example "python" and "ruby" depending on what interpreter-plugins are installed.

Definition at line 276 of file manager.cpp.

MetaTypeHandler * Manager::metaTypeHandler ( const QByteArray & typeName ) const

Returns: the MetaTypeHandler instance for custom types of type typeName .

Since: 4.2

Definition at line 364 of file manager.cpp.

QObject * Manager::module ( const QString & modulename )

slot

Load and return an external module.

Modules are dynamic loadable plugins which could be loaded on demand to provide additional functionality.

Parameters

modulename The name of the module we should try to load.

Returns: The QObject instance that repesents the module or NULL if loading failed.

Definition at line 303 of file manager.cpp.

void Manager::registerMetaTypeHandler	(	const QByteArray &	typeName,
		MetaTypeHandler::FunctionPtr *	handler
	)

Quick Links

Class Picker

About

Signals

Public Slots

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

typeName	The custom type the handler should handle.
handler	Function that should be called to handle a custom type.