#include <qthread.h>

Inherits QObject.

Inherited by AndroidTextureThread, AndroidTextureThread, EventReader, EventReader, FileInfoThread, QAdoptedThread, QCtfServer, QDirectFbInput, QDxgiVSyncThread, QDxgiVSyncThread, QEglFSKmsEventReaderThread, QFFmpeg::ConsumerThread, QFFmpegSurfaceCaptureGrabber::GrabbingThread, QFFmpegSurfaceCaptureGrabber::GrabbingThread, QFileInfoGatherer, QIntegrityHIDManager, QIntegrityHIDManager, QQmlDebugServerThread, QQmlDebugServerThread, QQmlThreadPrivate, QQmlThreadPrivate, QQnxMediaEventThread, QQnxScreenEventThread, QQuickContext2DRenderThread, QQuickPixmapReader, QQuickPixmapReader, QQuickWorkerScriptEngine, QSGRenderThread, QSGRenderThread, QSGSoftwareRenderThread, QSGSoftwareRenderThread, QShGetFileInfoThread, QShGetFileInfoThread, QThreadPoolThread, QThreadPoolThread, QWindowsCaRootFetcherThread, QWindowsCaRootFetcherThread, QWindowsDialogThread, QWindowsDialogThread, QWindowsFileSystemWatcherEngineThread, QWindowsShellExecuteThread, QWindowsShellExecuteThread, QXcbEventQueue, QtDocInstaller, QtWaylandClient::EventThread, QtWaylandClient::EventThread, StdInListener, ThreadedTestHTTPServer, WorkerThread, WorkerThread, WorkerThread, WorkerThread, fulltextsearch::QHelpSearchIndexReader, and fulltextsearch::QHelpSearchIndexWriter.

Collaboration diagram for QThread:

Public Types
enum	Priority { IdlePriority , LowestPriority , LowPriority , NormalPriority , HighPriority , HighestPriority , TimeCriticalPriority , InheritPriority }

enum class	QualityOfService { Auto , High , Eco }

Public Slots
void	start (Priority=InheritPriority)

void	terminate ()

void	exit (int retcode=0)

void	quit ()

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	started (QPrivateSignal)

void	finished (QPrivateSignal)

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
	QThread (QObject *parent=nullptr)

	~QThread ()

void	setPriority (Priority priority)

Priority	priority () const

bool	isFinished () const

bool	isRunning () const

void	requestInterruption ()

bool	isInterruptionRequested () const

void	setStackSize (uint stackSize)

uint	stackSize () const

QAbstractEventDispatcher *	eventDispatcher () const

void	setEventDispatcher (QAbstractEventDispatcher *eventDispatcher)

bool	event (QEvent *event) override
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

int	loopLevel () const

bool	isCurrentThread () const noexcept

void	setServiceLevel (QualityOfService serviceLevel)

QualityOfService	serviceLevel () const

bool	wait (QDeadlineTimer deadline=QDeadlineTimer(QDeadlineTimer::Forever))

bool	wait (unsigned long time)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. time is the time to wait in milliseconds.

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

void	killTimer (Qt::TimerId id)

template<typename T>
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T>
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T>
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename T>
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

bool	setProperty (const char *name, QVariant &&value)

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Static Public Member Functions
static Qt::HANDLE	currentThreadId () noexcept Q_DECL_PURE_FUNCTION

static QThread *	currentThread ()

static bool	isMainThread () noexcept

static int	idealThreadCount () noexcept

static void	yieldCurrentThread ()

template<typename Function, typename... Args>
static QThread *	create (Function &&f, Args &&... args)

static void	sleep (unsigned long)

static void	msleep (unsigned long)

static void	usleep (unsigned long)

static void	sleep (std::chrono::nanoseconds nsec)

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.

template<typename Func1, typename Func2>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Protected Member Functions
virtual void	run ()

int	exec ()

	QThread (QThreadPrivate &dd, QObject *parent=nullptr)

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Static Protected Member Functions
static void	setTerminationEnabled (bool enabled=true)

Friends
class	QEventLoopLocker

class	QCoreApplication

class	QThreadData

Additional Inherited Members
Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Properties inherited from QObject
QString	objectName
	the name of this object

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 27 of file qthread.h.

Member Enumeration Documentation

◆ Priority

enum QThread::Priority

Enumerator
IdlePriority
LowestPriority
LowPriority
NormalPriority
HighPriority
HighestPriority
TimeCriticalPriority
InheritPriority

Definition at line 40 of file qthread.h.

◆ QualityOfService

enum class QThread::QualityOfService

strong

Enumerator
Auto
High
Eco

Definition at line 54 of file qthread.h.

Constructor & Destructor Documentation

◆ QThread() [1/2]

QThread::QThread ( QObject * parent = nullptr )

explicit

Definition at line 1010 of file qthread.cpp.

