Main Page | Packages | Class Hierarchy | Class List | Directories | Class Members

IDVR.ProgressWin Class Reference

#include <ProgressWin.h>

List of all members.


Detailed Description

GUI class for creating the Progressbar dialog window.

This class is part of the main application namespace IDVR and contains the definition of the Progressbar dialog window.

During several possible calculation processes like the loading of the volume data/mask data, the actual rendering or the video creation a progress bar should be shown to visualze the current status of the specific process. An instance of this class will be always created in the specific class which starts the choosen calculation process (e.g. the class Neu for loading volume/mask data).

Thus, this class defines the progressbar dialog window and provides an interface which is needed to update the current process status. Note that the actual progressbar is performed by a particular thread to garantuee correct functionality.

The API documentation for this class shows only the most important member variables and function. Event handling functions and GUI components (e.g. labels, textboxes,...) will not be included but all essential parts of the class are surely documented.

See also:
Neu - the main GUI window class of this application.
Author:
Bernhard Pflugfelder
Version:
1.0
Date:
02-21-2005


Public Member Functions

 ProgressWin (String *n_Title, String *n_Description)
 This is the unique constructor of this class.
 ProgressWin (void)
 This is the standard constructor.
__property void set_Description (String *n_Description)
 Sets a new description for the current progressbar instance.
__property void set_Title (String *n_Title)
 Sets a new title for the current progressbar instance.
void setProgressbarStep ()
 Increments the current progressbar about one single step.
void setProgressbarToMaximum ()
 Sets the progressbar to the maximum step count.
void setProgressbarStepRange (int n_StepRange)
 Sets the range of the progressbar.
bool isWindowActive (void)
 Returns the status of the progressbar dialog window.
void resetGUIItems (String *n_Title, String *n_Description)
 Resets all GUI components of the progressbar dialog window to the corresponding parameters.

Protected Member Functions

void Dispose (Boolean disposing)
 Destroys all GUI components before this current instance will be actually discarded.

Private Member Functions

void InitializeComponent (void)
 The main function to create the all needed GUI components.

Private Attributes

System::ComponentModel::Container * components
 Erforderliche Designervariable.


Constructor & Destructor Documentation

IDVR.ProgressWin.ProgressWin String *  n_Title,
String *  n_Description
 

This is the unique constructor of this class.

It implements the standard initialization of the GUI window and actually start a thread to create and control a specific dialog window.

Parameters:
n_Title the new dialog title which will be shown on the top of the dialog window.
n_Description the new description which will be shown inside the dialog window.

IDVR.ProgressWin.ProgressWin void   ) 
 

This is the standard constructor.

It implements the standard initialization of the GUI window and actually start a thread to create and control a specific dialog window.


Member Function Documentation

void IDVR.ProgressWin.Dispose Boolean  disposing  )  [protected]
 

Destroys all GUI components before this current instance will be actually discarded.

Parameters:
disposing is a flag variable which is true if the instance have to be discarded.

void IDVR.ProgressWin.InitializeComponent void   )  [private]
 

The main function to create the all needed GUI components.

Furthermore, the linking of those created GUI components (e.g. labels, textboxes,...) to the current container is implemented. After the correct linking all GUI items will be shown on the screen.

Note:
This function must not be changed in a code editor because otherwise the GUI builder could be working incorrectly.

bool ProgressWin::isWindowActive void   ) 
 

Returns the status of the progressbar dialog window.

void ProgressWin::resetGUIItems String *  n_Title,
String *  n_Description
 

Resets all GUI components of the progressbar dialog window to the corresponding parameters.

The actual progressbar will be set to step count zero (start status).

Parameters:
n_Title the new dialog title which will be shown on the top of the dialog window.
n_Description the new description which will be shown inside the dialog window.

void ProgressWin::set_Description String *  n_Description  ) 
 

Sets a new description for the current progressbar instance.

If the progressbar is actually active the new description will be instantly shown.

Parameters:
n_Description the new description which will be shown inside the dialog window.

void ProgressWin::set_Title String *  n_Title  ) 
 

Sets a new title for the current progressbar instance.

If the progressbar is actually active the new title will be instantly shown.

Parameters:
n_Title the new dialog title which will be shown on the top of the dialog window.

void ProgressWin::setProgressbarStep  ) 
 

Increments the current progressbar about one single step.

void ProgressWin::setProgressbarStepRange int  n_StepRange  ) 
 

Sets the range of the progressbar.

This means the maximum count of steps of the current progressbar.

Parameters:
n_StepRange the new range of steps for the progressbar.

void ProgressWin::setProgressbarToMaximum  ) 
 

Sets the progressbar to the maximum step count.

The progressbar will be shown fully filled.


The documentation for this class was generated from the following files:
Generated on Sat Apr 9 11:50:59 2005 for RayCaster wiht Importance Driven Volume Rendering (IDVR) by  doxygen 1.4.1