Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QFuture< T > Class Template Reference

#include <qfuture.h>

Collaboration diagram for QFuture< T >:

Classes

class  const_iterator

Public Types

template<class Function>
using ResultType = typename QtPrivate::ResultTypeHelper<Function, T>::ResultType
typedef const_iterator ConstIterator

Public Member Functions

 QFuture ()
template<typename U = T, typename = QtPrivate::EnableForNonVoid<U>>
 QFuture (QFutureInterface< T > *p)
template<typename U = T, typename = QtPrivate::EnableForVoid<U>>
 QFuture (QFutureInterfaceBase *p)
template<typename U, typename V = T, typename = QtPrivate::EnableForVoid<V>>
 QFuture (const QFuture< U > &other)
template<typename U, typename V = T, typename = QtPrivate::EnableForVoid<V>>
QFuture< void > & operator= (const QFuture< U > &other)
void cancel ()
bool isCanceled () const
void cancelChain ()
bool isSuspending () const
bool isSuspended () const
void setSuspended (bool suspend)
void suspend ()
void resume ()
void toggleSuspended ()
bool isStarted () const
bool isFinished () const
bool isRunning () const
int resultCount () const
int progressValue () const
int progressMinimum () const
int progressMaximum () const
QString progressText () const
void waitForFinished ()
template<typename U = T, typename = QtPrivate::EnableForNonVoid<U>>
result () const
template<typename U = T, typename = QtPrivate::EnableForNonVoid<U>>
resultAt (int index) const
template<typename U = T, typename = QtPrivate::EnableForNonVoid<U>>
bool isResultReadyAt (int resultIndex) const
template<typename U = T, typename = QtPrivate::EnableForNonVoid<U>>
QList< T > results () const
template<typename U = T, typename = QtPrivate::EnableForNonVoid<U>>
takeResult ()
bool isValid () const
template<class Function>
QFuture< ResultType< Function > > then (Function &&function)
template<class Function>
QFuture< ResultType< Function > > then (QtFuture::Launch policy, Function &&function)
template<class Function>
QFuture< ResultType< Function > > then (QThreadPool *pool, Function &&function)
template<class Function>
QFuture< ResultType< Function > > then (QObject *context, Function &&function)
template<class Function, typename = std::enable_if_t<!QtPrivate::ArgResolver<Function>::HasExtraArgs>>
QFuture< T > onFailed (Function &&handler)
template<class Function, typename = std::enable_if_t<!QtPrivate::ArgResolver<Function>::HasExtraArgs>>
QFuture< T > onFailed (QObject *context, Function &&handler)
template<class Function, typename = std::enable_if_t<std::is_invocable_r_v<T, Function>>>
QFuture< T > onCanceled (Function &&handler)
template<class Function, typename = std::enable_if_t<std::is_invocable_r_v<T, Function>>>
QFuture< T > onCanceled (QObject *context, Function &&handler)
template<class U = T, typename = std::enable_if_t<QtPrivate::isQFutureV<U>>>
auto unwrap ()
template<class U = T, typename = QtPrivate::EnableForNonVoid<U>>
const_iterator begin () const
template<class U = T, typename = QtPrivate::EnableForNonVoid<U>>
const_iterator constBegin () const
template<class U = T, typename = QtPrivate::EnableForNonVoid<U>>
const_iterator end () const
template<class U = T, typename = QtPrivate::EnableForNonVoid<U>>
const_iterator constEnd () const
template<class Function>
QFuture< typename QFuture< T >::template ResultType< Function > > then (Function &&function)
template<class Function>
QFuture< typename QFuture< T >::template ResultType< Function > > then (QtFuture::Launch policy, Function &&function)
template<class Function>
QFuture< typename QFuture< T >::template ResultType< Function > > then (QThreadPool *pool, Function &&function)
template<class Function>
QFuture< typename QFuture< T >::template ResultType< Function > > then (QObject *context, Function &&function)

Friends

class const_iterator
class QFutureWatcher< T >
template<class U>
class QFuture
class QFutureInterfaceBase
template<class Function, class ResultType, class ParentResultType>
class QtPrivate::CompactContinuation
template<class Function, class ResultType>
class QtPrivate::CanceledHandler
template<class Function, class ResultType>
class QtPrivate::FailureHandler
template<typename ResultType>
struct QtPrivate::WhenAnyContext
struct QtPrivate::UnwrapHandler

Detailed Description

template<typename T>
class QFuture< T >

Definition at line 26 of file qfuture.h.

Member Typedef Documentation

◆ ConstIterator

template<typename T>
typedef const_iterator QFuture< T >::ConstIterator

Definition at line 262 of file qfuture.h.

◆ ResultType

template<typename T>
template<class Function>
using QFuture< T >::ResultType = typename QtPrivate::ResultTypeHelper<Function, T>::ResultType

Definition at line 130 of file qfuture.h.

Constructor & Destructor Documentation

◆ QFuture() [1/4]

