libcommonc++  0.7
ProgressTracker Class Referenceabstract

An interface for tracking the progress of a lengthy operation. More...

#include <ProgressTracker.h++>

Inheritance diagram for ProgressTracker:

Public Member Functions

virtual ~ProgressTracker ()
 Destructor. More...
 
virtual void updateProgress (int percent, const String &status=String::null)=0
 Notify the tracker of an update in the progress of a task. More...
 

Detailed Description

An interface for tracking the progress of a lengthy operation.

See ProgressTrackerDelegate for an implementation that delegates to a method in an object.

Author
Mark Lindner

Constructor & Destructor Documentation

◆ ~ProgressTracker()

virtual ~ProgressTracker ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ updateProgress()

virtual void updateProgress ( int  percent,
const String status = String::null 
)
pure virtual

Notify the tracker of an update in the progress of a task.

Parameters
percentThe percentage of the task that has been completed. A negative value indicates indeterminate progress.
statusAn optional status message.

Implemented in ProgressTrackerDelegate< T >.


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