GammaRay::ToolUiFactory Class Reference

An abstract interface for creating the UI parts of probe tools. More...

#include <tooluifactory.h>

Inheritance diagram for GammaRay::ToolUiFactory:

Public Member Functions
virtual QWidget *	createWidget (QWidget *parentWidget)=0
	Create the UI part of this tool. More...
virtual QString	id () const =0
	Unique id of this tool, must match the id of a the corresponding probe tool. More...
virtual void	initUi ()
	Initialize UI related stuff for this tool. More...
virtual QString	name () const
	Human readable name of this tool. More...
virtual bool	remotingSupported () const
	Return true if this tool supports remoting, false otherwise. More...

Detailed Description

An abstract interface for creating the UI parts of probe tools.

The ToolUiFactory class is an abstract base class for creating UIs for probe tools for GammaRay. The unique identifier used for the UI must match the one of the corresponding probe tool.

Member Function Documentation

virtual QWidget* GammaRay::ToolUiFactory::createWidget ( QWidget *  parentWidget )

pure virtual

Create the UI part of this tool.

Parameters

parentWidget

The parent widget for the visual elements of this tool.

Returns

a pointer to the created QwWidget.

Implemented in GammaRay::StandardToolUiFactory< ToolUi >.

virtual QString GammaRay::ToolUiFactory::id ( ) const

pure virtual

Unique id of this tool, must match the id of a the corresponding probe tool.

Returns

a QString containing the tool id.

Implemented in GammaRay::StandardToolUiFactory< ToolUi >.

virtual void GammaRay::ToolUiFactory::initUi ( )

virtual

Initialize UI related stuff for this tool.

This function is called on loading the plugin, before the widget itself is needed. Use createWidget to create the actual widget.

virtual QString GammaRay::ToolUiFactory::name ( ) const

virtual

Human readable name of this tool.

You do not need to override this usually, the plugin loader will fill this in.

Returns

a QString containing the tool name.

virtual bool GammaRay::ToolUiFactory::remotingSupported ( ) const

virtual

Return true if this tool supports remoting, false otherwise.

The default implementation returns true.