API reference - Class QUiLoader

_const_cast

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

addPluginPath

Signature: void addPluginPath (string path)

Description: Method void QUiLoader::addPluginPath(const QString &path)

availableLayouts

Signature: [const] string[] availableLayouts

Description: Method QStringList QUiLoader::availableLayouts()

availableWidgets

Signature: [const] string[] availableWidgets

Description: Method QStringList QUiLoader::availableWidgets()

childEvent

Signature: void childEvent (QChildEvent ptr event)

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

This method can be reimplemented in a derived class.

clearPluginPaths

Signature: void clearPluginPaths

Description: Method void QUiLoader::clearPluginPaths()

createAction

Signature: QAction ptr createAction (QObject ptr parent, string name)

Description: Virtual method QAction *QUiLoader::createAction(QObject *parent, const QString &name)

This method can be reimplemented in a derived class.

createActionGroup

Signature: QActionGroup ptr createActionGroup (QObject ptr parent, string name)

Description: Virtual method QActionGroup *QUiLoader::createActionGroup(QObject *parent, const QString &name)

This method can be reimplemented in a derived class.

createLayout

Signature: QLayout ptr createLayout (string className, QObject ptr parent, string name)

Description: Virtual method QLayout *QUiLoader::createLayout(const QString &className, QObject *parent, const QString &name)

This method can be reimplemented in a derived class.

createWidget

Signature: QWidget ptr createWidget (string className, QWidget ptr parent, string name)

Description: Virtual method QWidget *QUiLoader::createWidget(const QString &className, QWidget *parent, const QString &name)

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QUiLoader::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 QUiLoader::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 QUiLoader::destroyed(QObject *)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

errorString

Signature: [const] string errorString

Description: Method QString QUiLoader::errorString()

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QUiLoader::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 QUiLoader::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

isLanguageChangeEnabled?

Signature: [const] bool isLanguageChangeEnabled?

Description: Method bool QUiLoader::isLanguageChangeEnabled()

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

isSignalConnected

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

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

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

isTranslationEnabled?

Signature: [const] bool isTranslationEnabled?

Description: Method bool QUiLoader::isTranslationEnabled()

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

languageChangeEnabled

Signature: [const] bool languageChangeEnabled

Description: Method bool QUiLoader::isLanguageChangeEnabled()

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

languageChangeEnabled=

Signature: void languageChangeEnabled= (bool enabled)

Description: Method void QUiLoader::setLanguageChangeEnabled(bool enabled)

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

load

Signature: QWidget ptr load (QIODevice ptr device, QWidget ptr parentWidget = nullptr)

Description: Method QWidget *QUiLoader::load(QIODevice *device, QWidget *parentWidget)

new

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

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

This method creates an object of class QUiLoader.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QUiLoader::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.

pluginPaths

Signature: [const] string[] pluginPaths

Description: Method QStringList QUiLoader::pluginPaths()

receivers

Signature: [const] int receivers (string signal)

Description: Method int QUiLoader::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 *QUiLoader::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QUiLoader::senderSignalIndex()

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

setLanguageChangeEnabled

Signature: void setLanguageChangeEnabled (bool enabled)

Description: Method void QUiLoader::setLanguageChangeEnabled(bool enabled)

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

setTranslationEnabled

Signature: void setTranslationEnabled (bool enabled)

Description: Method void QUiLoader::setTranslationEnabled(bool enabled)

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

setWorkingDirectory

Signature: void setWorkingDirectory (const QDir dir)

Description: Method void QUiLoader::setWorkingDirectory(const QDir &dir)

Python specific notes:
The object exposes a writable attribute 'workingDirectory'. 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 QUiLoader::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 QUiLoader::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 QUiLoader::trUtf8(const char *s, const char *c, int n)

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

translationEnabled

Signature: [const] bool translationEnabled

Description: Method bool QUiLoader::isTranslationEnabled()

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

translationEnabled=

Signature: void translationEnabled= (bool enabled)

Description: Method void QUiLoader::setTranslationEnabled(bool enabled)

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

workingDirectory

Signature: [const] QDir workingDirectory

Description: Method QDir QUiLoader::workingDirectory()

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

workingDirectory=

Signature: void workingDirectory= (const QDir dir)

Description: Method void QUiLoader::setWorkingDirectory(const QDir &dir)

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