#include <qfuturewatcher.h>

Inheritance diagram for QFutureWatcherBase:

Collaboration diagram for QFutureWatcherBase:

Public Slots
void	cancel ()

void	setSuspended (bool suspend)

void	suspend ()

void	resume ()

void	toggleSuspended ()

Public Slots inherited from QObject
void	deleteLater ()

Signals
void	started ()

void	finished ()

void	canceled ()

void	suspending ()

void	suspended ()

void	resumed ()

void	resultReadyAt (int resultIndex)

void	resultsReadyAt (int beginIndex, int endIndex)

void	progressRangeChanged (int minimum, int maximum)

void	progressValueChanged (int progressValue)

void	progressTextChanged (const QString &progressText)

Signals inherited from QObject
void	destroyed (QObject *=nullptr)

void	objectNameChanged (const QString &objectName, QPrivateSignal)

Public Member Functions
	QFutureWatcherBase (QObject *parent=nullptr)

int	progressValue () const

int	progressMinimum () const

int	progressMaximum () const

QString	progressText () const

bool	isStarted () const

bool	isFinished () const

bool	isRunning () const

bool	isCanceled () const

bool	isSuspending () const

bool	isSuspended () const

void	waitForFinished ()

void	setPendingResultsLimit (int limit)

bool	event (QEvent *event) override

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)

virtual	~QObject ()

virtual bool	eventFilter (QObject watched, QEvent event)

QString	objectName () const

void	setObjectName (const QString &name)

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const

bool	isWindowType () const

bool	signalsBlocked () const noexcept

bool	blockSignals (bool b) noexcept

QThread *	thread () const

void	moveToThread (QThread *thread)

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)

template<typename T >
T	findChild (const QString &aName=QString(), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

template<typename T >
QList< T >	findChildren (const QString &aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

const QObjectList &	children () const

void	setParent (QObject *parent)

void	installEventFilter (QObject *filterObj)

void	removeEventFilter (QObject *obj)

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

void	dumpObjectInfo () const

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

QVariant	property (const char *name) const

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const

bool	inherits (const char *classname) const

Protected Member Functions
void	connectNotify (const QMetaMethod &signal) override

void	disconnectNotify (const QMetaMethod &signal) override

void	connectOutputInterface ()

void	disconnectOutputInterface (bool pendingAssignment=false)

Protected Member Functions inherited from QObject
QObject *	sender () const

int	senderSignalIndex () const

int	receivers (const char *signal) const

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)

virtual void	childEvent (QChildEvent *event)

virtual void	customEvent (QEvent *event)

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

Additional Inherited Members
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)

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::FunctionPointer< Func2 >::Object receiver, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

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

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

template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)

template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

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

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

