API reference - Class QLibrary

DeepBindHint

Signature: [static,const] QLibrary_LoadHint DeepBindHint

Description: Enum constant QLibrary::DeepBindHint

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

ExportExternalSymbolsHint

Signature: [static,const] QLibrary_LoadHint ExportExternalSymbolsHint

Description: Enum constant QLibrary::ExportExternalSymbolsHint

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

LoadArchiveMemberHint

Signature: [static,const] QLibrary_LoadHint LoadArchiveMemberHint

Description: Enum constant QLibrary::LoadArchiveMemberHint

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

PreventUnloadHint

Signature: [static,const] QLibrary_LoadHint PreventUnloadHint

Description: Enum constant QLibrary::PreventUnloadHint

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

ResolveAllSymbolsHint

Signature: [static,const] QLibrary_LoadHint ResolveAllSymbolsHint

Description: Enum constant QLibrary::ResolveAllSymbolsHint

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

_const_cast

Signature: [const] QLibrary 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.

childEvent

Signature: void childEvent (QChildEvent ptr event)

Description: Virtual method void QLibrary::childEvent(QChildEvent *event)

This method can be reimplemented in a derived class.

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.

customEvent

Signature: void customEvent (QEvent ptr event)

Description: Virtual method void QLibrary::customEvent(QEvent *event)

This method can be reimplemented in a derived class.

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: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QLibrary::destroyed(QObject *)

You can bind a procedure to this signal.

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

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QLibrary::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

Description: Emitter for signal void QLibrary::destroyed(QObject *)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QLibrary::objectNameChanged(const QString &objectName)

Call this method to emit this signal.

errorString

Signature: [const] string errorString

Description: Method QString QLibrary::errorString()

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QLibrary::event(QEvent *event)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr watched, QEvent ptr event)

Description: Virtual method bool QLibrary::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

fileName

Signature: [const] string fileName

Description: Method QString QLibrary::fileName()

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

fileName=

Signature: void fileName= (string fileName)

Description: Method void QLibrary::setFileName(const QString &fileName)

Python specific notes:
The object exposes a writable attribute 'fileName'. This is the setter.

isLibrary?

Signature: [static] bool isLibrary? (string fileName)

Description: Static method bool QLibrary::isLibrary(const QString &fileName)

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

isLoaded?

Signature: [const] bool isLoaded?

Description: Method bool QLibrary::isLoaded()

isSignalConnected

Signature: [const] bool isSignalConnected (const QMetaMethod signal)

Description: Method bool QLibrary::isSignalConnected(const QMetaMethod &signal)

This method is protected and can only be called from inside a derived class.

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.

load

Signature: bool load

Description: Method bool QLibrary::load()

loadHints

Signature: [const] QLibrary_QFlags_LoadHint loadHints

Description: Method QFlags<QLibrary::LoadHint> QLibrary::loadHints()

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

loadHints=

Signature: void loadHints= (QLibrary_QFlags_LoadHint hints)

Description: Method void QLibrary::setLoadHints(QFlags<QLibrary::LoadHint> hints)

Python specific notes:
The object exposes a writable attribute 'loadHints'. This is the setter.

new

(1) Signature: [static] new QLibrary new (QObject ptr parent = nullptr)

Description: Constructor QLibrary::QLibrary(QObject *parent)

This method creates an object of class QLibrary.

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

(2) Signature: [static] new QLibrary new (string fileName, QObject ptr parent = nullptr)

Description: Constructor QLibrary::QLibrary(const QString &fileName, QObject *parent)

This method creates an object of class QLibrary.

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

(3) Signature: [static] new QLibrary new (string fileName, int verNum, QObject ptr parent = nullptr)

Description: Constructor QLibrary::QLibrary(const QString &fileName, int verNum, QObject *parent)

This method creates an object of class QLibrary.

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

(4) Signature: [static] new QLibrary new (string fileName, string version, QObject ptr parent = nullptr)

Description: Constructor QLibrary::QLibrary(const QString &fileName, const QString &version, QObject *parent)

This method creates an object of class QLibrary.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QLibrary::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

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

receivers

Signature: [const] int receivers (string signal)

Description: Method int QLibrary::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QLibrary::sender()

This method is protected and can only be called from inside a derived class.

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QLibrary::senderSignalIndex()

This method is protected and can only be called from inside a derived class.

setFileName

Signature: void setFileName (string fileName)

Description: Method void QLibrary::setFileName(const QString &fileName)

Python specific notes:
The object exposes a writable attribute 'fileName'. This is the setter.

setFileNameAndVersion

(1) Signature: void setFileNameAndVersion (string fileName, int verNum)

Description: Method void QLibrary::setFileNameAndVersion(const QString &fileName, int verNum)

(2) Signature: void setFileNameAndVersion (string fileName, string version)

Description: Method void QLibrary::setFileNameAndVersion(const QString &fileName, const QString &version)

setLoadHints

Signature: void setLoadHints (QLibrary_QFlags_LoadHint hints)

Description: Method void QLibrary::setLoadHints(QFlags<QLibrary::LoadHint> hints)

Python specific notes:
The object exposes a writable attribute 'loadHints'. This is the setter.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QLibrary::timerEvent(QTimerEvent *event)

This method can be reimplemented in a derived class.

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

Description: Static method QString QLibrary::tr(const char *s, const char *c, int n)

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

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

Description: Static method QString QLibrary::trUtf8(const char *s, const char *c, int n)

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

unload

Signature: bool unload

Description: Method bool QLibrary::unload()