GammaRay  2.1.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Macros Pages
Public Member Functions | List of all members
GammaRay::ToolFactory Class Referenceabstract

An abstract interface for probe tools. More...

#include <toolfactory.h>

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

Public Member Functions

virtual QString id () const =0
 
virtual void init (ProbeInterface *probe)=0
 
virtual bool isHidden () const =0
 
virtual QString name () const =0
 
virtual QStringList supportedTypes () const =0
 

Detailed Description

An abstract interface for probe tools.

The ToolFactory class is an abstract base class for creating probe tools for GammaRay. Each tool must have a unique identifier.

Member Function Documentation

virtual QString GammaRay::ToolFactory::id ( ) const
pure virtual

Unique id of this tool

Returns
a QString containing the tool id.

Implemented in GammaRay::StandardToolFactory2< Type, Tool, ToolUi >, and GammaRay::StandardToolFactory< Type, Tool >.

virtual void GammaRay::ToolFactory::init ( ProbeInterface probe)
pure virtual

Initialize the tool. Implement this method to do non-GUI initialization, such as creating object tracking models etc.

Parameters
probeThe probe interface allowing access to the object models.

Implemented in GammaRay::StandardToolFactory2< Type, Tool, ToolUi >, and GammaRay::StandardToolFactory< Type, Tool >.

virtual bool GammaRay::ToolFactory::isHidden ( ) const
pure virtual

Allows to hide a plug-in from the UI. This is useful for plug-ins that only provide support for additional data types.

Since
2.1

Implemented in GammaRay::StandardToolFactory2< Type, Tool, ToolUi >, and GammaRay::StandardToolFactory< Type, Tool >.

virtual QString GammaRay::ToolFactory::name ( ) const
pure virtual

Human readable name of this tool.

Returns
a QString containing the tool name.
virtual QStringList GammaRay::ToolFactory::supportedTypes ( ) const
pure virtual

Class names of types this tool can handle. The tool will only be activated if an object of one of these types is seen in the probed application.

Returns
a QStringList of class names of types this tool supports.

Implemented in GammaRay::StandardToolFactory2< Type, Tool, ToolUi >, and GammaRay::StandardToolFactory< Type, Tool >.


The documentation for this class was generated from the following file:

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