MMSLabelWidgetClass Class Reference

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

#include <mmslabelwidgetclass.h>

Inheritance diagram for MMSLabelWidgetClass:


Public Member Functions
	MMSLabelWidgetClass ()
	Constructor of class MMSLabelWidgetClass.
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	isSlidable ()
	Check if the slidable flag is set.
void	setSlidable (bool slidable)
	Set the slidable flag.
void	unsetSlidable ()
	Mark the slidable flag as not set.
bool	getSlidable ()
	Get the slidable flag.
bool	isSlideSpeed ()
	Check if the slide speed is set.
void	setSlideSpeed (unsigned char slidespeed)
	Set the slide speed.
void	unsetSlideSpeed ()
	Mark the slide speed as not set.
unsigned char	getSlideSpeed ()
	Get the slide speed.
bool	isTranslate ()
	Check if the translate flag is set.
void	setTranslate (bool translate)
	Set the translate flag.
void	unsetTranslate ()
	Mark the translate flag as not set.
bool	getTranslate ()
	Get the translate flag.
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	isslidable
	is slidable set?
bool	slidable
	if true and size of the text string is greater than widget dimension, the text will slide over the widget
bool	isslidespeed
	is slide speed set?
unsigned int	slidespeed
	slide speed used if slidable set to true
bool	istranslate
	is translate set?
bool	translate
	if true the text will be translated before displayed
Friends
class	MMSThemeManager
class	MMSDialogManager

Detailed Description

A data access class for the label widget.

This class is the base for the MMSLabelWidget class and is derived from MMSTextBaseClass which is the base for all widgets with text output. 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 MMSLabelWidget.

Author:: Jens Schneider

Definition at line 86 of file mmslabelwidgetclass.h.

Constructor & Destructor Documentation

MMSLabelWidgetClass::MMSLabelWidgetClass ( )

Constructor of class MMSLabelWidgetClass.

Definition at line 46 of file mmslabelwidgetclass.cpp.

Member Function Documentation

void MMSLabelWidgetClass::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 58 of file mmslabelwidgetclass.cpp.

void MMSLabelWidgetClass::unsetAll ( ) [virtual]

Mark all attributes as not set.

Reimplemented from MMSTextBaseClass.

Definition at line 50 of file mmslabelwidgetclass.cpp.

void MMSLabelWidgetClass::setClassName ( string className )

Set the name of the theme class.

Parameters:

classname

name of the class

Definition at line 147 of file mmslabelwidgetclass.cpp.

string MMSLabelWidgetClass::getClassName ( )

Get the name of the theme class.

Returns:: name of the class

Definition at line 151 of file mmslabelwidgetclass.cpp.

bool MMSLabelWidgetClass::isSlidable ( )

Check if the slidable flag is set.

Definition at line 155 of file mmslabelwidgetclass.cpp.

void MMSLabelWidgetClass::setSlidable ( bool slidable )

Set the slidable flag.

Parameters:

slidable

true/false

Definition at line 159 of file mmslabelwidgetclass.cpp.

void MMSLabelWidgetClass::unsetSlidable ( )

Mark the slidable flag as not set.

Definition at line 164 of file mmslabelwidgetclass.cpp.

bool MMSLabelWidgetClass::getSlidable ( )

Get the slidable flag.

Returns:: true/false

Definition at line 168 of file mmslabelwidgetclass.cpp.

bool MMSLabelWidgetClass::isSlideSpeed ( )

Check if the slide speed is set.

Definition at line 172 of file mmslabelwidgetclass.cpp.

void MMSLabelWidgetClass::setSlideSpeed ( unsigned char slidespeed )

Set the slide speed.

Parameters:

slidespeed

speed in pixel per second

Definition at line 176 of file mmslabelwidgetclass.cpp.

void MMSLabelWidgetClass::unsetSlideSpeed ( )

Mark the slide speed as not set.

Definition at line 181 of file mmslabelwidgetclass.cpp.

unsigned char MMSLabelWidgetClass::getSlideSpeed ( )

Get the slide speed.

Returns:: slide speed

Definition at line 185 of file mmslabelwidgetclass.cpp.

bool MMSLabelWidgetClass::isTranslate ( )

Check if the translate flag is set.

Definition at line 190 of file mmslabelwidgetclass.cpp.

void MMSLabelWidgetClass::setTranslate ( bool translate )

Set the translate flag.

Parameters:

translate

true/false

Definition at line 194 of file mmslabelwidgetclass.cpp.

void MMSLabelWidgetClass::unsetTranslate ( )

Mark the translate flag as not set.

Definition at line 199 of file mmslabelwidgetclass.cpp.

bool MMSLabelWidgetClass::getTranslate ( )

Get the translate flag.

Returns:: true/false

Definition at line 203 of file mmslabelwidgetclass.cpp.

Friends And Related Function Documentation

friend class MMSThemeManager [friend]

Reimplemented from MMSTextBaseClass.

Definition at line 200 of file mmslabelwidgetclass.h.

friend class MMSDialogManager [friend]

Reimplemented from MMSTextBaseClass.

Definition at line 201 of file mmslabelwidgetclass.h.

Member Data Documentation

string MMSLabelWidgetClass::className [private]

name of the theme class

Definition at line 89 of file mmslabelwidgetclass.h.

bool MMSLabelWidgetClass::isslidable [private]

is slidable set?

Definition at line 92 of file mmslabelwidgetclass.h.

bool MMSLabelWidgetClass::slidable [private]

if true and size of the text string is greater than widget dimension, the text will slide over the widget

Definition at line 95 of file mmslabelwidgetclass.h.

bool MMSLabelWidgetClass::isslidespeed [private]

is slide speed set?

Definition at line 98 of file mmslabelwidgetclass.h.

unsigned int MMSLabelWidgetClass::slidespeed [private]

slide speed used if slidable set to true

Definition at line 101 of file mmslabelwidgetclass.h.

bool MMSLabelWidgetClass::istranslate [private]

is translate set?

Definition at line 104 of file mmslabelwidgetclass.h.

bool MMSLabelWidgetClass::translate [private]

if true the text will be translated before displayed

Definition at line 107 of file mmslabelwidgetclass.h.

MMSWidgetClass MMSLabelWidgetClass::widgetClass

stores base widget attributes

Definition at line 122 of file mmslabelwidgetclass.h.

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

MMSLabelWidgetClass Class Reference

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation