Hugintrunk  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Attributes | List of all members
AppBase::StreamProgressDisplay Class Reference

a progress display to print progress reports to a stream More...

#include <ProgressDisplay.h>

Inheritance diagram for AppBase::StreamProgressDisplay:
Inheritance graph

Public Member Functions

 StreamProgressDisplay (std::ostream &o)
 constructor, connect with given outputstream More...
 
virtual void updateProgressDisplay ()
 update the display, print the message to stream More...
 
- Public Member Functions inherited from AppBase::ProgressDisplay
virtual ~ProgressDisplay ()
 
void setMessage (const std::string &message, const std::string &filename="")
 sets the message to given string More...
 
void taskFinished ()
 call when a task has finished and the status message should be cleared More...
 
bool updateDisplay ()
 updates the display, return true, if update was successful, false if cancel was pressed More...
 
bool updateDisplay (const std::string &message)
 
bool updateDisplayValue ()
 
void setMaximum (int newMaximum)
 sets the new maximum value of the progress value More...
 
bool wasCancelled ()
 return true, if process should be canceled by user e.g. More...
 

Protected Attributes

std::ostream & m_stream
 
- Protected Attributes inherited from AppBase::ProgressDisplay
bool m_canceled
 
std::string m_message
 
std::string m_filename
 
int m_maximum
 
int m_progress
 

Additional Inherited Members

- Protected Member Functions inherited from AppBase::ProgressDisplay
 ProgressDisplay (int maximum=0)
 constructor More...
 

Detailed Description

a progress display to print progress reports to a stream

Definition at line 89 of file ProgressDisplay.h.

Constructor & Destructor Documentation

AppBase::StreamProgressDisplay::StreamProgressDisplay ( std::ostream &  o)
inlineexplicit

constructor, connect with given outputstream

Definition at line 93 of file ProgressDisplay.h.

Member Function Documentation

void AppBase::StreamProgressDisplay::updateProgressDisplay ( )
virtual

update the display, print the message to stream

Implements AppBase::ProgressDisplay.

Definition at line 78 of file ProgressDisplay.cpp.

References AppBase::ProgressDisplay::m_filename, AppBase::ProgressDisplay::m_message, and m_stream.

Member Data Documentation

std::ostream& AppBase::StreamProgressDisplay::m_stream
protected

Definition at line 97 of file ProgressDisplay.h.

Referenced by updateProgressDisplay().


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