API reference - Class QThread

HighPriority

Signature: [static,const] QThread_Priority HighPriority

Description: Enum constant QThread::HighPriority

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

HighestPriority

Signature: [static,const] QThread_Priority HighestPriority

Description: Enum constant QThread::HighestPriority

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

IdlePriority

Signature: [static,const] QThread_Priority IdlePriority

Description: Enum constant QThread::IdlePriority

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

InheritPriority

Signature: [static,const] QThread_Priority InheritPriority

Description: Enum constant QThread::InheritPriority

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

LowPriority

Signature: [static,const] QThread_Priority LowPriority

Description: Enum constant QThread::LowPriority

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

LowestPriority

Signature: [static,const] QThread_Priority LowestPriority

Description: Enum constant QThread::LowestPriority

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

NormalPriority

Signature: [static,const] QThread_Priority NormalPriority

Description: Enum constant QThread::NormalPriority

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

TimeCriticalPriority

Signature: [static,const] QThread_Priority TimeCriticalPriority

Description: Enum constant QThread::TimeCriticalPriority

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

_const_cast

Signature: [const] QThread 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 QThread::childEvent(QChildEvent *event)

This method can be reimplemented in a derived class.

currentThread

Signature: [static] QThread ptr currentThread

Description: Static method QThread *QThread::currentThread()

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

currentThreadId

Signature: [static] void * currentThreadId

Description: Static method Qt::HANDLE QThread::currentThreadId()

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

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

destroyed

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

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

Call this method to emit this signal.

emit_finished

Signature: void emit_finished

Description: Emitter for signal void QThread::finished()

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

emit_started

Signature: void emit_started

Description: Emitter for signal void QThread::started()

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr event)

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

This method can be reimplemented in a derived class.

eventDispatcher

Signature: [const] QAbstractEventDispatcher ptr eventDispatcher

Description: Method QAbstractEventDispatcher *QThread::eventDispatcher()

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

eventDispatcher=

Signature: void eventDispatcher= (QAbstractEventDispatcher ptr eventDispatcher)

Description: Method void QThread::setEventDispatcher(QAbstractEventDispatcher *eventDispatcher)

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

eventFilter

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

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

This method can be reimplemented in a derived class.

exec

Signature: int exec

Description: Method int QThread::exec()

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

Python specific notes:
This attribute is available as 'exec_' in Python.

exit

Signature: void exit (int retcode = 0)

Description: Method void QThread::exit(int retcode)

finished

Signature: [signal] void finished

Description: Signal declaration for QThread::finished()

You can bind a procedure to this signal.

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

idealThreadCount

Signature: [static] int idealThreadCount

Description: Static method int QThread::idealThreadCount()

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

isFinished?

Signature: [const] bool isFinished?

Description: Method bool QThread::isFinished()

isInterruptionRequested?

Signature: [const] bool isInterruptionRequested?

Description: Method bool QThread::isInterruptionRequested()

isRunning?

Signature: [const] bool isRunning?

Description: Method bool QThread::isRunning()

isSignalConnected

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

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

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

loopLevel

Signature: [const] int loopLevel

Description: Method int QThread::loopLevel()

msleep

Signature: [static] void msleep (unsigned long arg1)

Description: Static method void QThread::msleep(unsigned long int)

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

new

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

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

This method creates an object of class QThread.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

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

priority

Signature: [const] QThread_Priority priority

Description: Method QThread::Priority QThread::priority()

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

priority=

Signature: void priority= (const QThread_Priority priority)

Description: Method void QThread::setPriority(QThread::Priority priority)

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

quit

Signature: void quit

Description: Method void QThread::quit()

receivers

Signature: [const] int receivers (string signal)

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

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

requestInterruption

Signature: void requestInterruption

Description: Method void QThread::requestInterruption()

run

Signature: void run

Description: Virtual method void QThread::run()

This method can be reimplemented in a derived class.

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QThread::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QThread::senderSignalIndex()

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

setEventDispatcher

Signature: void setEventDispatcher (QAbstractEventDispatcher ptr eventDispatcher)

Description: Method void QThread::setEventDispatcher(QAbstractEventDispatcher *eventDispatcher)

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

setPriority

Signature: void setPriority (const QThread_Priority priority)

Description: Method void QThread::setPriority(QThread::Priority priority)

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

setStackSize

Signature: void setStackSize (unsigned int stackSize)

Description: Method void QThread::setStackSize(unsigned int stackSize)

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

setTerminationEnabled

Signature: [static] void setTerminationEnabled (bool enabled = true)

Description: Method void QThread::setTerminationEnabled(bool enabled)

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

sleep

Signature: [static] void sleep (unsigned long arg1)

Description: Static method void QThread::sleep(unsigned long int)

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

stackSize

Signature: [const] unsigned int stackSize

Description: Method unsigned int QThread::stackSize()

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

stackSize=

Signature: void stackSize= (unsigned int stackSize)

Description: Method void QThread::setStackSize(unsigned int stackSize)

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

start

Signature: void start (const QThread_Priority arg1 = QThread::InheritPriority)

Description: Method void QThread::start(QThread::Priority)

started

Signature: [signal] void started

Description: Signal declaration for QThread::started()

You can bind a procedure to this signal.

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

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

terminate

Signature: void terminate

Description: Method void QThread::terminate()

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QThread::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 QThread::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 QThread::trUtf8(const char *s, const char *c, int n)

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

usleep

Signature: [static] void usleep (unsigned long arg1)

Description: Static method void QThread::usleep(unsigned long int)

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

wait

Signature: bool wait (unsigned long time = ULONG_MAX)

Description: Method bool QThread::wait(unsigned long int time)

yieldCurrentThread

Signature: [static] void yieldCurrentThread

Description: Static method void QThread::yieldCurrentThread()

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