◆ ~QThread()

QThread::~QThread ( )

Definition at line 1017 of file qthread.cpp.

◆ QThread() [2/2]

QThread::QThread	(	QThreadPrivate &	dd,
		QObject *	parent = nullptr )

protected

Definition at line 1150 of file qthread.cpp.

Member Function Documentation

◆ create()

template<typename Function, typename... Args>

QThread * QThread::create	(	Function &&	f,
		Args &&...	args )

staticnodiscard

Definition at line 132 of file qthread.h.

◆ currentThread()

QThread * QThread::currentThread ( )

static

Definition at line 1075 of file qthread.cpp.

◆ currentThreadId()

Qt::HANDLE QThread::currentThreadId ( )

inlinestaticnoexcept

Definition at line 159 of file qthread.h.

◆ event()

bool QThread::event ( QEvent * e )

overridevirtual

This virtual function receives events to an object and should return true if the event e was recognized and processed.

The event() function can be reimplemented to customize the behavior of an object.

Make sure you call the parent event class implementation for all the events you did not handle.

Example:

class MyClass : public QWidget
{
    Q_OBJECT
 
public:
    MyClass(QWidget *parent = nullptr);
    ~MyClass();
 
    bool event(QEvent* ev) override
    {
        if (ev->type() == QEvent::PolishRequest) {
            // overwrite handling of PolishRequest if any
            doThings();
            return true;
        } else  if (ev->type() == QEvent::Show) {
            // complement handling of Show if any
            doThings2();
            QWidget::event(ev);
            return true;
        }
        // Make sure the rest of events are handled
        return QWidget::event(ev);
    }
};

See also: installEventFilter(), timerEvent(), QCoreApplication::sendEvent(), QCoreApplication::postEvent()

Reimplemented from QObject.

Definition at line 1065 of file qthread.cpp.

◆ eventDispatcher()

QAbstractEventDispatcher * QThread::eventDispatcher ( ) const

Since: 5.0

Returns a pointer to the event dispatcher object for the thread. If no event dispatcher exists for the thread, this function returns \nullptr.

Definition at line 1186 of file qthread.cpp.

◆ exec()

int QThread::exec ( )

protected

Definition at line 1027 of file qthread.cpp.

◆ exit

void QThread::exit ( int retcode = 0 )

slot

Definition at line 1049 of file qthread.cpp.

◆ finished

void QThread::finished ( QPrivateSignal )

signal

◆ idealThreadCount()

int QThread::idealThreadCount ( )

staticnoexcept

Definition at line 1090 of file qthread.cpp.

◆ isCurrentThread()

bool QThread::isCurrentThread ( ) const

noexcept

Definition at line 1085 of file qthread.cpp.

◆ isFinished()

bool QThread::isFinished ( ) const

Definition at line 1100 of file qthread.cpp.

◆ isInterruptionRequested()

bool QThread::isInterruptionRequested ( ) const

Definition at line 1116 of file qthread.cpp.

◆ isMainThread()

bool QThread::isMainThread ( )

staticnoexcept

Definition at line 1080 of file qthread.cpp.

◆ isRunning()

bool QThread::isRunning ( ) const

Definition at line 1105 of file qthread.cpp.

◆ loopLevel()

int QThread::loopLevel ( ) const

◆ msleep()

void QThread::msleep ( unsigned long msecs )

static

Definition at line 595 of file qthread_unix.cpp.

◆ priority()

Priority QThread::priority ( ) const

◆ quit

void QThread::quit ( )

slot

Definition at line 1044 of file qthread.cpp.

◆ requestInterruption()

void QThread::requestInterruption ( )

Definition at line 1111 of file qthread.cpp.

◆ run()

void QThread::run ( void )

protectedvirtual

Reimplemented in EventReader, EventReader, FileInfoThread, fulltextsearch::QHelpSearchIndexReader, fulltextsearch::QHelpSearchIndexWriter, QCtfServer, QDirectFbInput, QDxgiVSyncThread, QDxgiVSyncThread, QEglFSKmsEventReaderThread, QFFmpeg::ConsumerThread, QFFmpegSurfaceCaptureGrabber::GrabbingThread, QFFmpegSurfaceCaptureGrabber::GrabbingThread, QFileInfoGatherer, QIntegrityHIDManager, QIntegrityHIDManager, QQmlDebugServerThread, QQmlDebugServerThread, QQnxMediaEventThread, QQnxScreenEventThread, QQuickPixmapReader, QQuickPixmapReader, QQuickWorkerScriptEngine, QSGRenderThread, QSGRenderThread, QSGSoftwareRenderThread, QSGSoftwareRenderThread, QShGetFileInfoThread, QShGetFileInfoThread, QtDocInstaller, QThreadPoolThread, QThreadPoolThread, QtWaylandClient::EventThread, QtWaylandClient::EventThread, QWindowsDialogThread, QWindowsDialogThread, QWindowsFileSystemWatcherEngineThread, QWindowsShellExecuteThread, QWindowsShellExecuteThread, QXcbEventQueue, StdInListener, ThreadedTestHTTPServer, WorkerThread, and WorkerThread.

