GammaRay API Documentation
2.7.0
|
Tool Management API for the client to find out, which tools exist, get the tool's widgets, etc. More...
#include <clienttoolmanager.h>
Public Slots | |
void | clear () |
void | requestAvailableTools () |
Signals | |
void | aboutToReceiveData () |
void | aboutToReset () |
void | reset () |
void | toolEnabled (const QString &toolId) |
void | toolEnabledByIndex (int toolIndex) |
void | toolListAvailable () |
void | toolSelected (const QString &toolId) |
void | toolSelectedByIndex (int index) |
void | toolsForObjectResponse (const GammaRay::ObjectId &id, const QVector< GammaRay::ToolInfo > &toolInfos) |
Public Member Functions | |
ClientToolManager (QObject *parent=nullptr) | |
bool | isToolListLoaded () const |
QAbstractItemModel * | model () |
void | requestToolsForObject (const ObjectId &id) |
QItemSelectionModel * | selectionModel () |
void | selectObject (const ObjectId &id, const ToolInfo &toolInfo) |
void | setToolParentWidget (QWidget *parent) |
int | toolIndexForToolId (const QString &toolId) const |
QVector< ToolInfo > | tools () const |
QWidget * | widgetForId (const QString &toolId) const |
QWidget * | widgetForIndex (int index) 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, Qt::FindChildOptions options) const |
QList< T > | findChildren (const QString &name, Qt::FindChildOptions options) const |
QList< T > | findChildren (const QRegExp ®Exp, Qt::FindChildOptions options) const |
QList< T > | findChildren (const QRegularExpression &re, Qt::FindChildOptions 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 |
Static Public Member Functions | |
static ClientToolManager * | instance () |
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 | |
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) |
Properties inherited from QObject | |
objectName | |
Tool Management API for the client to find out, which tools exist, get the tool's widgets, etc.
This is needed when implementing your own client UI embedded into a different application. If you want to provide a list with all supported tools, you can use ClientToolManager::model() to get all the tool information as a model.
This class also takes care of loading client-sided tool plugins.