#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 ()
	\threadsafe

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)
	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
	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
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

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

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

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

Private Member Functions
virtual const QFutureInterfaceBase &	futureInterface () const =0

virtual QFutureInterfaceBase &	futureInterface ()=0

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)
	\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 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 18 of file qfuturewatcher.h.

Constructor & Destructor Documentation

◆ QFutureWatcherBase()

QFutureWatcherBase::QFutureWatcherBase ( QObject * parent = nullptr )

explicit

Definition at line 69 of file qfuturewatcher.cpp.

Member Function Documentation

◆ cancel

void QFutureWatcherBase::cancel ( )

slot

Definition at line 95 of file qfuturewatcher.cpp.

References futureInterface().

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:

if (signal == QMetaMethod::fromSignal(&MyObject::valueChanged)) {
    // signal is valueChanged
}

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. This function may also be called with a QObject internal mutex locked. It is therefore not allowed to re-enter any QObject functions, including isSignalConnected(), from your reimplementation. 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: connect(), disconnectNotify()

Reimplemented from QObject.

Definition at line 412 of file qfuturewatcher.cpp.

References d, finished(), QMetaMethod::fromSignal(), futureInterface(), isRunning(), qWarning, resultReadyAt(), and signal.

Here is the call graph for this function:

◆ connectOutputInterface()

void QFutureWatcherBase::connectOutputInterface ( )

protected

Definition at line 449 of file qfuturewatcher.cpp.

References futureInterface().

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 QObject functions, including isSignalConnected(), from your reimplementation. 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 430 of file qfuturewatcher.cpp.

References d, QMetaMethod::fromSignal(), resultReadyAt(), and signal.

Here is the call graph for this function:

◆ disconnectOutputInterface()

void QFutureWatcherBase::disconnectOutputInterface ( bool pendingAssignment = false )

protected

Definition at line 457 of file qfuturewatcher.cpp.

References d, and futureInterface().

Referenced by QFutureWatcher< T >::~QFutureWatcher().

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:

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 387 of file qfuturewatcher.cpp.

References d, QObject::event(), and QEvent::FutureCallOut.

Here is the call graph for this function:

◆ finished

void QFutureWatcherBase::finished ( )

signal

Referenced by connectNotify().

Here is the caller graph for this function:

◆ futureInterface() [1/2]

virtual const QFutureInterfaceBase & QFutureWatcherBase::futureInterface ( ) const

privatepure virtual

Implemented in QFutureWatcher< T >.

Referenced by cancel(), connectNotify(), connectOutputInterface(), disconnectOutputInterface(), isCanceled(), isFinished(), isRunning(), isStarted(), isSuspended(), isSuspending(), progressMaximum(), progressMinimum(), progressText(), progressValue(), resume(), setSuspended(), suspend(), toggleSuspended(), and waitForFinished().

Here is the caller graph for this function:

◆ futureInterface() [2/2]

virtual QFutureInterfaceBase & QFutureWatcherBase::futureInterface ( )

privatepure virtual

Implemented in QFutureWatcher< T >.

◆ isCanceled()

bool QFutureWatcherBase::isCanceled ( ) const

Definition at line 315 of file qfuturewatcher.cpp.

References QFutureInterfaceBase::Canceled, and futureInterface().

Here is the call graph for this function:

◆ isFinished()

bool QFutureWatcherBase::isFinished ( ) const

Definition at line 292 of file qfuturewatcher.cpp.

References futureInterface().

Here is the call graph for this function:

◆ isRunning()

bool QFutureWatcherBase::isRunning ( ) const

Definition at line 302 of file qfuturewatcher.cpp.

References futureInterface(), and QFutureInterfaceBase::Running.

Referenced by connectNotify().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isStarted()

bool QFutureWatcherBase::isStarted ( ) const

Definition at line 282 of file qfuturewatcher.cpp.

References futureInterface(), and QFutureInterfaceBase::Started.

Here is the call graph for this function:

◆ isSuspended()

bool QFutureWatcherBase::isSuspended ( ) const

Definition at line 372 of file qfuturewatcher.cpp.

References futureInterface().

Here is the call graph for this function:

◆ isSuspending()

bool QFutureWatcherBase::isSuspending ( ) const

Definition at line 357 of file qfuturewatcher.cpp.

References futureInterface().

Here is the call graph for this function:

◆ progressMaximum()

int QFutureWatcherBase::progressMaximum ( ) const

Definition at line 259 of file qfuturewatcher.cpp.

References futureInterface().

Here is the call graph for this function:

◆ progressMinimum()

int QFutureWatcherBase::progressMinimum ( ) const

Definition at line 248 of file qfuturewatcher.cpp.

References futureInterface().

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 272 of file qfuturewatcher.cpp.

References futureInterface().

Here is the call graph for this function:

◆ progressTextChanged

void QFutureWatcherBase::progressTextChanged ( const QString & progressText )

signal

◆ progressValue()

int QFutureWatcherBase::progressValue ( ) const

Definition at line 237 of file qfuturewatcher.cpp.

References futureInterface().

Here is the call graph for this function:

◆ progressValueChanged

void QFutureWatcherBase::progressValueChanged ( int progressValue )

signal

◆ resultReadyAt

void QFutureWatcherBase::resultReadyAt ( int resultIndex )

signal

Referenced by connectNotify(), and disconnectNotify().

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 191 of file qfuturewatcher.cpp.

References futureInterface().

Here is the call graph for this function:

◆ resumed

void QFutureWatcherBase::resumed ( )

signal

◆ setPendingResultsLimit()

void QFutureWatcherBase::setPendingResultsLimit ( int limit )

Definition at line 406 of file qfuturewatcher.cpp.

References d.

◆ setSuspended

void QFutureWatcherBase::setSuspended ( bool suspend )

slot

Definition at line 164 of file qfuturewatcher.cpp.

References futureInterface(), and suspend().

Here is the call graph for this function:

◆ started

void QFutureWatcherBase::started ( )

signal

◆ suspend

void QFutureWatcherBase::suspend ( )

slot

Definition at line 178 of file qfuturewatcher.cpp.

References futureInterface().

Referenced by setSuspended().

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 225 of file qfuturewatcher.cpp.

References futureInterface().

Here is the call graph for this function:

◆ waitForFinished()

void QFutureWatcherBase::waitForFinished ( )

Definition at line 382 of file qfuturewatcher.cpp.

References futureInterface().

Here is the call graph for this function:

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

qtbase/src/corelib/thread/qfuturewatcher.h (05fc3aef53348fb58be6308076e000825b704e58)
qtbase/src/corelib/thread/qfuturewatcher.cpp (b667d19641ea3c2b5bf47cffdc25445b51af3a3b)

Public Slots

Signals

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QFutureWatcherBase()

Member Function Documentation

◆ cancel

◆ canceled

◆ connectNotify()

◆ connectOutputInterface()

◆ disconnectNotify()

◆ disconnectOutputInterface()

◆ event()

◆ finished

◆ futureInterface() [1/2]

◆ futureInterface() [2/2]

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