KLayout 0.29.8 (2024-11-26 926dac96c) [master]

API reference - Class QLibraryInfo

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QLibraryInfo

Sub-classes: LibraryLocation, QFlags_LibraryLocation

Public constructors

new QLibraryInfo ptrnewCreates a new object of this class

Public methods

[const]QLibraryInfo ptr_const_castReturns a non-const reference to self.
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
voidassign(const QLibraryInfo other)Assigns another object to self
[const]new QLibraryInfo ptrdupCreates a copy of self

Public static methods and constants

[static,const]QLibraryInfo_LibraryLocationArchDataPathEnum constant QLibraryInfo::ArchDataPath
[static,const]QLibraryInfo_LibraryLocationBinariesPathEnum constant QLibraryInfo::BinariesPath
[static,const]QLibraryInfo_LibraryLocationDataPathEnum constant QLibraryInfo::DataPath
[static,const]QLibraryInfo_LibraryLocationDocumentationPathEnum constant QLibraryInfo::DocumentationPath
[static,const]QLibraryInfo_LibraryLocationExamplesPathEnum constant QLibraryInfo::ExamplesPath
[static,const]QLibraryInfo_LibraryLocationHeadersPathEnum constant QLibraryInfo::HeadersPath
[static,const]QLibraryInfo_LibraryLocationImportsPathEnum constant QLibraryInfo::ImportsPath
[static,const]QLibraryInfo_LibraryLocationLibrariesPathEnum constant QLibraryInfo::LibrariesPath
[static,const]QLibraryInfo_LibraryLocationLibraryExecutablesPathEnum constant QLibraryInfo::LibraryExecutablesPath
[static,const]QLibraryInfo_LibraryLocationPluginsPathEnum constant QLibraryInfo::PluginsPath
[static,const]QLibraryInfo_LibraryLocationPrefixPathEnum constant QLibraryInfo::PrefixPath
[static,const]QLibraryInfo_LibraryLocationQml2ImportsPathEnum constant QLibraryInfo::Qml2ImportsPath
[static,const]QLibraryInfo_LibraryLocationSettingsPathEnum constant QLibraryInfo::SettingsPath
[static,const]QLibraryInfo_LibraryLocationTestsPathEnum constant QLibraryInfo::TestsPath
[static,const]QLibraryInfo_LibraryLocationTranslationsPathEnum constant QLibraryInfo::TranslationsPath
stringbuildStatic method const char *QLibraryInfo::build()
QDatebuildDateStatic method QDate QLibraryInfo::buildDate()
boolisDebugBuild?Static method bool QLibraryInfo::isDebugBuild()
stringlicensedProductsStatic method QString QLibraryInfo::licensedProducts()
stringlicenseeStatic method QString QLibraryInfo::licensee()
stringlocation(const QLibraryInfo_LibraryLocation arg1)Static method QString QLibraryInfo::location(QLibraryInfo::LibraryLocation)
string[]platformPluginArguments(string platformName)Static method QStringList QLibraryInfo::platformPluginArguments(const QString &platformName)
QVersionNumberversionStatic method QVersionNumber QLibraryInfo::version()

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

ArchDataPath

Signature: [static,const] QLibraryInfo_LibraryLocation ArchDataPath

Description: Enum constant QLibraryInfo::ArchDataPath

Python specific notes:
The object exposes a readable attribute 'ArchDataPath'. This is the getter.

BinariesPath

Signature: [static,const] QLibraryInfo_LibraryLocation BinariesPath

Description: Enum constant QLibraryInfo::BinariesPath

Python specific notes:
The object exposes a readable attribute 'BinariesPath'. This is the getter.

DataPath

Signature: [static,const] QLibraryInfo_LibraryLocation DataPath

Description: Enum constant QLibraryInfo::DataPath

Python specific notes:
The object exposes a readable attribute 'DataPath'. This is the getter.

DocumentationPath

Signature: [static,const] QLibraryInfo_LibraryLocation DocumentationPath

Description: Enum constant QLibraryInfo::DocumentationPath

Python specific notes:
The object exposes a readable attribute 'DocumentationPath'. This is the getter.

ExamplesPath

Signature: [static,const] QLibraryInfo_LibraryLocation ExamplesPath

Description: Enum constant QLibraryInfo::ExamplesPath

