MMSProgressBarWidgetClass Class Reference

A data access class for the progressbar widget. More...

#include <mmsprogressbarwidgetclass.h>

List of all members.


Public Member Functions

 MMSProgressBarWidgetClass ()
 Constructor of class MMSProgressBarWidgetClass.
void unsetAll ()
 Mark all attributes as not set.
void setClassName (string className)
 Set the name of the theme class.
string getClassName ()
 Get the name of the theme class.
bool isColor ()
 Check if the color is set. This color will be used to draw the unselected progress bar.
void setColor (MMSFBColor color)
 Set the color which is used to draw the unselected progress bar.
void unsetColor ()
 Mark the color as not set.
MMSFBColor getColor ()
 Get the color which is used to draw the unselected progress bar.
bool isSelColor ()
 Check if the color is set. This color will be used for the selected progress bar.
void setSelColor (MMSFBColor selcolor)
 Set the color which is used to draw the selected progress bar.
void unsetSelColor ()
 Mark the color as not set.
MMSFBColor getSelColor ()
 Get the color which is used to draw the selected progress bar.
bool isProgress ()
 Check if the progress value is set.
void setProgress (unsigned int progress)
 Set the progress.
void unsetProgress ()
 Mark the progress as not set.
unsigned int getProgress ()
 Get the progress.

Public Attributes

MMSWidgetClass widgetClass
 stores base widget attributes

Private Member Functions

void setAttributesFromTAFF (MMSTaffFile *tafff, string *prefix=NULL, string *path=NULL, bool reset_paths=false)
 Read and set all attributes from the given TAFF buffer.

Private Attributes

string className
 name of the theme class
bool iscolor
 is color set?
MMSFBColor color
 color if the widget is not selected
bool isselcolor
 is selcolor set?
MMSFBColor selcolor
 color if the widget is selected
bool isprogress
 is progress value set?
unsigned int progress
 progress value in percent

Friends

class MMSThemeManager
class MMSDialogManager

Detailed Description

A data access class for the progressbar widget.

This class is the base for the MMSProgressBarWidget class. With this data store you have access to all changeable widget attributes. It is also one of the base classes for MMSThemeManager and MMSDialogManager which are main features of the MMSGUI.

Note:
This class will be internally used by class MMSProgressBarWidget.
Author:
Jens Schneider

Definition at line 95 of file mmsprogressbarwidgetclass.h.


Constructor & Destructor Documentation

MMSProgressBarWidgetClass::MMSProgressBarWidgetClass (  ) 

Constructor of class MMSProgressBarWidgetClass.

Definition at line 46 of file mmsprogressbarwidgetclass.cpp.


Member Function Documentation

void MMSProgressBarWidgetClass::setAttributesFromTAFF ( MMSTaffFile tafff,
string *  prefix = NULL,
string *  path = NULL,
bool  reset_paths = false 
) [private]

Read and set all attributes from the given TAFF buffer.

Parameters:
tafff pointer to the TAFF buffer
prefix optional, prefix to all attribute names (<prefix><attrname>=<attrvalue>)
path optional, path needed for empty path values from the TAFF buffer
reset_paths optional, should reset all path attributes?

Definition at line 57 of file mmsprogressbarwidgetclass.cpp.

void MMSProgressBarWidgetClass::unsetAll (  ) 

Mark all attributes as not set.

Definition at line 50 of file mmsprogressbarwidgetclass.cpp.

void MMSProgressBarWidgetClass::setClassName ( string  className  ) 

Set the name of the theme class.

Parameters:
classname name of the class

Definition at line 219 of file mmsprogressbarwidgetclass.cpp.

string MMSProgressBarWidgetClass::getClassName (  ) 

Get the name of the theme class.

Returns:
name of the class

Definition at line 223 of file mmsprogressbarwidgetclass.cpp.

bool MMSProgressBarWidgetClass::isColor (  ) 

Check if the color is set. This color will be used to draw the unselected progress bar.

Definition at line 227 of file mmsprogressbarwidgetclass.cpp.

void MMSProgressBarWidgetClass::setColor ( MMSFBColor  color  ) 

Set the color which is used to draw the unselected progress bar.

Parameters:
color color for unselected bar

Definition at line 231 of file mmsprogressbarwidgetclass.cpp.

void MMSProgressBarWidgetClass::unsetColor (  ) 

Mark the color as not set.

Definition at line 236 of file mmsprogressbarwidgetclass.cpp.

MMSFBColor MMSProgressBarWidgetClass::getColor (  ) 

Get the color which is used to draw the unselected progress bar.

Returns:
color which is used for the unselected progress bar

Definition at line 240 of file mmsprogressbarwidgetclass.cpp.

bool MMSProgressBarWidgetClass::isSelColor (  ) 

Check if the color is set. This color will be used for the selected progress bar.

Definition at line 244 of file mmsprogressbarwidgetclass.cpp.

void MMSProgressBarWidgetClass::setSelColor ( MMSFBColor  selcolor  ) 

Set the color which is used to draw the selected progress bar.

Parameters:
selcolor color for selected bar

Definition at line 248 of file mmsprogressbarwidgetclass.cpp.

void MMSProgressBarWidgetClass::unsetSelColor (  ) 

Mark the color as not set.

Definition at line 253 of file mmsprogressbarwidgetclass.cpp.

MMSFBColor MMSProgressBarWidgetClass::getSelColor (  ) 

Get the color which is used to draw the selected progress bar.

Returns:
color which is used for the selected progress bar

Definition at line 257 of file mmsprogressbarwidgetclass.cpp.

bool MMSProgressBarWidgetClass::isProgress (  ) 

Check if the progress value is set.

Definition at line 261 of file mmsprogressbarwidgetclass.cpp.

void MMSProgressBarWidgetClass::setProgress ( unsigned int  progress  ) 

Set the progress.

Parameters:
progress progress in percent (0-100)

Definition at line 265 of file mmsprogressbarwidgetclass.cpp.

void MMSProgressBarWidgetClass::unsetProgress (  ) 

Mark the progress as not set.

Definition at line 270 of file mmsprogressbarwidgetclass.cpp.

unsigned int MMSProgressBarWidgetClass::getProgress (  ) 

Get the progress.

Returns:
progress

Definition at line 274 of file mmsprogressbarwidgetclass.cpp.


Friends And Related Function Documentation

friend class MMSThemeManager [friend]

Definition at line 205 of file mmsprogressbarwidgetclass.h.

friend class MMSDialogManager [friend]

Definition at line 206 of file mmsprogressbarwidgetclass.h.


Member Data Documentation

name of the theme class

Definition at line 98 of file mmsprogressbarwidgetclass.h.

is color set?

Definition at line 101 of file mmsprogressbarwidgetclass.h.

color if the widget is not selected

Definition at line 104 of file mmsprogressbarwidgetclass.h.

is selcolor set?

Definition at line 107 of file mmsprogressbarwidgetclass.h.

color if the widget is selected

Definition at line 110 of file mmsprogressbarwidgetclass.h.

is progress value set?

Definition at line 113 of file mmsprogressbarwidgetclass.h.

unsigned int MMSProgressBarWidgetClass::progress [private]

progress value in percent

Definition at line 116 of file mmsprogressbarwidgetclass.h.

stores base widget attributes

Definition at line 130 of file mmsprogressbarwidgetclass.h.


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