[an error occurred while processing this directive]
Main Page | Modules | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

AppBase::ProgressDisplay Class Reference

#include <ProgressDisplay.h>

Inheritance diagram for AppBase::ProgressDisplay:

Inheritance graph
[legend]
List of all members.

Public Member Functions

virtual ~ProgressDisplay ()
void setParentProgressOfNewSubtasks (double subtaskTotalProgress, bool propagatesProgress=false)
void startSubtask (const std::string &message, const double &maxProgress, const double &progressForParentTask, const bool &propagatesProgress=false)
void startSubtask (const std::string &message, const double &maxProgress=0)
void startSubtask (const double &maxProgress)
virtual void setSubtaskMessage (const std::string &message)
virtual std::string getSubtaskMessage () const
virtual double getSubtaskMaxProgress () const
virtual double getSubtaskProgress () const
virtual void updateSubtaskProgress (const double &newValue)
virtual void increaseSubtaskProgressBy (const double &deltaValue)
virtual void finishSubtask ()
virtual bool wasCancelled ()

Protected Member Functions

 ProgressDisplay ()
void startSubtaskWithTask (const ProgressSubtask &newSubtask)
virtual void cancelTask ()
virtual void updateProgressDisplay ()=0
 Template method, updates the display.
virtual void subtaskStarted ()
 Template method, called when subtask is started.
virtual void subtaskFinished ()
 Template method, called when subtask is finishing.
virtual void propagateProgress (const double &newProgress)
virtual ProgressSubtaskgetCurrentSubtask () const
virtual bool noSubtasksAvailable () const

Protected Attributes

std::vector< ProgressSubtasko_subtasks
bool o_canceled
double o_newSubtaskProgress
bool o_newSubtaskPropagates

Constructor & Destructor Documentation

AppBase::ProgressDisplay::ProgressDisplay  )  [inline, protected]
 

virtual AppBase::ProgressDisplay::~ProgressDisplay  )  [inline, virtual]
 


Member Function Documentation

void AppBase::ProgressDisplay::cancelTask  )  [protected, virtual]
 

void AppBase::ProgressDisplay::finishSubtask  )  [virtual]
 

ProgressDisplay::ProgressSubtask & AppBase::ProgressDisplay::getCurrentSubtask  )  const [protected, virtual]
 

double AppBase::ProgressDisplay::getSubtaskMaxProgress  )  const [virtual]
 

std::string AppBase::ProgressDisplay::getSubtaskMessage  )  const [virtual]
 

double AppBase::ProgressDisplay::getSubtaskProgress  )  const [virtual]
 

void AppBase::ProgressDisplay::increaseSubtaskProgressBy const double deltaValue  )  [virtual]
 

bool AppBase::ProgressDisplay::noSubtasksAvailable  )  const [protected, virtual]
 

void AppBase::ProgressDisplay::propagateProgress const double newProgress  )  [protected, virtual]
 

void AppBase::ProgressDisplay::setParentProgressOfNewSubtasks double  subtaskTotalProgress,
bool  propagatesProgress = false
 

void AppBase::ProgressDisplay::setSubtaskMessage const std::string &  message  )  [virtual]
 

void AppBase::ProgressDisplay::startSubtask const double maxProgress  ) 
 

void AppBase::ProgressDisplay::startSubtask const std::string &  message,
const double maxProgress = 0
 

void AppBase::ProgressDisplay::startSubtask const std::string &  message,
const double maxProgress,
const double progressForParentTask,
const bool propagatesProgress = false
 

void AppBase::ProgressDisplay::startSubtaskWithTask const ProgressSubtask newSubtask  )  [protected]
 

virtual void AppBase::ProgressDisplay::subtaskFinished  )  [inline, protected, virtual]
 

Template method, called when subtask is finishing.

The default implementation does nothing.

virtual void AppBase::ProgressDisplay::subtaskStarted  )  [inline, protected, virtual]
 

Template method, called when subtask is started.

The default implementation does nothing.

virtual void AppBase::ProgressDisplay::updateProgressDisplay  )  [protected, pure virtual]
 

Template method, updates the display.

You should override this method with your code of updating the display.

Implemented in AppBase::DummyProgressDisplay, and AppBase::StreamProgressDisplay.

void AppBase::ProgressDisplay::updateSubtaskProgress const double newValue  )  [virtual]
 

bool AppBase::ProgressDisplay::wasCancelled  )  [virtual]
 


Member Data Documentation

bool AppBase::ProgressDisplay::o_canceled [protected]
 

double AppBase::ProgressDisplay::o_newSubtaskProgress [protected]
 

bool AppBase::ProgressDisplay::o_newSubtaskPropagates [protected]
 

std::vector<ProgressSubtask> AppBase::ProgressDisplay::o_subtasks [protected]
 


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

Generated on Mon Sep 20 01:01:35 2010 for Hugintrunk by doxygen 1.3.9.1