QFutureInterface< ctkCmdLineModuleResult > Class Reference

A QFutureInterface specialization. More...

#include <Libs/CommandLineModules/Core/ctkCmdLineModuleFutureInterface.h>

Inheritance diagram for QFutureInterface< ctkCmdLineModuleResult >:

Collaboration diagram for QFutureInterface< ctkCmdLineModuleResult >:

Public Member Functions
bool	canCancel () const
bool	canPause () const
QByteArray	errorData (int position=0, int size=-1) const
ctkCmdLineModuleFuture	future ()
QFutureInterface &	operator= (const QFutureInterface &other)
QByteArray	outputData (int position=0, int size=-1) const
	QFutureInterface (const QFutureInterface &other)
	QFutureInterface (State initialState=NoState)
void	reportErrorData (const QByteArray &errorData)
void	reportFinished (const ctkCmdLineModuleResult *result=0)
void	reportOutputData (const QByteArray &outputData)
void	reportResult (const ctkCmdLineModuleResult &result, int index=-1)
void	reportResult (const ctkCmdLineModuleResult *result, int index=-1)
void	reportResults (const QVector< ctkCmdLineModuleResult > &results, int beginIndex=-1, int count=-1)
const ctkCmdLineModuleResult *	resultPointer (int index) const
const ctkCmdLineModuleResult &	resultReference (int index) const
QList< ctkCmdLineModuleResult >	results ()
void	setCanCancel (bool canCancel)
void	setCanPause (bool canPause)
	~QFutureInterface ()

Static Public Member Functions
static QFutureInterface	canceledResult ()

Friends
struct	ctkCmdLineModuleFutureWatcherPrivate

Detailed Description

A QFutureInterface specialization.

This QFutureInterface must be used by custom backend implementations to retrieve a suitable QFuture object and to report state changes to it via this interface.

Definition at line 50 of file ctkCmdLineModuleFutureInterface.h.

Constructor & Destructor Documentation

QFutureInterface() [1/2]

QFutureInterface< ctkCmdLineModuleResult >::QFutureInterface

(

State

initialState = NoState

)

QFutureInterface() [2/2]

QFutureInterface< ctkCmdLineModuleResult >::QFutureInterface

(

const QFutureInterface< ctkCmdLineModuleResult > &

other

)

~QFutureInterface()

QFutureInterface< ctkCmdLineModuleResult >::~QFutureInterface

(

)

Member Function Documentation

canCancel()

bool QFutureInterface< ctkCmdLineModuleResult >::canCancel

(

)

const

canceledResult()

static QFutureInterface QFutureInterface< ctkCmdLineModuleResult >::canceledResult ( )

static

canPause()

bool QFutureInterface< ctkCmdLineModuleResult >::canPause

(

)

const

errorData()

QByteArray QFutureInterface< ctkCmdLineModuleResult >::errorData	(	int	position = 0,
		int	size = -1
	)		const

future()

ctkCmdLineModuleFuture ctkCmdLineModuleFutureInterface::future ( )

inline

Definition at line 79 of file ctkCmdLineModuleFuture.h.

operator=()

QFutureInterface& QFutureInterface< ctkCmdLineModuleResult >::operator=

(

const QFutureInterface< ctkCmdLineModuleResult > &

other

)

outputData()

QByteArray QFutureInterface< ctkCmdLineModuleResult >::outputData	(	int	position = 0,
		int	size = -1
	)		const

reportErrorData()

void QFutureInterface< ctkCmdLineModuleResult >::reportErrorData

(

const QByteArray &

errorData

)

reportFinished()

void QFutureInterface< ctkCmdLineModuleResult >::reportFinished ( const ctkCmdLineModuleResult *  result = 0 )

inline

Definition at line 166 of file ctkCmdLineModuleFutureInterface.h.

reportOutputData()

void QFutureInterface< ctkCmdLineModuleResult >::reportOutputData

(

const QByteArray &

outputData

)

reportResult() [1/2]

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

inline

Definition at line 136 of file ctkCmdLineModuleFutureInterface.h.

reportResult() [2/2]

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

inline

Definition at line 111 of file ctkCmdLineModuleFutureInterface.h.

reportResults()

void QFutureInterface< ctkCmdLineModuleResult >::reportResults ( const QVector< ctkCmdLineModuleResult > &  results, int  beginIndex = -1, int  count = -1  )

inline

Definition at line 141 of file ctkCmdLineModuleFutureInterface.h.

resultPointer()

const ctkCmdLineModuleResult * QFutureInterface< ctkCmdLineModuleResult >::resultPointer ( int  index ) const

inline

Definition at line 183 of file ctkCmdLineModuleFutureInterface.h.

resultReference()

const ctkCmdLineModuleResult & QFutureInterface< ctkCmdLineModuleResult >::resultReference ( int  index ) const

inline

Definition at line 173 of file ctkCmdLineModuleFutureInterface.h.

results()

QList< ctkCmdLineModuleResult > QFutureInterface< ctkCmdLineModuleResult >::results ( )

inline

Definition at line 193 of file ctkCmdLineModuleFutureInterface.h.

setCanCancel()

void QFutureInterface< ctkCmdLineModuleResult >::setCanCancel

(

bool

canCancel

)

setCanPause()

void QFutureInterface< ctkCmdLineModuleResult >::setCanPause

(

bool

canPause

)

Friends And Related Function Documentation

ctkCmdLineModuleFutureWatcherPrivate

friend struct ctkCmdLineModuleFutureWatcherPrivate

friend

Definition at line 89 of file ctkCmdLineModuleFutureInterface.h.

---

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

• Libs/CommandLineModules/Core/ctkCmdLineModuleFutureInterface.h
• Libs/CommandLineModules/Core/ctkCmdLineModuleFuture.h