Kross::Manager
#include <manager.h>

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 |
![]() | |
QObject (QObject *parent) | |
bool | blockSignals (bool block) |
const QObjectList & | children () const const |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const |
void | deleteLater () |
void | destroyed (QObject *obj) |
bool | disconnect (const char *signal, const QObject *receiver, const char *method) const const |
bool | disconnect (const QObject *receiver, const char *method) const const |
void | dumpObjectInfo () |
void | dumpObjectInfo () const const |
void | dumpObjectTree () |
void | dumpObjectTree () const const |
QList< QByteArray > | dynamicPropertyNames () const const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegExp ®Exp, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const |
bool | inherits (const char *className) const const |
void | installEventFilter (QObject *filterObj) |
bool | isWidgetType () const const |
bool | isWindowType () const const |
void | killTimer (int id) |
virtual const QMetaObject * | metaObject () const const |
void | moveToThread (QThread *targetThread) |
QString | objectName () const const |
void | objectNameChanged (const QString &objectName) |
QObject * | parent () const const |
QVariant | property (const char *name) const const |
Q_CLASSINFO (Name, Value) | |
Q_DISABLE_COPY (Class) | |
Q_DISABLE_COPY_MOVE (Class) | |
Q_DISABLE_MOVE (Class) | |
Q_EMIT Q_EMIT | |
Q_ENUM (...) | |
Q_ENUM_NS (...) | |
Q_ENUMS (...) | |
Q_FLAG (...) | |
Q_FLAG_NS (...) | |
Q_FLAGS (...) | |
Q_GADGET Q_GADGET | |
Q_INTERFACES (...) | |
Q_INVOKABLE Q_INVOKABLE | |
Q_NAMESPACE Q_NAMESPACE | |
Q_NAMESPACE_EXPORT (EXPORT_MACRO) | |
Q_OBJECT Q_OBJECT | |
Q_PROPERTY (...) | |
Q_REVISION Q_REVISION | |
Q_SET_OBJECT_NAME (Object) | |
Q_SIGNAL Q_SIGNAL | |
Q_SIGNALS Q_SIGNALS | |
Q_SLOT Q_SLOT | |
Q_SLOTS Q_SLOTS | |
T | qFindChild (const QObject *obj, const QString &name) |
QList< T > | qFindChildren (const QObject *obj, const QRegExp ®Exp) |
QList< T > | qFindChildren (const QObject *obj, const QString &name) |
T | qobject_cast (QObject *object) |
T | qobject_cast (const QObject *object) |
QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT | |
void | removeEventFilter (QObject *obj) |
void | setObjectName (const QString &name) |
void | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | signalsBlocked () const const |
int | startTimer (int interval, Qt::TimerType timerType) |
int | startTimer (std::chrono::milliseconds time, Qt::TimerType timerType) |
QThread * | thread () const const |
![]() | |
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 () |
![]() | |
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 | |
![]() | |
enum | Options { NoOption = 0x00, AutoConnectSignals = 0x01, LastOption = 0x1000000 } |
![]() | |
objectName | |
![]() | |
typedef | QObjectList |
![]() | |
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 const |
int | receivers (const char *signal) const const |
QObject * | sender () const const |
int | senderSignalIndex () const 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.
Constructor & Destructor Documentation
|
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.
|
virtual |
Destructor.
Definition at line 225 of file manager.cpp.
Member Function Documentation
ActionCollection * Manager::actionCollection | ( | ) | const |
- Returns
- the root ActionCollection instance. Each collection could have children of other collections and/or Action instances.
Definition at line 285 of file manager.cpp.
|
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 337 of file manager.cpp.
Execute a script file.
- Parameters
-
file The script file that should be executed.
Definition at line 343 of file manager.cpp.
|
signal |
This signal is emitted when the execution of a script is finished.
|
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 290 of file manager.cpp.
bool Manager::hasHandlerAssigned | ( | const QByteArray & | typeName | ) | const |
- Returns
- whether
typeName
has a handler assigned or not.
Definition at line 398 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 271 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.
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.
|
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 280 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 368 of file manager.cpp.
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 307 of file manager.cpp.
void Manager::registerMetaTypeHandler | ( | const QByteArray & | typeName, |
MetaTypeHandler::FunctionPtr * | handler | ||
) |
Register a handler for custom types.
See also the WrapperInterface class.
- Parameters
-
typeName The custom type the handler should handle. handler Function that should be called to handle a custom type.
- Since
- 4.2
Definition at line 373 of file manager.cpp.
void Manager::registerMetaTypeHandler | ( | const QByteArray & | typeName, |
MetaTypeHandler::FunctionPtr2 * | handler | ||
) |
Register a handler for custom types.
See also the WrapperInterface class.
- Parameters
-
typeName The custom type the handler should handle. handler Function that should be called to handle a custom type.
- Since
- 4.2
Definition at line 378 of file manager.cpp.
void Manager::registerMetaTypeHandler | ( | const QByteArray & | typeName, |
MetaTypeHandler * | handler | ||
) |
Register a handler for custom types.
See also the WrapperInterface class.
- Parameters
-
typeName The custom type the handler should handle. handler Function that should be called to handle a custom type.
- Since
- 4.2
Definition at line 383 of file manager.cpp.
|
static |
Return the Manager instance.
Always use this function to access the Manager singleton.
Definition at line 74 of file manager.cpp.
void Manager::setStrictTypesEnabled | ( | bool | enabled | ) |
Enable more strict type handling.
If enabled then scripting-backends don't handle unknown pointer-types where no MetaTypeHandler was registered for. If disabled, such unknown types will be reinterpret_cast to QObject* what allows to also handle unknown QObject's but will also result in a crash if the unknown type isn't a QObject. Per default strict type handling is enabled.
- Since
- 4.2
Definition at line 393 of file manager.cpp.
|
signal |
This signal is emitted when the execution of a script is started.
bool Manager::strictTypesEnabled | ( | ) | const |
Returns true if strict type handling is enabled.
- Since
- 4.2
Definition at line 388 of file manager.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2021 The KDE developers.
Generated on Wed Jan 20 2021 23:03:20 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.