ProgressTracker Class Reference

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

#include <ProgressTracker.h++>

Inheritance diagram for ProgressTracker:
Inheritance graph
[legend]

List of all members.

Public Member Functions

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

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

virtual ~ProgressTracker (  )  [inline, virtual]

Destructor.


Member Function Documentation

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:
percent The percentage of the task that has been completed. A negative value indicates indeterminate progress.
status An optional status message.

Implemented in ProgressTrackerDelegate< T >.


The documentation for this class was generated from the following file:
Generated on Sat Nov 26 16:49:09 2011 for libcommonc++ by  doxygen 1.6.3