template<typename T>
QFuture< T >::QFuture ( )
inline

Definition at line 32 of file qfuture.h.

References QFuture().

Referenced by QFuture().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ QFuture() [2/4]

template<typename T>
template<typename U = T, typename = QtPrivate::EnableForNonVoid<U>>
QFuture< T >::QFuture ( QFutureInterface< T > * p)
inlineexplicit

Definition at line 37 of file qfuture.h.

◆ QFuture() [3/4]

template<typename T>
template<typename U = T, typename = QtPrivate::EnableForVoid<U>>
QFuture< T >::QFuture ( QFutureInterfaceBase * p)
inlineexplicit

Definition at line 42 of file qfuture.h.

◆ QFuture() [4/4]

template<typename T>
template<typename U, typename V = T, typename = QtPrivate::EnableForVoid<V>>
QFuture< T >::QFuture ( const QFuture< U > & other)
inline

Definition at line 48 of file qfuture.h.

Member Function Documentation

◆ begin()

template<typename T>
template<class U = T, typename = QtPrivate::EnableForNonVoid<U>>
const_iterator QFuture< T >::begin ( ) const
inline

Definition at line 265 of file qfuture.h.

◆ cancel()

template<typename T>
void QFuture< T >::cancel ( )
inline

Definition at line 65 of file qfuture.h.

◆ cancelChain()

template<typename T>
void QFuture< T >::cancelChain ( )
inline

Definition at line 67 of file qfuture.h.

◆ constBegin()

template<typename T>
template<class U = T, typename = QtPrivate::EnableForNonVoid<U>>
const_iterator QFuture< T >::constBegin ( ) const
inline

Definition at line 268 of file qfuture.h.

◆ constEnd()

template<typename T>
template<class U = T, typename = QtPrivate::EnableForNonVoid<U>>
const_iterator QFuture< T >::constEnd ( ) const
inline

Definition at line 274 of file qfuture.h.

◆ end()

template<typename T>
template<class U = T, typename = QtPrivate::EnableForNonVoid<U>>
const_iterator QFuture< T >::end ( ) const
inline

Definition at line 271 of file qfuture.h.

◆ isCanceled()

template<typename T>
bool QFuture< T >::isCanceled ( ) const
inline

Definition at line 66 of file qfuture.h.

◆ isFinished()

template<typename T>
bool QFuture< T >::isFinished ( ) const
inline

Definition at line 96 of file qfuture.h.

◆ isResultReadyAt()

template<typename T>
template<typename U = T, typename = QtPrivate::EnableForNonVoid<U>>
bool QFuture< T >::isResultReadyAt ( int resultIndex) const
inline

Definition at line 113 of file qfuture.h.

◆ isRunning()

template<typename T>
bool QFuture< T >::isRunning ( ) const
inline

Definition at line 97 of file qfuture.h.

◆ isStarted()

template<typename T>
bool QFuture< T >::isStarted ( ) const
inline

Definition at line 95 of file qfuture.h.

◆ isSuspended()

template<typename T>
bool QFuture< T >::isSuspended ( ) const
inline

Definition at line 89 of file qfuture.h.

◆ isSuspending()

template<typename T>
bool QFuture< T >::isSuspending ( ) const
inline

Definition at line 88 of file qfuture.h.

◆ isValid()

template<typename T>
bool QFuture< T >::isValid ( ) const
inline

Definition at line 127 of file qfuture.h.

◆ onCanceled() [1/2]

template<class T>
template<class Function, typename>
QFuture< T > QFuture< T >::onCanceled ( Function && handler)

Definition at line 396 of file qfuture.h.

◆ onCanceled() [2/2]

template<class T>
template<class Function, typename>
QFuture< T > QFuture< T >::onCanceled ( QObject * context,
Function && handler )

Definition at line 406 of file qfuture.h.

◆ onFailed() [1/2]

template<class T>
template<class Function, typename>
QFuture< T > QFuture< T >::onFailed ( Function && handler)

Definition at line 374 of file qfuture.h.

◆ onFailed() [2/2]

template<class T>
template<class Function, typename>
QFuture< T > QFuture< T >::onFailed ( QObject * context,
Function && handler )

Definition at line 384 of file qfuture.h.

◆ operator=()

template<typename T>
template<typename U, typename V = T, typename = QtPrivate::EnableForVoid<V>>
QFuture< void > & QFuture< T >::operator= ( const QFuture< U > & other)
inline

Definition at line 53 of file qfuture.h.

◆ progressMaximum()

template<typename T>
int QFuture< T >::progressMaximum ( ) const
inline

Definition at line 102 of file qfuture.h.

◆ progressMinimum()

template<typename T>
int QFuture< T >::progressMinimum ( ) const
inline

Definition at line 101 of file qfuture.h.

◆ progressText()

template<typename T>
QString QFuture< T >::progressText ( ) const
inline

Definition at line 103 of file qfuture.h.

◆ progressValue()

template<typename T>
int QFuture< T >::progressValue ( ) const
inline

Definition at line 100 of file qfuture.h.

◆ result()

template<typename T>
template<typename U, typename>
T QFuture< T >::result ( ) const
inline

Definition at line 311 of file qfuture.h.

◆ resultAt()

template<typename T>
template<typename U, typename>
T QFuture< T >::resultAt ( int index) const
inline

Definition at line 319 of file qfuture.h.

◆ resultCount()

template<typename T>
int QFuture< T >::resultCount ( ) const
inline

Definition at line 99 of file qfuture.h.

◆ results()

template<typename T>
template<typename U = T, typename = QtPrivate::EnableForNonVoid<U>>
QList< T > QFuture< T >::results ( ) const
inline

Definition at line 116 of file qfuture.h.

◆ resume()

template<typename T>
void QFuture< T >::resume ( )
inline

Definition at line 92 of file qfuture.h.

◆ setSuspended()

template<typename T>
void QFuture< T >::setSuspended ( bool suspend)
inline

Definition at line 90 of file qfuture.h.

◆ suspend()

template<typename T>
void QFuture< T >::suspend ( )
inline

Definition at line 91 of file qfuture.h.

◆ takeResult()

template<typename T>
template<typename U = T, typename = QtPrivate::EnableForNonVoid<U>>
T QFuture< T >::takeResult ( )
inline

Definition at line 119 of file qfuture.h.

◆ then() [1/8]

template<typename T>
template<class Function>
QFuture< ResultType< Function > > QFuture< T >::then ( Function && function)

◆ then() [2/8]

template<typename T>
template<class Function>
QFuture< typename QFuture< T >::template ResultType< Function > > QFuture< T >::then ( Function && function)

Definition at line 333 of file qfuture.h.

◆ then() [3/8]

template<typename T>
template<class Function>
QFuture< ResultType< Function > > QFuture< T >::then ( QObject * context,
Function && function )

◆ then() [4/8]

template<typename T>
template<class Function>
QFuture< typename QFuture< T >::template ResultType< Function > > QFuture< T >::then ( QObject * context,
Function && function )

Definition at line 362 of file qfuture.h.

◆ then() [5/8]

template<typename T>
template<class Function>
QFuture< ResultType< Function > > QFuture< T >::then ( QtFuture::Launch policy,
Function && function )

◆ then() [6/8]

template<typename T>
template<class Function>
QFuture< typename QFuture< T >::template ResultType< Function > > QFuture< T >::then ( QtFuture::Launch policy,
Function && function )

Definition at line 341 of file qfuture.h.

◆ then() [7/8]

template<typename T>
template<class Function>
QFuture< ResultType< Function > > QFuture< T >::then ( QThreadPool * pool,
Function && function )

◆ then() [8/8]

template<typename T>
template<class Function>
QFuture< typename QFuture< T >::template ResultType< Function > > QFuture< T >::then ( QThreadPool * pool,
Function && function )

Definition at line 351 of file qfuture.h.

◆ toggleSuspended()

template<typename T>
void QFuture< T >::toggleSuspended ( )
inline

Definition at line 93 of file qfuture.h.

◆ unwrap()

template<class T>
template<class U, typename>
auto QFuture< T >::unwrap ( )

Definition at line 416 of file qfuture.h.

◆ waitForFinished()

template<typename T>
void QFuture< T >::waitForFinished ( )
inline

Definition at line 104 of file qfuture.h.

◆ QFuture

template<typename T>
template<class U>
friend class QFuture
friend

Definition at line 280 of file qfuture.h.

◆ const_iterator

template<typename T>
friend class const_iterator
friend

Definition at line 261 of file qfuture.h.

◆ QFutureInterfaceBase

template<typename T>
friend class QFutureInterfaceBase
friend

Definition at line 282 of file qfuture.h.

◆ QFutureWatcher< T >

template<typename T>
friend class QFutureWatcher< T >
friend

Definition at line 274 of file qfuture.h.

◆ QtPrivate::CanceledHandler

template<typename T>
template<class Function, class ResultType>
friend class QtPrivate::CanceledHandler
friend

Definition at line 288 of file qfuture.h.

◆ QtPrivate::CompactContinuation

template<typename T>
template<class Function, class ResultType, class ParentResultType>
friend class QtPrivate::CompactContinuation
friend

Definition at line 285 of file qfuture.h.

◆ QtPrivate::FailureHandler

template<typename T>
template<class Function, class ResultType>
friend class QtPrivate::FailureHandler
friend

Definition at line 292 of file qfuture.h.

◆ QtPrivate::UnwrapHandler

template<typename T>
friend struct QtPrivate::UnwrapHandler
friend

Definition at line 298 of file qfuture.h.

◆ QtPrivate::WhenAnyContext

template<typename T>
template<typename ResultType>
friend struct QtPrivate::WhenAnyContext
friend

Definition at line 296 of file qfuture.h.


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