GammaRay API Documentation  2.11.1
Functions
GammaRay::Paths Namespace Reference

Methods to determine install locations of the various bits of GammaRay. More...

Functions

QString binPath ()
 Returns the path containing the GammaRay injector executable. More...
 
GAMMARAY_COMMON_DEPRECATED_EXPORT QString currentPluginsPath ()
 Returns the path to the current plugins location. More...
 
GAMMARAY_COMMON_DEPRECATED_EXPORT QString currentProbePath ()
 Returns the path to the current probe location, probePath(GAMMARAY_PROBE_ABI). More...
 
QString documentationPath ()
 Path to the installed .qch/.qhc documentation files. More...
 
QString libexecPath ()
 Returns the path containing helper executables. More...
 
QString libraryExtension ()
 Returns the file extension used on the current platform for libraries. More...
 
QString pluginExtension ()
 Returns the file extension used on the current platform for plugins. More...
 
QStringList pluginPaths (const QString &probeABI)
 Returns a list of probe plugin search paths for the given ABI. More...
 
QString probePath (const QString &probeABI, const QString &rootPath=Paths::rootPath())
 Returns the probe and plugin base path for the given probe ABI. More...
 
QString rootPath ()
 Absolute path to the root of the GammaRay installation, anything else is relative to this.
 
void setRelativeRootPath (const char *relativeRootPath)
 Convenience version of the above, for root paths relative to QCoreApplication::applicationDirPath().
 
void setRootPath (const QString &rootPath)
 Call this to set the root of the GammaRay install location, as early as possible. More...
 
QStringList targetPluginPaths (const QString &probeABI)
 Returns a list of target plugin search paths for the given ABI. More...
 

Detailed Description

Methods to determine install locations of the various bits of GammaRay.

Function Documentation

QString GammaRay::Paths::binPath ( )

Returns the path containing the GammaRay injector executable.

GAMMARAY_COMMON_DEPRECATED_EXPORT QString GammaRay::Paths::currentPluginsPath ( )

Returns the path to the current plugins location.

This is the same as currentProbePath() when using the GammaRay installation layout, but differs with e.g. the Android installation layout.

Note
Must not be used outside of probe or client/ui code!
Deprecated:
Use Paths::pluginsPaths instead.
GAMMARAY_COMMON_DEPRECATED_EXPORT QString GammaRay::Paths::currentProbePath ( )

Returns the path to the current probe location, probePath(GAMMARAY_PROBE_ABI).

Note
Must not be used outside of probe code!
Deprecated:
Use Paths::probePath instead.
QString GammaRay::Paths::documentationPath ( )

Path to the installed .qch/.qhc documentation files.

QString GammaRay::Paths::libexecPath ( )

Returns the path containing helper executables.

QString GammaRay::Paths::libraryExtension ( )

Returns the file extension used on the current platform for libraries.

QString GammaRay::Paths::pluginExtension ( )

Returns the file extension used on the current platform for plugins.

QStringList GammaRay::Paths::pluginPaths ( const QString probeABI)

Returns a list of probe plugin search paths for the given ABI.

This includes candidates based on Qt's plugin search paths, and GammaRay's install layout.

Parameters
probeABIThe ABI identifier we are looking for plugins for. If you are actually loading plugins, this must be GAMMARAY_PROBE_ABI.
QString GammaRay::Paths::probePath ( const QString probeABI,
const QString rootPath = Paths::rootPath() 
)

Returns the probe and plugin base path for the given probe ABI.

If probeABI is empty, the path containing the probes is returned.

void GammaRay::Paths::setRootPath ( const QString rootPath)

Call this to set the root of the GammaRay install location, as early as possible.

The install location is usually determined by using QCoreApplication::applicationDirPath() or the probe path, and the known relative install location of the corresponding component.

QStringList GammaRay::Paths::targetPluginPaths ( const QString probeABI)

Returns a list of target plugin search paths for the given ABI.

This includes candidates based on Qt's plugin search paths, and GammaRay's install layout.

Parameters
probeABIThe ABI identifier we are looking for plugins for. If you are actually loading plugins, this must be GAMMARAY_PROBE_ABI.

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