IR3DProgress Class Reference

#include <R3D/Common/IR3DProgress.h>

Inherited by _R3DProgress, QR3DProgress, and R3DImportProgress.

Inheritance diagram for IR3DProgress:

Inheritance graph
[legend]
List of all members.

Detailed Description

Author:
mjackson

Date:
Mar 19, 2009
Version:
1.0


Public Member Functions

virtual void setMessage (const std::string &message)=0
 Sets the a message to be displayed or otherwise shown to the user.
virtual void cancelProcess ()=0
 Sets a flag that the process should stop running.
virtual bool isCancelled ()=0
 Is the import cancelled.
virtual void setProgress (float progress)=0
 sets the amount of import completed
virtual void finished ()=0
 Is the thread or process that this IR3DProgress object is attached to finished.


Member Function Documentation

virtual void IR3DProgress::setMessage ( const std::string &  message  )  [pure virtual]

Sets the a message to be displayed or otherwise shown to the user.

Parameters:
message The message to be displayed

Implemented in R3DImportProgress, and QR3DProgress.

virtual bool IR3DProgress::isCancelled (  )  [pure virtual]

Is the import cancelled.

Returns:

Implemented in R3DImportProgress, and QR3DProgress.

virtual void IR3DProgress::setProgress ( float  progress  )  [pure virtual]

sets the amount of import completed

Parameters:
progress Floating point number that should fall between 0.0 and 1.0 to be used as a percentage

Implemented in R3DImportProgress, and QR3DProgress.


The documentation for this class was generated from the following file:
Generated on Fri Aug 28 14:04:33 2009 for R3DImageTools by  doxygen 1.5.2