GammaRay API Documentation  2.11.0
Public Slots | Signals | Public Member Functions | Static Public Member Functions | List of all members
GammaRay::ClientToolManager Class Reference

Tool Management API for the client to find out, which tools exist, get the tool's widgets, etc. More...

#include <clienttoolmanager.h>

Inheritance diagram for GammaRay::ClientToolManager:
Inheritance graph
[legend]

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
 
QAbstractItemModelmodel ()
 
void requestToolsForObject (const ObjectId &id)
 
QItemSelectionModelselectionModel ()
 
void selectObject (const ObjectId &id, const ToolInfo &toolInfo)
 
void setToolParentWidget (QWidget *parent)
 
ToolInfo toolForToolId (const QString &toolId) const
 
int toolIndexForToolId (const QString &toolId) const
 
QVector< ToolInfotools () const
 
QWidgetwidgetForId (const QString &toolId) const
 
QWidgetwidgetForIndex (int index) const
 
- Public Member Functions inherited from QObject
 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 () const const
 
void dumpObjectInfo ()
 
void dumpObjectTree () const const
 
void dumpObjectTree ()
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, 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 QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
virtual int qt_metacall (QMetaObject::Call, int, void **)
 
virtual void * qt_metacast (const char *)
 
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)
 
QThreadthread () const const
 

Static Public Member Functions

static ClientToolManagerinstance ()
 
- 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 const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

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.


Klarälvdalens Datakonsult AB (KDAB)
"The Qt Experts"
https://www.kdab.com/
GammaRay
Qt-application inspection and manipulation tool
https://www.kdab.com/gammaray/