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
QFutureInterface< void > Class Reference

#include <qfutureinterface.h>

Inheritance diagram for QFutureInterface< void >:
Collaboration diagram for QFutureInterface< void >:

Public Member Functions

 QFutureInterface (State initialState=NoState)
 QFutureInterface (const QFutureInterfaceBase &dd)
QFuture< void > future ()
bool reportResult (const void *, int)
bool reportResults (const QList< void > &, int)
bool reportFinished (const void *)
void reportFinished ()
QFutureInterface & operator= (const QFutureInterface &other)
 ~QFutureInterface ()
bool reportAndEmplaceResult (int index, Args &&...args)
bool reportAndMoveResult (void &&result, int index=-1)
const void & resultReference (int index) const
const void * resultPointer (int index) const
QList< void > results ()
void takeResult ()
void reportException (const std::exception_ptr &e)
Public Member Functions inherited from QFutureInterfaceBase
 QFutureInterfaceBase (State initialState=NoState)
 QFutureInterfaceBase (const QFutureInterfaceBase &other)
 QFutureInterfaceBase (QFutureInterfaceBase &&other) noexcept
QFutureInterfaceBase & operator= (const QFutureInterfaceBase &other)
virtual ~QFutureInterfaceBase ()
void reportStarted ()
void reportFinished ()
void reportCanceled ()
void reportException (const QException &e)
void reportException (const std::exception_ptr &e)
void reportResultsReady (int beginIndex, int endIndex)
void setRunnable (QRunnable *runnable)
void setThreadPool (QThreadPool *pool)
QThreadPool * threadPool () const
void setFilterMode (bool enable)
void setProgressRange (int minimum, int maximum)
int progressMinimum () const
int progressMaximum () const
bool isProgressUpdateNeeded () const
void setProgressValue (int progressValue)
int progressValue () const
void setProgressValueAndText (int progressValue, const QString &progressText)
QString progressText () const
void setExpectedResultCount (int resultCount)
int expectedResultCount ()
int resultCount () const
bool queryState (State state) const
bool isRunning () const
bool isStarted () const
bool isCanceled () const
bool isFinished () const
bool isSuspending () const
bool isSuspended () const
bool isThrottled () const
bool isResultReadyAt (int index) const
bool isValid () const
int loadState () const
void cancel ()
void cancelAndFinish ()
void cancelChain ()
void setAddResultsIfCanceledEnabled (bool enable)
bool isAddResultsIfCanceledEnabled () const
void setSuspended (bool suspend)
void toggleSuspended ()
void reportSuspended () const
void setThrottled (bool enable)
void waitForFinished ()
bool waitForNextResult ()
void waitForResult (int resultIndex)
void waitForResume ()
void suspendIfRequested ()
QMutex & mutex () const
bool hasException () const
QtPrivate::ExceptionStore & exceptionStore ()
QtPrivate::ResultStoreBase & resultStoreBase ()
const QtPrivate::ResultStoreBase & resultStoreBase () const
bool operator== (const QFutureInterfaceBase &other) const
bool operator!= (const QFutureInterfaceBase &other) const
void swap (QFutureInterfaceBase &other) noexcept
bool isChainCanceled () const

Static Public Member Functions

static QFutureInterface< void > canceledResult ()
Static Public Member Functions inherited from QFutureInterfaceBase
template<typename T>
static QFutureInterfaceBase get (const QFuture< T > &future)

Additional Inherited Members

Public Types inherited from QFutureInterfaceBase
enum  State {
  NoState = 0x00 , Running = 0x01 , Started = 0x02 , Finished = 0x04 ,
  Canceled = 0x08 , Suspending = 0x10 , Suspended = 0x20 , Throttled = 0x40 ,
  Pending = 0x80
}
Protected Types inherited from QFutureInterfaceBase
enum class  ContinuationType : quint8 { Unknown , Then , OnFailed , OnCanceled }
enum class  CancelMode { CancelOnly , CancelAndFinish }
Protected Member Functions inherited from QFutureInterfaceBase
bool refT () const noexcept
bool derefT () const noexcept
void reset ()
void rethrowPossibleException ()
void setContinuation (std::function< void(const QFutureInterfaceBase &)> func, void *continuationFutureData, ContinuationType type)
void setContinuation (const QObject *context, std::function< void()> func, const QVariant &continuationFuture, ContinuationType type)
void cleanContinuation ()
void runContinuation () const
void setLaunchAsync (bool value)
bool launchAsync () const
bool isRunningOrPending () const
void cancel (CancelMode mode)
void cancelChain (CancelMode mode)

Detailed Description

Definition at line 499 of file qfutureinterface.h.

Constructor & Destructor Documentation

◆ QFutureInterface() [1/2]

QFutureInterface< void >::QFutureInterface ( State initialState = NoState)
inlineexplicit

Definition at line 502 of file qfutureinterface.h.

◆ QFutureInterface() [2/2]

QFutureInterface< void >::QFutureInterface ( const QFutureInterfaceBase & dd)
inline

Definition at line 506 of file qfutureinterface.h.

◆ ~QFutureInterface()

QFutureInterface< void >::~QFutureInterface ( )
inline

Definition at line 265 of file qfutureinterface.h.

Member Function Documentation

◆ canceledResult()

QFutureInterface< void > QFutureInterface< void >::canceledResult ( )
inlinestatic

Definition at line 508 of file qfutureinterface.h.

◆ future()

QFuture< void > QFutureInterface< void >::future ( )
inline

Definition at line 424 of file qfuture.h.

◆ operator=()

QFutureInterface & QFutureInterface< void >::operator= ( const QFutureInterface< void > & other)
inline

Definition at line 256 of file qfutureinterface.h.

◆ reportAndEmplaceResult()

bool QFutureInterface< void >::reportAndEmplaceResult ( int index,
Args &&... args )
inline

Definition at line 277 of file qfutureinterface.h.

◆ reportAndMoveResult()

bool QFutureInterface< void >::reportAndMoveResult ( void && result,
int index = -1 )
inline

Definition at line 279 of file qfutureinterface.h.

◆ reportException()

void QFutureInterface< void >::reportException ( const std::exception_ptr & e)
inline

Definition at line 301 of file qfutureinterface.h.

◆ reportFinished() [1/2]

void QFutureInterface< void >::reportFinished ( )
inline

Definition at line 521 of file qfutureinterface.h.

◆ reportFinished() [2/2]

bool QFutureInterface< void >::reportFinished ( const void * )
inline

Definition at line 516 of file qfutureinterface.h.

◆ reportResult()

bool QFutureInterface< void >::reportResult ( const void * ,
int  )
inline

Definition at line 514 of file qfutureinterface.h.

◆ reportResults()

bool QFutureInterface< void >::reportResults ( const QList< void > & ,
int  )
inline

Definition at line 515 of file qfutureinterface.h.

◆ resultPointer()

const void * QFutureInterface< void >::resultPointer ( int index) const
inline

Definition at line 291 of file qfutureinterface.h.

◆ resultReference()

const void & QFutureInterface< void >::resultReference ( int index) const
inline

Definition at line 290 of file qfutureinterface.h.

◆ results()

QList< void > QFutureInterface< void >::results ( )
inline

Definition at line 292 of file qfutureinterface.h.

◆ takeResult()

void QFutureInterface< void >::takeResult ( )

Definition at line 294 of file qfutureinterface.h.

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