Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QLibraryInfo Class Reference

\inmodule QtCore More...

#include <qlibraryinfo.h>

Collaboration diagram for QLibraryInfo:

Public Types

enum  LibraryPath {
  PrefixPath = 0 , DocumentationPath , HeadersPath , LibrariesPath ,
  LibraryExecutablesPath , BinariesPath , PluginsPath , QmlImportsPath ,
  Qml2ImportsPath = QmlImportsPath , ArchDataPath , DataPath , TranslationsPath ,
  ExamplesPath , TestsPath , SettingsPath = 100
}
 \keyword library location More...

Static Public Member Functions

static const char * build () noexcept
 Returns a string describing how this version of Qt was built.
static Q_DECL_CONST_FUNCTION bool isDebugBuild () noexcept
static Q_DECL_CONST_FUNCTION bool isSharedBuild () noexcept
static Q_DECL_CONST_FUNCTION QVersionNumber version () noexcept
static QString path (LibraryPath p)
static QStringList paths (LibraryPath p)
static QStringList platformPluginArguments (const QString &platformName)
 Returns additional arguments to the platform plugin matching platformName which can be specified as a string list using the key Arguments in a group called Platforms of the qt.conf file.

Detailed Description

\inmodule QtCore

The QLibraryInfo class provides information about the Qt libraries.

This class provides an abstraction for accessing information about the Qt libraries which the application is using, such as run-time paths, or the build configuration of the Qt libraries.

The default run-time paths depend on the Qt build configuration, as well as whether the Qt libraries have been relocated, and possibly bundled along with the application.

You can use a qt.conf file to override the default paths, in case your deployment situation does not match the defaults. For more information, see the \l {Using qt.conf} documentation.

See also
QSysInfo, {Using qt.conf}

Definition at line 14 of file qlibraryinfo.h.

Member Enumeration Documentation

◆ LibraryPath

enum QLibraryInfo::LibraryPath

\keyword library location

This enum type is used to query for a specific path:

\value PrefixPath The default prefix for all paths. \value DocumentationPath The path to documentation upon install. \value HeadersPath The path to all headers. \value LibrariesPath The path to installed libraries. \value LibraryExecutablesPath The path to installed executables required by libraries at runtime. \value BinariesPath The path to installed Qt binaries (tools and applications). \value PluginsPath The path to installed Qt plugins. \value QmlImportsPath The path to installed QML extensions to import. \value Qml2ImportsPath This value is deprecated. Use QmlImportsPath instead. \value ArchDataPath The path to general architecture-dependent Qt data. \value DataPath The path to general architecture-independent Qt data. \value TranslationsPath The path to translation information for Qt strings. \value ExamplesPath The path to examples upon install. \value TestsPath The path to installed Qt testcases. \value SettingsPath The path to Qt settings. Not applicable on Windows.

See also
path()
Enumerator
PrefixPath 
DocumentationPath 
HeadersPath 
LibrariesPath 
LibraryExecutablesPath 
BinariesPath 
PluginsPath 
QmlImportsPath 
Qml2ImportsPath 
ArchDataPath 
DataPath 
TranslationsPath 
ExamplesPath 
TestsPath 
SettingsPath 

Definition at line 26 of file qlibraryinfo.h.

Member Function Documentation

◆ build()

const char * QLibraryInfo::build ( )
staticnoexcept

Returns a string describing how this version of Qt was built.

Since
5.3

Definition at line 233 of file qlibraryinfo.cpp.

◆ isDebugBuild()

bool QLibraryInfo::isDebugBuild ( )
staticnodiscardnoexcept
Since
5.0 Returns true if this build of Qt was built with debugging enabled, or false if it was built in release mode.

Definition at line 244 of file qlibraryinfo.cpp.

◆ isSharedBuild()

bool QLibraryInfo::isSharedBuild ( )
staticnodiscardnoexcept
Since
6.5 Returns true if this is a shared (dynamic) build of Qt.

Definition at line 257 of file qlibraryinfo.cpp.

◆ path()

QString QLibraryInfo::path ( LibraryPath p)
static
Since
6.0 Returns the path specified by p.

If there is more than one path listed in qt.conf, it will only return the first one.

See also
paths

Definition at line 525 of file qlibraryinfo.cpp.

◆ paths()

QStringList QLibraryInfo::paths ( LibraryPath p)
static
Since
6.8 Returns all paths specificied by p.
See also
path

Definition at line 536 of file qlibraryinfo.cpp.

◆ platformPluginArguments()

QStringList QLibraryInfo::platformPluginArguments ( const QString & platformName)
static

Returns additional arguments to the platform plugin matching platformName which can be specified as a string list using the key Arguments in a group called Platforms of the qt.conf file.

sa {Using qt.conf}

Since
5.3

Definition at line 708 of file qlibraryinfo.cpp.

◆ version()

QVersionNumber QLibraryInfo::version ( )
staticnoexcept
Since
5.8 Returns the version of the Qt library.
See also
qVersion()

Definition at line 272 of file qlibraryinfo.cpp.

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