Python specific notes:
The object exposes a readable attribute 'ExamplesPath'. This is the getter.

HeadersPath

Signature: [static,const] QLibraryInfo_LibraryLocation HeadersPath

Description: Enum constant QLibraryInfo::HeadersPath

Python specific notes:
The object exposes a readable attribute 'HeadersPath'. This is the getter.

ImportsPath

Signature: [static,const] QLibraryInfo_LibraryLocation ImportsPath

Description: Enum constant QLibraryInfo::ImportsPath

Python specific notes:
The object exposes a readable attribute 'ImportsPath'. This is the getter.

LibrariesPath

Signature: [static,const] QLibraryInfo_LibraryLocation LibrariesPath

Description: Enum constant QLibraryInfo::LibrariesPath

Python specific notes:
The object exposes a readable attribute 'LibrariesPath'. This is the getter.

LibraryExecutablesPath

Signature: [static,const] QLibraryInfo_LibraryLocation LibraryExecutablesPath

Description: Enum constant QLibraryInfo::LibraryExecutablesPath

Python specific notes:
The object exposes a readable attribute 'LibraryExecutablesPath'. This is the getter.

PluginsPath

Signature: [static,const] QLibraryInfo_LibraryLocation PluginsPath

Description: Enum constant QLibraryInfo::PluginsPath

Python specific notes:
The object exposes a readable attribute 'PluginsPath'. This is the getter.

PrefixPath

Signature: [static,const] QLibraryInfo_LibraryLocation PrefixPath

Description: Enum constant QLibraryInfo::PrefixPath

Python specific notes:
The object exposes a readable attribute 'PrefixPath'. This is the getter.

Qml2ImportsPath

Signature: [static,const] QLibraryInfo_LibraryLocation Qml2ImportsPath

Description: Enum constant QLibraryInfo::Qml2ImportsPath

Python specific notes:
The object exposes a readable attribute 'Qml2ImportsPath'. This is the getter.

SettingsPath

Signature: [static,const] QLibraryInfo_LibraryLocation SettingsPath

Description: Enum constant QLibraryInfo::SettingsPath

Python specific notes:
The object exposes a readable attribute 'SettingsPath'. This is the getter.

TestsPath

Signature: [static,const] QLibraryInfo_LibraryLocation TestsPath

Description: Enum constant QLibraryInfo::TestsPath

Python specific notes:
The object exposes a readable attribute 'TestsPath'. This is the getter.

TranslationsPath

Signature: [static,const] QLibraryInfo_LibraryLocation TranslationsPath

Description: Enum constant QLibraryInfo::TranslationsPath

Python specific notes:
The object exposes a readable attribute 'TranslationsPath'. This is the getter.

_const_cast

Signature: [const] QLibraryInfo ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

assign

Signature: void assign (const QLibraryInfo other)

Description: Assigns another object to self

build

Signature: [static] string build

Description: Static method const char *QLibraryInfo::build()

This method is static and can be called without an instance.

buildDate

Signature: [static] QDate buildDate

Description: Static method QDate QLibraryInfo::buildDate()

This method is static and can be called without an instance.

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

destroyed?

Signature: [const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

dup

Signature: [const] new QLibraryInfo ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

isDebugBuild?

Signature: [static] bool isDebugBuild?

Description: Static method bool QLibraryInfo::isDebugBuild()

This method is static and can be called without an instance.

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

licensedProducts

Signature: [static] string licensedProducts

Description: Static method QString QLibraryInfo::licensedProducts()

This method is static and can be called without an instance.

licensee

Signature: [static] string licensee

Description: Static method QString QLibraryInfo::licensee()

This method is static and can be called without an instance.

location

Signature: [static] string location (const QLibraryInfo_LibraryLocation arg1)

Description: Static method QString QLibraryInfo::location(QLibraryInfo::LibraryLocation)

This method is static and can be called without an instance.

new

Signature: [static] new QLibraryInfo ptr new

Description: Creates a new object of this class

Python specific notes:
This method is the default initializer of the object.

platformPluginArguments

Signature: [static] string[] platformPluginArguments (string platformName)

Description: Static method QStringList QLibraryInfo::platformPluginArguments(const QString &platformName)

This method is static and can be called without an instance.

version

Signature: [static] QVersionNumber version

Description: Static method QVersionNumber QLibraryInfo::version()

This method is static and can be called without an instance.