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
Public Member Functions | Static Public Member Functions | List of all members
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 (State initialState=NoState)
 
 QFutureInterface (const QFutureInterface &other)
 
 QFutureInterface (const QFutureInterfaceBase &dd)
 
 QFutureInterface (QFutureInterfaceBase &&dd) noexcept
 
 QFutureInterface (QFutureInterface &&other)=default
 
QFutureInterface & operator= (const QFutureInterface &other)
 
 ~QFutureInterface ()
 
QFuture< void > future ()
 
bool reportAndEmplaceResult (int index, Args &&...args)
 
bool reportResult (const void *result, int index=-1)
 
bool reportResult (void &&result, int index=-1)
 
bool reportResult (const void &result, int index=-1)
 
bool reportAndMoveResult (void &&result, int index=-1)
 
bool reportResults (const QList< void > &results, int beginIndex=-1, int count=-1)
 
bool reportFinished (const void *result)
 
void reportFinished ()
 
const void & resultReference (int index) const
 
const void * resultPointer (int index) const
 
QList< void > results ()
 
void takeResult ()
 
void reportException (const std::exception_ptr &e)
 
void reportException (const QException &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 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 QFutureInterface 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 494 of file qfutureinterface.h.

Constructor & Destructor Documentation

◆ QFutureInterface() [1/7]

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

Definition at line 497 of file qfutureinterface.h.

◆ QFutureInterface() [2/7]

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

Definition at line 501 of file qfutureinterface.h.

◆ QFutureInterface() [3/7]

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

Definition at line 237 of file qfutureinterface.h.

◆ QFutureInterface() [4/7]

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

Definition at line 242 of file qfutureinterface.h.

◆ QFutureInterface() [5/7]

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

Definition at line 247 of file qfutureinterface.h.

◆ QFutureInterface() [6/7]

QFutureInterface< void >::QFutureInterface ( QFutureInterfaceBase && dd)
inlinenoexcept

Definition at line 248 of file qfutureinterface.h.

◆ QFutureInterface() [7/7]

QFutureInterface< void >::QFutureInterface ( QFutureInterface< void > && other)
default

◆ ~QFutureInterface()

QFutureInterface< void >::~QFutureInterface ( )
inline

Definition at line 258 of file qfutureinterface.h.

Member Function Documentation

◆ canceledResult() [1/2]

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

Definition at line 264 of file qfutureinterface.h.

◆ canceledResult() [2/2]

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

Definition at line 503 of file qfutureinterface.h.

◆ future() [1/2]

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

Definition at line 267 of file qfuture.h.

◆ future() [2/2]

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

Definition at line 423 of file qfuture.h.

◆ operator=()

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

Definition at line 249 of file qfutureinterface.h.

◆ reportAndEmplaceResult()

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

Definition at line 270 of file qfutureinterface.h.

◆ reportAndMoveResult()

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

Definition at line 272 of file qfutureinterface.h.

◆ reportException() [1/2]

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

Definition at line 302 of file qfutureinterface.h.

◆ reportException() [2/2]

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

Definition at line 294 of file qfutureinterface.h.

◆ reportFinished() [1/4]

void QFutureInterface< void >::reportFinished ( )
inline

Definition at line 277 of file qfutureinterface.h.

◆ reportFinished() [2/4]

void QFutureInterface< void >::reportFinished ( )
inline

Definition at line 516 of file qfutureinterface.h.

◆ reportFinished() [3/4]

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

Definition at line 511 of file qfutureinterface.h.

◆ reportFinished() [4/4]

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

Definition at line 276 of file qfutureinterface.h.

◆ reportResult() [1/4]

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

Definition at line 274 of file qfutureinterface.h.

◆ reportResult() [2/4]

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

Definition at line 509 of file qfutureinterface.h.

◆ reportResult() [3/4]

bool QFutureInterface< void >::reportResult ( const void * result,
int index = -1 )
inline

Definition at line 271 of file qfutureinterface.h.

◆ reportResult() [4/4]

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

Definition at line 273 of file qfutureinterface.h.

◆ reportResults() [1/2]

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

Definition at line 510 of file qfutureinterface.h.

◆ reportResults() [2/2]

bool QFutureInterface< void >::reportResults ( const QList< void > & results,
int beginIndex = -1,
int count = -1 )
inline

Definition at line 275 of file qfutureinterface.h.

◆ resultPointer()

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

Definition at line 284 of file qfutureinterface.h.

◆ resultReference()

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

Definition at line 283 of file qfutureinterface.h.

◆ results()

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

Definition at line 285 of file qfutureinterface.h.

◆ takeResult()

void QFutureInterface< void >::takeResult ( )

Definition at line 287 of file qfutureinterface.h.

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