Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
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 ()
 
- 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 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  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 setContinuation (std::function< void(const QFutureInterfaceBase &)> func, QFutureInterfaceBasePrivate *continuationFutureData)
 
void cleanContinuation ()
 
void runContinuation () const
 
void setLaunchAsync (bool value)
 
bool launchAsync () const
 
bool isRunningOrPending () const
 
void cancel (CancelMode mode)
 

Detailed Description

Definition at line 469 of file qfutureinterface.h.

Constructor & Destructor Documentation

◆ QFutureInterface() [1/2]

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

Definition at line 472 of file qfutureinterface.h.

◆ QFutureInterface() [2/2]

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

Definition at line 476 of file qfutureinterface.h.

Member Function Documentation

◆ canceledResult()

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

Definition at line 478 of file qfutureinterface.h.

◆ future()

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

Definition at line 418 of file qfuture.h.

◆ reportFinished() [1/2]

void QFutureInterface< void >::reportFinished ( )
inline

Definition at line 491 of file qfutureinterface.h.

References QFutureInterfaceBase::reportFinished(), and QFutureInterfaceBase::runContinuation().

+ Here is the call graph for this function:

◆ reportFinished() [2/2]

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

Definition at line 486 of file qfutureinterface.h.

◆ reportResult()

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

Definition at line 484 of file qfutureinterface.h.

◆ reportResults()

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

Definition at line 485 of file qfutureinterface.h.

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