KLayout Manual: Main Index » Class Index » API reference - Class QThread

API reference - Class QThread

Notation used in Ruby API documentation

Description: Binding of QThread

Class hierarchy: QThread » QObject

Public constructors

new QThreadnewConstructor QThread::QThread(QObject *parent)
new QThreadnew(QObject ptr parent)Constructor QThread::QThread(QObject *parent)

Public methods

voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[event]voiddestroyed(QObject ptr arg1)Signal declaration for QThread::destroyed(QObject *)
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[virtual]boolevent(QEvent ptr arg1)Virtual method bool QThread::event(QEvent *)
[virtual]booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QThread::eventFilter(QObject *, QEvent *)
voidexitMethod void QThread::exit(int retcode)
voidexit(int retcode)Method void QThread::exit(int retcode)
[event]voidfinishedSignal declaration for QThread::finished()
[const]boolisFinishedMethod bool QThread::isFinished()
[const]boolisFinished?Method bool QThread::isFinished()
[const]boolisRunningMethod bool QThread::isRunning()
[const]boolisRunning?Method bool QThread::isRunning()
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[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(int unsigned stackSize)
[const]unsigned intstackSizeMethod int unsigned QThread::stackSize()
voidstackSize=(unsigned int stackSize)Method void QThread::setStackSize(int unsigned stackSize)
voidstartMethod void QThread::start(QThread::Priority )
voidstart(const QThread_Priority arg1)Method void QThread::start(QThread::Priority )
[event]voidstartedSignal declaration for QThread::started()
voidterminateMethod void QThread::terminate()
[event]voidterminatedSignal declaration for QThread::terminated()
boolwaitMethod bool QThread::wait(long unsigned time)
boolwait(unsigned long time)Method bool QThread::wait(long unsigned time)

Public static methods and constants

QThread_PriorityHighPriorityEnum constant enum QThread::HighPriority
QThread_PriorityHighestPriorityEnum constant enum QThread::HighestPriority
QThread_PriorityIdlePriorityEnum constant enum QThread::IdlePriority
QThread_PriorityInheritPriorityEnum constant enum QThread::InheritPriority
QThread_PriorityLowPriorityEnum constant enum QThread::LowPriority
QThread_PriorityLowestPriorityEnum constant enum QThread::LowestPriority
QThread_PriorityNormalPriorityEnum constant enum QThread::NormalPriority
QThread_PriorityTimeCriticalPriorityEnum constant enum 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)Static method QString QThread::tr(const char *s, const char *c)
stringtr(string s,
string c)
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)Static method QString QThread::trUtf8(const char *s, const char *c)
stringtrUtf8(string s,
string c)
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)

[virtual]voidchildEvent(QChildEvent ptr arg1)Virtual method void QThread::childEvent(QChildEvent *)
[virtual]voidcustomEvent(QEvent ptr arg1)Virtual method void QThread::customEvent(QEvent *)
[virtual]voiddisconnectNotify(string signal)Virtual method void QThread::disconnectNotify(const char *signal)
intexecMethod int QThread::exec()
[const]intreceivers(string signal)Method int QThread::receivers(const char *signal)
[virtual]voidrunVirtual method void QThread::run()
[const]QObject ptrsenderMethod QObject * QThread::sender()
[virtual]voidtimerEvent(QTimerEvent ptr arg1)Virtual method void QThread::timerEvent(QTimerEvent *)

Detailed description

[static] QThread_Priority HighPriority

Description: Enum constant enum QThread::HighPriority

[static] QThread_Priority HighestPriority

Description: Enum constant enum QThread::HighestPriority

[static] QThread_Priority IdlePriority

Description: Enum constant enum QThread::IdlePriority

[static] QThread_Priority InheritPriority

Description: Enum constant enum QThread::InheritPriority

[static] QThread_Priority LowPriority

Description: Enum constant enum QThread::LowPriority

[static] QThread_Priority LowestPriority

Description: Enum constant enum QThread::LowestPriority

[static] QThread_Priority NormalPriority

Description: Enum constant enum QThread::NormalPriority

[static] QThread_Priority TimeCriticalPriority

Description: Enum constant enum QThread::TimeCriticalPriority

[virtual] void childEvent(QChildEvent ptr arg1)

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

This method can be reimplemented in a derived class.

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.

[static] QThread ptr currentThread

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

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

[static] unsigned long currentThreadId

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

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

[virtual] void customEvent(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

void destroy

Description: Explicitly destroy the object

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

[event] void destroyed(QObject ptr arg1)

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

You can bind a procedure to this signal.

[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.

[virtual] void disconnectNotify(string signal)

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

This method can be reimplemented in a derived class.

[virtual] bool event(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[virtual] 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.

int exec

Description: Method int QThread::exec()

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

void exit

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

void exit(int retcode)

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

[event] void finished

Description: Signal declaration for QThread::finished()

You can bind a procedure to this signal.

[static] int idealThreadCount

Description: Static method int QThread::idealThreadCount()

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

[const] bool isFinished

Description: Method bool QThread::isFinished()

[const] bool isFinished?

Description: Method bool QThread::isFinished()

[const] bool isRunning

Description: Method bool QThread::isRunning()

[const] bool isRunning?

Description: Method bool QThread::isRunning()

[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.

[static] new QThread new

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

This method creates an object of class QThread.

[static] new QThread new(QObject ptr parent)

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

This method creates an object of class QThread.

[const] QThread_Priority priority

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

void priority=(const QThread_Priority priority)

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

void quit

Description: Method void QThread::quit()

[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.

[virtual] void run

Description: Virtual method void QThread::run()

This method can be reimplemented in a derived class.

[const] QObject ptr sender

Description: Method QObject * QThread::sender()

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

void setPriority(const QThread_Priority priority)

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

void setStackSize(unsigned int stackSize)

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

[const] unsigned int stackSize

Description: Method int unsigned QThread::stackSize()

void stackSize=(unsigned int stackSize)

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

void start

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

void start(const QThread_Priority arg1)

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

[event] void started

Description: Signal declaration for QThread::started()

You can bind a procedure to this signal.

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

void terminate

Description: Method void QThread::terminate()

[event] void terminated

Description: Signal declaration for QThread::terminated()

You can bind a procedure to this signal.

[virtual] void timerEvent(QTimerEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[static] string tr(string s)

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

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

[static] string tr(string s,string c)

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

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

[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.

[static] string trUtf8(string s)

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

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

[static] string trUtf8(string s,string c)

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

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

[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.

bool wait

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

bool wait(unsigned long time)

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

[static] void yieldCurrentThread

Description: Static method void QThread::yieldCurrentThread()

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