Public Member Functions | List of all members

#include <tjfeedback.h>

Public Member Functions

 ProgressMeter (ProgressDisplayDriver &disp)
 
ProgressMeternew_task (unsigned int total_steps, const char *txt=0)
 
bool increase_counter (const char *subj=0)
 
bool refresh_display ()
 

Detailed Description

Class to preset the progress of an operation to the user. The implementation is thread-safe.

Definition at line 70 of file tjfeedback.h.

Constructor & Destructor Documentation

§ ProgressMeter()

ProgressMeter::ProgressMeter ( ProgressDisplayDriver disp)
inline

Creates progress meter using display driver 'disp' which should exist for the whole life time of the progress meter.

Definition at line 78 of file tjfeedback.h.

Member Function Documentation

§ increase_counter()

bool ProgressMeter::increase_counter ( const char *  subj = 0)

Increments progress display. The message 'subj', if non-null, will be displayed. Returns true if cancel is requested by the driver.

§ new_task()

ProgressMeter& ProgressMeter::new_task ( unsigned int  total_steps,
const char *  txt = 0 
)

Initialize new task with 'total_steps' increments. The message 'txt' will be displayed prior to the progress report.

§ refresh_display()

bool ProgressMeter::refresh_display ( )

Refreshes display without increasing progress. Returns true if cancel is requested by the driver.


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