QtBase  v6.3.1
Public Types | Static Public Member Functions | List of all members
QLibraryInfo Class Reference

The QLibraryInfo class provides information about the Qt library. More...

#include <qlibraryinfo.h>

Public Types

enum  LibraryPath {
  PrefixPath = 0 , DocumentationPath , HeadersPath , LibrariesPath ,
  LibraryExecutablesPath , BinariesPath , PluginsPath , QmlImportsPath ,
  Qml2ImportsPath = QmlImportsPath , ArchDataPath , DataPath , TranslationsPath ,
  ExamplesPath , TestsPath , SettingsPath = 100
}
 

Static Public Member Functions

static const char * build () noexcept
 
static bool isDebugBuild ()
 
static QVersionNumber version () noexcept Q_DECL_CONST_FUNCTION
 
static QString path (LibraryPath p)
 
static QStringList platformPluginArguments (const QString &platformName)
 

Detailed Description

The QLibraryInfo class provides information about the Qt library.

\inmodule QtCore

Many pieces of information are established when Qt is configured and built. This class provides an abstraction for accessing that information. By using the static functions of this class, an application can obtain information about the instance of the Qt library which the application is using at run-time.

You can also use a qt.conf file to override the hard-coded paths that are compiled into the Qt library. For more information, see the \l {Using qt.conf} documentation.

See also
QSysInfo, {Using qt.conf}

Definition at line 49 of file qlibraryinfo.h.

Member Enumeration Documentation

◆ 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 60 of file qlibraryinfo.h.

Member Function Documentation

◆ build()

const char * QLibraryInfo::build ( )
staticnoexcept

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

Definition at line 283 of file qlibraryinfo.cpp.

Here is the caller graph for this function:

◆ isDebugBuild()

bool QLibraryInfo::isDebugBuild ( )
static
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 294 of file qlibraryinfo.cpp.

Here is the caller graph for this function:

◆ path()

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

Definition at line 553 of file qlibraryinfo.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ 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}

Definition at line 647 of file qlibraryinfo.cpp.

Here is the call graph for this function:

◆ version()

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

Definition at line 309 of file qlibraryinfo.cpp.

Here is the caller graph for this function:

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