GammaRay API Documentation  2.8.0
Namespaces | Classes | Typedefs | Enumerations | Functions | Variables
GammaRay Namespace Reference

All GammaRay classes. More...


 Enum conversion utility functions.
 Retrieve/expose objects independent of whether using in-process or out-of-process UI.
 Retrieve basic information about QObject instances.
 GammaRay Object Models.
 Methods to determine install locations of the various bits of GammaRay.
 Functions to locate a suitable probe.
 Priority values for property widget extension tabs. It is recommended to specify tab priorities relating to these constants.
 Helper functions and constants defining the communication protocol between client and server.
 Custom roles for GammaRay::ToolModel.
 GammaRay utilities.
 GammaRay UI utilities.
 Variant conversion functions, extendable by plugins.


class  AbstractObjectDataProvider
 Base class for custom object data providers. Inherit from this and register at ObjectDataProvider, to support basic QObject information retrieval from dynamic language bindings, such as QML. More...
class  ClassesIconsRepository
 Collection of classes icons id/file path and on-demand client/server transfer of those. More...
class  ClassesIconsRepositoryServer
 Probe-side classes icons index management. More...
class  ClientConnectionManager
 Pre-MainWindow connection setup logic. More...
class  ClientDecorationIdentityProxyModel
class  ClientToolManager
 Tool Management API for the client to find out, which tools exist, get the tool's widgets, etc. More...
class  Endpoint
 Network protocol endpoint. More...
class  EnumDefinition
 Target-independent representation of an enum or flag definition. More...
class  EnumDefinitionElement
 A single element of an EnumDefinition. More...
class  EnumRepository
 Collection of EnumDefinition and on-demand client/server transfer of those. More...
class  EnumRepositoryServer
 Probe-side enum definition management. More...
class  EnumValue
 A target-independent representation of an enum or flag value. More...
class  Launcher
 Manages launching a target process, injecting the probe and if needed also starting the client application. More...
class  LaunchOptions
 Describes the injection and probe options used for launching/attacing to a host process. More...
class  MetaObject
 Compile-time introspection adaptor for non-QObject classes. More...
class  MetaObjectImpl
 Template implementation of MetaObject. More...
class  MetaObjectRepository
 MetaObject repository. More...
class  MetaProperty
 Introspectable adaptor to non-QObject properties. More...
class  MetaPropertyImpl
 Template-ed implementation of MetaProperty for member properties. More...
class  MetaStaticPropertyImpl
 Template-ed implementation of MetaProperty for static properties. More...
class  NetworkDiscoveryModel
 Lists all active server instances found via network autodiscovery. More...
class  ObjectFilterProxyModelBase
 A QSortFilterProxyModel for generic Objects. More...
class  ObjectId
 Type-safe and cross-process object identifier. More...
class  ObjectIdsFilterProxyModel
 A KRecursiveFilterProxyModel for ObjectIds. More...
class  ObjectModelBase
 A container for a generic Object Model derived from some Base. More...
class  ObjectTypeFilterProxyModel
 A templated generic ObjectFilterProxyModelBase for some data type. More...
class  Probe
 Central entity of GammaRay: The probe is tracking the Qt application under test. More...
class  ProbeABI
 Describes a probe ABI. The probe ABI is everything that determines if a probe is compatible with a given target or not. More...
class  ProbeABIDetector
 Detect the probe ABI required for a given target. A target can be specified as either a process id or a path to an executable to be launched. More...
class  ProbeController
 Server-side part for the object property inspector. Use this to integrate a property inspector like in the QObject view into your tool. More...
class  ProbeControllerInterface
 Probe and host process remote control functions. More...
class  ProbeInterface
 An abstract interface for accessing the core GammaRay probe. More...
class  ProcessTracker
class  ProcessTrackerBackend
struct  ProcessTrackerInfo
class  PropertyController
 Non-UI part of the property widget. More...
class  PropertyControllerExtension
 Base-class for server-side property editor extensions. More...
class  PropertyControllerInterface
 Client/Server interface of the property editor. More...
class  PropertyEditorDelegate
 Delegate for rendering and editing QVariant property values. More...
class  PropertyWidget
 Client-side counter-part GammaRay::PropertyController. More...
class  PropertyWidgetTabFactory
 Template implementation of PropertyWidgetTabFactoryBase. More...
class  PropertyWidgetTabFactoryBase
 Interface for tabs in the property widget. More...
struct  SignalSpyCallbackSet
 Callbacks for tracing signal emissions and slot invocation. More...
class  SingleColumnObjectProxyModel
 A QIdentityProxyModel for generic Objects. More...
class  SourceLocation
 Specifies a source code location. More...
class  StandardToolFactory
 A templated generic ToolFactory for some data type and tool. More...
class  StandardToolUiFactory
 A templated convenience ToolUiFactory applicable for most use-cases. More...
class  ToolFactory
 An abstract interface for probe tools. More...
class  ToolInfo
 Data structure describing a single GammaRay tool. More...
class  ToolUiFactory
 An abstract interface for creating the UI parts of probe tools. More...
class  UiIntegration
 Interface for UI plugins to integrate with the client UI. This is especially relevant when the client is embedded inside another application such as an IDE. More...
class  UIStateManager


typedef int EnumId
 Unique identifier for EnumDefinition instances. More...
typedef QVector< class ObjectIdObjectIds
 Type-safe and cross-process object identifier vector.
typedef QVector< QVariantUISizeVector
 Interface for UI plugins to manage their states. More...


enum  EnumIds { InvalidEnumId = -1, FirstValidEnumId = 0 }


QDataStreamoperator<< (QDataStream &out, const EnumValue &v)
QDataStreamoperator<< (QDataStream &out, const SourceLocation &location)
QDebugoperator<< (QDebug dbg, const ObjectId &id)
QDataStreamoperator<< (QDataStream &out, const EnumDefinition &def)
QDataStreamoperator<< (QDataStream &out, const ObjectId &id)
QDataStreamoperator>> (QDataStream &in, EnumValue &v)
QDataStreamoperator>> (QDataStream &in, SourceLocation &location)
QDataStreamoperator>> (QDataStream &in, EnumDefinition &def)
QDataStreamoperator>> (QDataStream &in, ObjectId &id)


static const int UserRole = 256

Detailed Description

All GammaRay classes.

Typedef Documentation

◆ EnumId

typedef int GammaRay::EnumId

Unique identifier for EnumDefinition instances.

◆ UISizeVector

Interface for UI plugins to manage their states.

The manager is able to track if changes appear and only persists them in this case. That mean any not moved splitter handle will not be persisted, and % based sizes will works correctly even on resize. Any QMainwindow is always restored/saved.

There is now the possibility to implements custom restore/save state per targets. Just create those 2 public Q_INVOKABLE in the UIStateManager widget:

  • Q_INVOKABLE void saveTargetState(QSettings *settings) const;
  • Q_INVOKABLE void restoreTargetState(QSettings *settings);

Usually, button checked, QTabWidget indexes... Do not store size related things or native Qt save/restore states here, that's the role of UIStateManager itself.

Variable Documentation

◆ UserRole

const int GammaRay::UserRole = 256

Portable replacement for Qt::UserRole. Qt4 uses 32, Qt5 256, use the latter globally to allow combining Qt4/5 client/servers.

Klarälvdalens Datakonsult AB (KDAB)
"The Qt Experts"
Qt-application inspection and manipulation tool