API reference - Class QThread

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QThread

Class hierarchy: QThread » QObject

Sub-classes: Priority, QFlags_Priority

Public constructors

new QThreadnew(QObject ptr parent = 0)Constructor QThread::QThread(QObject *parent)

Public methods

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.
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QThread::destroyed(QObject *)
voidemit_destroyed(QObject ptr arg1 = 0)Emitter for signal void QThread::destroyed(QObject *)
voidemit_finishedEmitter for signal void QThread::finished()
voidemit_startedEmitter for signal void QThread::started()
voidemit_terminatedEmitter for signal void QThread::terminated()
boolevent(QEvent ptr arg1)Virtual method bool QThread::event(QEvent *)
booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QThread::eventFilter(QObject *, QEvent *)
voidexit(int retcode = 0)Method void QThread::exit(int retcode)
[signal]voidfinishedSignal declaration for QThread::finished()
[const]boolisFinished?Method bool QThread::isFinished()
[const]boolisRunning?Method bool QThread::isRunning()
[const]QThread_PrioritypriorityMethod QThread::Priority QThread::priority()
voidpriority=(const QThread_Priority priority)Method void QThread::setPriority(QThread::Priority priority)
voidquitMethod void QThread::quit()
voidsetPriority(const QThread_Priority priority)Method void QThread::setPriority(QThread::Priority priority)
voidsetStackSize(unsigned int stackSize)Method void QThread::setStackSize(unsigned int stackSize)
[const]unsigned intstackSizeMethod unsigned int QThread::stackSize()
voidstackSize=(unsigned int stackSize)Method void QThread::setStackSize(unsigned int stackSize)
voidstart(const QThread_Priority arg1 = QThread::InheritPriority)Method void QThread::start(QThread::Priority)
[signal]voidstartedSignal declaration for QThread::started()
voidterminateMethod void QThread::terminate()
[signal]voidterminatedSignal declaration for QThread::terminated()
boolwait(unsigned long time = ULONG_MAX)Method bool QThread::wait(unsigned long int time)

Public static methods and constants

[static,const]QThread_PriorityHighPriorityEnum constant QThread::HighPriority
[static,const]QThread_PriorityHighestPriorityEnum constant QThread::HighestPriority
[static,const]QThread_PriorityIdlePriorityEnum constant QThread::IdlePriority
[static,const]QThread_PriorityInheritPriorityEnum constant QThread::InheritPriority
[static,const]QThread_PriorityLowPriorityEnum constant QThread::LowPriority
[static,const]QThread_PriorityLowestPriorityEnum constant QThread::LowestPriority
[static,const]QThread_PriorityNormalPriorityEnum constant QThread::NormalPriority
[static,const]QThread_PriorityTimeCriticalPriorityEnum constant QThread::TimeCriticalPriority
QThread ptrcurrentThreadStatic method QThread *QThread::currentThread()
unsigned longcurrentThreadIdStatic method Qt::HANDLE QThread::currentThreadId()
intidealThreadCountStatic method int QThread::idealThreadCount()
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = 0)
Static method QString QThread::tr(const char *s, const char *c)
stringtr(string s,
string c,
int n)
Static method QString QThread::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = 0)
Static method QString QThread::trUtf8(const char *s, const char *c)
stringtrUtf8(string s,
string c,
int n)
Static method QString QThread::trUtf8(const char *s, const char *c, int n)
voidyieldCurrentThreadStatic method void QThread::yieldCurrentThread()

Protected methods (static, non-static and constructors)

voidchildEvent(QChildEvent ptr arg1)Virtual method void QThread::childEvent(QChildEvent *)
voidcustomEvent(QEvent ptr arg1)Virtual method void QThread::customEvent(QEvent *)
voiddisconnectNotify(string signal)Virtual method void QThread::disconnectNotify(const char *signal)
intexecMethod int QThread::exec()
[static]voidmsleep(unsigned long arg1)Method void QThread::msleep(unsigned long int)
[const]intreceivers(string signal)Method int QThread::receivers(const char *signal)
voidrunVirtual method void QThread::run()
[const]QObject ptrsenderMethod QObject *QThread::sender()
[static]voidsetTerminationEnabled(bool enabled = true)Method void QThread::setTerminationEnabled(bool enabled)
[static]voidsleep(unsigned long arg1)Method void QThread::sleep(unsigned long int)
voidtimerEvent(QTimerEvent ptr arg1)Virtual method void QThread::timerEvent(QTimerEvent *)
[static]voidusleep(unsigned long arg1)Method void QThread::usleep(unsigned long int)

Detailed description

HighPriority

Signature: [static,const] QThread_Priority HighPriority

Description: Enum constant QThread::HighPriority

HighestPriority

Signature: [static,const] QThread_Priority HighestPriority

Description: Enum constant QThread::HighestPriority

IdlePriority

Signature: [static,const] QThread_Priority IdlePriority

Description: Enum constant QThread::IdlePriority

InheritPriority

Signature: [static,const] QThread_Priority InheritPriority

Description: Enum constant QThread::InheritPriority

LowPriority

Signature: [static,const] QThread_Priority LowPriority

Description: Enum constant QThread::LowPriority

LowestPriority

Signature: [static,const] QThread_Priority LowestPriority

Description: Enum constant QThread::LowestPriority

NormalPriority

Signature: [static,const] QThread_Priority NormalPriority

Description: Enum constant QThread::NormalPriority

TimeCriticalPriority

Signature: [static,const] QThread_Priority TimeCriticalPriority

Description: Enum constant QThread::TimeCriticalPriority

_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 arg1)

Description: Virtual method void QThread::childEvent(QChildEvent *)

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] unsigned long 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 arg1)

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

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 (string signal)

Description: Virtual method void QThread::disconnectNotify(const char *signal)

This method can be reimplemented in a derived class.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = 0)

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_started

Signature: void emit_started

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

Call this method to emit this signal.

emit_terminated

Signature: void emit_terminated

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

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr arg1, QEvent ptr arg2)

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

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()

isRunning?

Signature: [const] bool isRunning?

Description: Method bool QThread::isRunning()

msleep

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

Description: Method void QThread::msleep(unsigned long int)

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

new

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

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

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.

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.

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: Method void QThread::sleep(unsigned long int)

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

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()

terminated

Signature: [signal] void terminated

Description: Signal declaration for QThread::terminated()

You can bind a procedure to this signal.

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

timerEvent

Signature: void timerEvent (QTimerEvent ptr arg1)

Description: Virtual method void QThread::timerEvent(QTimerEvent *)

This method can be reimplemented in a derived class.

tr

(1) Signature: [static] string tr (string s, string c = 0)

Description: Static method QString QThread::tr(const char *s, const char *c)

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

(2) Signature: [static] string tr (string s, string c, int n)

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

(1) Signature: [static] string trUtf8 (string s, string c = 0)

Description: Static method QString QThread::trUtf8(const char *s, const char *c)

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

(2) Signature: [static] string trUtf8 (string s, string c, int n)

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: Method void QThread::usleep(unsigned long int)

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

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.