The ProgressMonitor class is a pure virtual call-back interface to signal progress and to propagate feedback of cancellation. More...

#include <micxx/traits/ProgressMonitor.hxx>

Public Member Functions
virtual	~ProgressMonitor ()
	The ProgressMonitor destructor.
virtual bool	isCancelled () const =0
	Propagate cancellation to the caller.
virtual void	setValue (double value)=0
	Called to signal an implementation the current progress.
virtual void	setMaxValue (double value)=0
	Called to signal an implementation the maximum possible progress.
virtual void	setText (const wchar_t *text)=0
	Called to signal an implementation a descriptive text for the current progress.

Detailed Description

The ProgressMonitor class is a pure virtual call-back interface to signal progress and to propagate feedback of cancellation.

Constructor & Destructor Documentation

virtual micxx::traits::ProgressMonitor::~ProgressMonitor ( ) [inline, virtual]

The ProgressMonitor destructor.

{};

virtual bool micxx::traits::ProgressMonitor::isCancelled ( ) const [pure virtual]

Propagate cancellation to the caller.

Returns:: If an implementation supports cancellation, it should return true, if the caller should cancel any further processing as soon as possible; otherwise an implementation should return false.

virtual void micxx::traits::ProgressMonitor::setMaxValue ( double value ) [pure virtual]

Called to signal an implementation the maximum possible progress.

virtual void micxx::traits::ProgressMonitor::setText ( const wchar_t * text ) [pure virtual]

Called to signal an implementation a descriptive text for the current progress.

virtual void micxx::traits::ProgressMonitor::setValue ( double value ) [pure virtual]

Called to signal an implementation the current progress.

The maximum possible progress is set by setMaxValue(double).

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