Logo Search packages:      
Sourcecode: pan version File versions

pan::Progress Class Reference
[General Utilities]

#include <progress.h>

Inheritance diagram for pan::Progress:

pan::Task pan::TaskArticle pan::TaskGroups pan::TaskPost pan::TaskXOver

List of all members.


Detailed Description

Base class describing an object that goes through steps to some completion.

It provides methods for telling interested parties how many steps are left, what the Progress object is doing, and whether or not it completed successfully.

Definition at line 40 of file progress.h.


Public Member Functions

void add_listener (Listener *)
void add_steps (int steps)
virtual std::string describe () const
int get_progress_of_100 () const
std::string get_status () const
void increment_step (int increment=1)
void init_steps (int steps)
 Progress (const StringView &description=StringView())
void pulse ()
void remove_listener (Listener *)
void set_error (const StringView &error)
void set_finished (int status)
void set_status (const StringView &status)
void set_status_va (const char *fmt,...)
void set_step (int step)

Protected Attributes

bool _active
std::string _description
int _done
std::vector< std::string > _errors
std::string _status_text
int _step
int _steps

Private Types

typedef
Progress::listeners_t::const_iterator 
listeners_cit
typedef std::set< Listener * > listeners_t

Private Member Functions

void fire_error (const StringView &msg)
void fire_finished (int status)
void fire_percentage (int p)
void fire_pulse ()
void fire_status (const StringView &msg)

Private Attributes

listeners_t _listeners

Classes

struct  Listener

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

Generated by  Doxygen 1.6.0   Back to index