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:

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)
ToolInfo	toolForToolId (const QString &toolId) const
int	toolIndexForToolId (const QString &toolId) const
QVector< ToolInfo > const &	tools () const
QWidget *	widgetForId (const QString &toolId) const
QWidget *	widgetForIndex (int index) const

Static Public Member Functions
static ClientToolManager *	instance ()

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.