static bool	disconnect (const QMetaObject::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 Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Properties inherited from QObject
QString	objectName
	the name of this object More...

Related Functions inherited from QObject
template< class T > T	qobject_cast (const QObject *object)

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

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

	QObjectList

Detailed Description

Definition at line 54 of file qfuturewatcher.h.

Constructor & Destructor Documentation

◆ QFutureWatcherBase()

QFutureWatcherBase::QFutureWatcherBase ( QObject * parent = nullptr )

explicit

Definition at line 105 of file qfuturewatcher.cpp.

Member Function Documentation

◆ cancel

void QFutureWatcherBase::cancel ( )

slot

Definition at line 131 of file qfuturewatcher.cpp.

Here is the call graph for this function:

◆ canceled

void QFutureWatcherBase::canceled ( )

signal

◆ connectNotify()

void QFutureWatcherBase::connectNotify ( const QMetaMethod & signal )

overrideprotectedvirtual

Since: 5.0

This virtual function is called when something has been connected to signal in this object.

If you want to compare signal with a specific signal, you can use QMetaMethod::fromSignal() as follows:

Warning: This function violates the object-oriented principle of modularity. However, it might be useful when you need to perform expensive initialization only if something is connected to a signal.; This function is called from the thread which performs the connection, which may be a different thread from the thread in which this object lives.

See also: connect(), disconnectNotify()

Reimplemented from QObject.

Definition at line 448 of file qfuturewatcher.cpp.

Here is the call graph for this function:

◆ connectOutputInterface()

void QFutureWatcherBase::connectOutputInterface ( )

protected

Definition at line 485 of file qfuturewatcher.cpp.

Here is the call graph for this function:

◆ disconnectNotify()

void QFutureWatcherBase::disconnectNotify ( const QMetaMethod & signal )

overrideprotectedvirtual

Since: 5.0

This virtual function is called when something has been disconnected from signal in this object.

See connectNotify() for an example of how to compare signal with a specific signal.

If all signals were disconnected from this object (e.g., the signal argument to disconnect() was \nullptr), disconnectNotify() is only called once, and the signal will be an invalid QMetaMethod (QMetaMethod::isValid() returns false).

Warning: This function violates the object-oriented principle of modularity. However, it might be useful for optimizing access to expensive resources.; This function is called from the thread which performs the disconnection, which may be a different thread from the thread in which this object lives. This function may also be called with a QObject internal mutex locked. It is therefore not allowed to re-enter any of any QObject functions from your reimplementation and if you lock a mutex in your reimplementation, make sure that you don't call QObject functions with that mutex held in other places or it will result in a deadlock.

See also: disconnect(), connectNotify()

Reimplemented from QObject.

Definition at line 466 of file qfuturewatcher.cpp.

Here is the call graph for this function:

◆ disconnectOutputInterface()

void QFutureWatcherBase::disconnectOutputInterface ( bool pendingAssignment = false )

protected

Definition at line 493 of file qfuturewatcher.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ event()

bool QFutureWatcherBase::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:

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

Reimplemented from QObject.

Definition at line 423 of file qfuturewatcher.cpp.

Here is the call graph for this function:

◆ finished

void QFutureWatcherBase::finished ( )

signal

Here is the caller graph for this function:

◆ isCanceled()

bool QFutureWatcherBase::isCanceled ( ) const

Definition at line 351 of file qfuturewatcher.cpp.

Here is the call graph for this function:

◆ isFinished()

bool QFutureWatcherBase::isFinished ( ) const

Definition at line 328 of file qfuturewatcher.cpp.

Here is the call graph for this function:

◆ isRunning()

bool QFutureWatcherBase::isRunning ( ) const

Definition at line 338 of file qfuturewatcher.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isStarted()

bool QFutureWatcherBase::isStarted ( ) const

Definition at line 318 of file qfuturewatcher.cpp.

Here is the call graph for this function:

◆ isSuspended()

bool QFutureWatcherBase::isSuspended ( ) const

Definition at line 408 of file qfuturewatcher.cpp.

Here is the call graph for this function:

◆ isSuspending()

bool QFutureWatcherBase::isSuspending ( ) const

Definition at line 393 of file qfuturewatcher.cpp.

Here is the call graph for this function:

◆ progressMaximum()

int QFutureWatcherBase::progressMaximum ( ) const

Definition at line 295 of file qfuturewatcher.cpp.

Here is the call graph for this function:

◆ progressMinimum()

int QFutureWatcherBase::progressMinimum ( ) const

Definition at line 284 of file qfuturewatcher.cpp.

Here is the call graph for this function:

◆ progressRangeChanged

void QFutureWatcherBase::progressRangeChanged	(	int	minimum,
		int	maximum
	)

signal

◆ progressText()

QString QFutureWatcherBase::progressText ( ) const

Definition at line 308 of file qfuturewatcher.cpp.

Here is the call graph for this function:

◆ progressTextChanged

void QFutureWatcherBase::progressTextChanged ( const QString & progressText )

signal

◆ progressValue()

int QFutureWatcherBase::progressValue ( ) const

Definition at line 273 of file qfuturewatcher.cpp.

Here is the call graph for this function:

◆ progressValueChanged

void QFutureWatcherBase::progressValueChanged ( int progressValue )

signal

◆ resultReadyAt

void QFutureWatcherBase::resultReadyAt ( int resultIndex )

signal

Here is the caller graph for this function:

◆ resultsReadyAt

void QFutureWatcherBase::resultsReadyAt	(	int	beginIndex,
		int	endIndex
	)

signal

◆ resume

void QFutureWatcherBase::resume ( )

slot

Definition at line 227 of file qfuturewatcher.cpp.

Here is the call graph for this function:

◆ resumed

void QFutureWatcherBase::resumed ( )

signal

◆ setPendingResultsLimit()

void QFutureWatcherBase::setPendingResultsLimit ( int limit )

Definition at line 442 of file qfuturewatcher.cpp.

◆ setSuspended

void QFutureWatcherBase::setSuspended ( bool suspend )

slot

Definition at line 200 of file qfuturewatcher.cpp.

Here is the call graph for this function:

◆ started

void QFutureWatcherBase::started ( )

signal

◆ suspend

void QFutureWatcherBase::suspend ( )

slot

Definition at line 214 of file qfuturewatcher.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ suspended

void QFutureWatcherBase::suspended ( )

signal

◆ suspending

void QFutureWatcherBase::suspending ( )

signal

◆ toggleSuspended

void QFutureWatcherBase::toggleSuspended ( )

slot

Definition at line 261 of file qfuturewatcher.cpp.

Here is the call graph for this function:

◆ waitForFinished()

void QFutureWatcherBase::waitForFinished ( )

Definition at line 418 of file qfuturewatcher.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

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

src/corelib/thread/qfuturewatcher.h
src/corelib/thread/qfuturewatcher.cpp

Public Slots

Signals

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QFutureWatcherBase()

Member Function Documentation

◆ cancel

◆ canceled

◆ connectNotify()

◆ connectOutputInterface()

◆ disconnectNotify()

◆ disconnectOutputInterface()

◆ event()

◆ finished

◆ isCanceled()

◆ isFinished()

◆ isRunning()

◆ isStarted()

◆ isSuspended()

◆ isSuspending()

◆ progressMaximum()

◆ progressMinimum()

◆ progressRangeChanged

◆ progressText()

◆ progressTextChanged

◆ progressValue()

◆ progressValueChanged

◆ resultReadyAt

◆ resultsReadyAt

◆ resume

◆ resumed

◆ setPendingResultsLimit()

◆ setSuspended

◆ started

◆ suspend

◆ suspended

◆ suspending

◆ toggleSuspended

◆ waitForFinished()