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

Sub-classes: Priority

• Public constructors
• Public methods
• Public static methods and constants
• Protected methods (static, non-static and constructors)
• Deprecated methods (protected, public, static, non-static and constructors)
• Detailed description

Public constructors

Public methods

Public static methods and constants

Protected methods (static, non-static and constructors)

Deprecated methods (protected, public, static, non-static and constructors)

Detailed description

[static,const] new QThread_Priority ptr HighPriority

Description: Enum constant QThread::HighPriority

[static,const] new QThread_Priority ptr HighestPriority

Description: Enum constant QThread::HighestPriority

[static,const] new QThread_Priority ptr IdlePriority

Description: Enum constant QThread::IdlePriority

[static,const] new QThread_Priority ptr InheritPriority

Description: Enum constant QThread::InheritPriority

[static,const] new QThread_Priority ptr LowPriority

Description: Enum constant QThread::LowPriority

[static,const] new QThread_Priority ptr LowestPriority

Description: Enum constant QThread::LowestPriority

[static,const] new QThread_Priority ptr NormalPriority

Description: Enum constant QThread::NormalPriority

[static,const] new QThread_Priority ptr TimeCriticalPriority

Description: Enum constant QThread::TimeCriticalPriority

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.

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.

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

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

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.

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.

[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 of this method is deprecated. Use _create instead

[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 destroys the object

Use of this method is deprecated. Use _destroy instead

[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

Use of this method is deprecated. Use _destroyed? instead

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

Python specific notes:

This method is available as method 'exec_' in Python

void exit(int retcode = 0)

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 isRunning?

Description: Method bool QThread::isRunning()

[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

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

[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

[const] QThread_Priority priority

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

Python specific notes:

The object exposes a readable attribute 'priority'. This is the getter.

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.

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)

Python specific notes:

The object exposes a writable attribute 'priority'. This is the setter.

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.

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

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

[const] unsigned int stackSize

Description: Method unsigned int QThread::stackSize()

Python specific notes:

The object exposes a readable attribute 'stackSize'. This is the getter.

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.

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

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

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

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

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

bool wait(unsigned long time = ULONG_MAX)

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

[static] void yieldCurrentThread

Description: Static method void QThread::yieldCurrentThread()

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