Definition at line 1022 of file qthread.cpp.

◆ serviceLevel()

QualityOfService QThread::serviceLevel ( ) const

◆ setEventDispatcher()

void QThread::setEventDispatcher ( QAbstractEventDispatcher * eventDispatcher )

Since: 5.0

Sets the event dispatcher for the thread to eventDispatcher. This is only possible as long as there is no event dispatcher installed for the thread yet.

An event dispatcher is automatically created for the main thread when \l QCoreApplication is instantiated and on start() for auxiliary threads.

This method takes ownership of the object.

Definition at line 1204 of file qthread.cpp.

◆ setPriority()

void QThread::setPriority ( Priority priority )

◆ setServiceLevel()

void QThread::setServiceLevel ( QualityOfService serviceLevel )

◆ setStackSize()

void QThread::setStackSize ( uint stackSize )

Definition at line 1168 of file qthread.cpp.

◆ setTerminationEnabled()

void QThread::setTerminationEnabled ( bool enabled = true )

staticprotected

Definition at line 1121 of file qthread.cpp.

◆ sleep() [1/2]

void QThread::sleep ( std::chrono::nanoseconds nsec )

static

Definition at line 605 of file qthread_unix.cpp.

◆ sleep() [2/2]

void QThread::sleep ( unsigned long secs )

static

Definition at line 590 of file qthread_unix.cpp.

◆ stackSize()

uint QThread::stackSize ( ) const

Definition at line 1173 of file qthread.cpp.

◆ start

void QThread::start ( Priority priority = InheritPriority )

slot

Definition at line 1032 of file qthread.cpp.

◆ started

void QThread::started ( QPrivateSignal )

signal

◆ terminate

void QThread::terminate ( )

slot

Definition at line 1039 of file qthread.cpp.

◆ usleep()

void QThread::usleep ( unsigned long usecs )

static

Definition at line 600 of file qthread_unix.cpp.

◆ wait() [1/2]

bool QThread::wait ( QDeadlineTimer deadline = QDeadlineTimer(QDeadlineTimer::Forever) )

Definition at line 1059 of file qthread.cpp.

◆ wait() [2/2]

bool QThread::wait ( unsigned long time )

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. time is the time to wait in milliseconds.

If time is ULONG_MAX, then the wait will never timeout.

Definition at line 95 of file qthread.h.

◆ yieldCurrentThread()

void QThread::yieldCurrentThread ( )

static

Definition at line 1095 of file qthread.cpp.

Friends And Related Symbol Documentation

◆ QCoreApplication

friend class QCoreApplication

friend

Definition at line 127 of file qthread.h.

◆ QEventLoopLocker

friend class QEventLoopLocker

friend

Definition at line 122 of file qthread.h.

◆ QThreadData

friend class QThreadData

friend

Definition at line 128 of file qthread.h.

The documentation for this class was generated from the following files:

qtbase/src/corelib/thread/qthread.h (6013f82c94c12596670cf03efe451cdd3d5713be)
qtbase/src/corelib/thread/qthread.cpp (357351b7ab8ab2eee865d2449ffcca9c9f502fd3)
qtbase/src/corelib/thread/qthread_unix.cpp (39564261b213b22a7e170baf4528d125260b5436)
qtbase/src/corelib/thread/qthread_win.cpp (1da7558bfd7626bcc40a214a90ae5027f32f6c7f)

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Priority

◆ QualityOfService

Constructor & Destructor Documentation

◆ QThread() [1/2]

◆ ~QThread()

◆ QThread() [2/2]

Member Function Documentation

◆ create()

◆ currentThread()

◆ currentThreadId()

◆ event()

◆ eventDispatcher()

◆ exec()

◆ exit

◆ finished

◆ idealThreadCount()

◆ isCurrentThread()

◆ isFinished()

◆ isInterruptionRequested()

◆ isMainThread()

◆ isRunning()

◆ loopLevel()

◆ msleep()

◆ priority()

◆ quit

◆ requestInterruption()

◆ run()

◆ serviceLevel()

◆ setEventDispatcher()

◆ setPriority()

◆ setServiceLevel()

◆ setStackSize()

◆ setTerminationEnabled()

◆ sleep() [1/2]

◆ sleep() [2/2]

◆ stackSize()

◆ start

◆ started

◆ terminate

◆ usleep()

◆ wait() [1/2]

◆ wait() [2/2]

◆ yieldCurrentThread()

Friends And Related Symbol Documentation

◆ QCoreApplication

◆ QEventLoopLocker

◆ QThreadData