Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

vuSimpleProgressHandler Class Reference

#include <vuSimpleProgressHandler.h>

Inheritance diagram for vuSimpleProgressHandler:

Inheritance graph
[legend]
Collaboration diagram for vuSimpleProgressHandler:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 vuSimpleProgressHandler (wxWindow *parent, const wxString title="Progress Bar", const wxString message="", int style=wxPD_AUTO_HIDE|wxPD_APP_MODAL|wxPD_CAN_ABORT, int range=1000)
virtual ~vuSimpleProgressHandler ()
bool update (int newProgressValue, const char *msg=NULL)
void setRange (int range)
int getRange ()
int getCurrentProgress ()

Private Attributes

wxString m_Title
wxString m_Message
int m_Style
wxWindow * m_Parent
wxProgressDialog * m_Progress
int m_Range
int m_CurrentProgress

Detailed Description

Implements the protocol defined by vuProgressHandler -ms-

Definition at line 11 of file vuSimpleProgressHandler.h.


Constructor & Destructor Documentation

vuSimpleProgressHandler::vuSimpleProgressHandler wxWindow *  parent,
const wxString  title = "Progress Bar",
const wxString  message = "",
int  style = wxPD_AUTO_HIDE|wxPD_APP_MODAL|wxPD_CAN_ABORT,
int  range = 1000
 

Definition at line 3 of file vuSimpleProgressHandler.cpp.

References m_CurrentProgress, m_Message, m_Parent, m_Progress, m_Range, m_Style, and m_Title.

vuSimpleProgressHandler::~vuSimpleProgressHandler  )  [virtual]
 

Definition at line 19 of file vuSimpleProgressHandler.cpp.

References CHECKNDELETE, and m_Progress.


Member Function Documentation

int vuSimpleProgressHandler::getCurrentProgress  )  [virtual]
 

returns the current progress value, which is updated by update(int, char*)

Implements vuProgressHandler.

Definition at line 35 of file vuSimpleProgressHandler.cpp.

int vuSimpleProgressHandler::getRange  )  [virtual]
 

Implements vuProgressHandler.

Definition at line 29 of file vuSimpleProgressHandler.cpp.

void vuSimpleProgressHandler::setRange int  range  )  [virtual]
 

The range specifies the value, which represents the '100% completed' mark. The range can be manipulated to allow nest calls (see example above).

Note:
The range can NOT be increased, but only divided into smaller parts

Implements vuProgressHandler.

Definition at line 24 of file vuSimpleProgressHandler.cpp.

References m_Range.

bool vuSimpleProgressHandler::update int  newProgressValue,
const char *  msg = NULL
[virtual]
 

updates the progress bar and additionally gives some message

Implements vuProgressHandler.

Definition at line 40 of file vuSimpleProgressHandler.cpp.

References m_CurrentProgress, and m_Progress.


Member Data Documentation

int vuSimpleProgressHandler::m_CurrentProgress [private]
 

Definition at line 42 of file vuSimpleProgressHandler.h.

Referenced by update(), and vuSimpleProgressHandler().

wxString vuSimpleProgressHandler::m_Message [private]
 

Definition at line 37 of file vuSimpleProgressHandler.h.

Referenced by vuSimpleProgressHandler().

wxWindow* vuSimpleProgressHandler::m_Parent [private]
 

Definition at line 39 of file vuSimpleProgressHandler.h.

Referenced by vuSimpleProgressHandler().

wxProgressDialog* vuSimpleProgressHandler::m_Progress [private]
 

Definition at line 40 of file vuSimpleProgressHandler.h.

Referenced by update(), vuSimpleProgressHandler(), and ~vuSimpleProgressHandler().

int vuSimpleProgressHandler::m_Range [private]
 

Definition at line 41 of file vuSimpleProgressHandler.h.

Referenced by setRange(), and vuSimpleProgressHandler().

int vuSimpleProgressHandler::m_Style [private]
 

Definition at line 38 of file vuSimpleProgressHandler.h.

Referenced by vuSimpleProgressHandler().

wxString vuSimpleProgressHandler::m_Title [private]
 

Definition at line 36 of file vuSimpleProgressHandler.h.

Referenced by vuSimpleProgressHandler().


The documentation for this class was generated from the following files:
Generated on Wed Dec 15 21:22:02 2004 for vuVolume by  doxygen 1.3.9.1