MMSTextBoxWidgetClass Class Reference

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

#include <mmstextboxwidgetclass.h>

Inheritance diagram for MMSTextBoxWidgetClass:


Public Member Functions
	MMSTextBoxWidgetClass ()
	Constructor of class MMSTextBoxWidgetClass.
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	isWrap ()
	Check if the wrap flag is set.
void	setWrap (bool wrap)
	Set the wrap flag.
void	unsetWrap ()
	Mark the wrap flag as not set.
bool	getWrap ()
	Get the wrap flag.
bool	isSplitWords ()
	Check if splitwords is set.
void	setSplitWords (bool splitwords)
	Set the splitwords flag.
void	unsetSplitWords ()
	Mark splitwords as not set.
bool	getSplitWords ()
	Get the splitwords flag.
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.
bool	isFilePath ()
	Check if the filepath is set.
void	setFilePath (string filepath)
	Set the filepath which is used to load the text.
void	unsetFilePath ()
	Mark the filepath as not set.
string	getFilePath ()
	Get the filepath which is used to load the text.
bool	isFileName ()
	Check if the filename is set.
void	setFileName (string filename)
	Set the filename which is used to load the text.
void	unsetFileName ()
	Mark the filename as not set.
string	getFileName ()
	Get the filename which is used to load the text.
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	iswrap
	is wrap flag set?
bool	wrap
	wrap (true/false) the text
bool	issplitwords
	is splitwords flag set?
bool	splitwords
	splitwords (true/false)
bool	istranslate
	is translate set?
bool	translate
	if true the text will be translated before displayed
bool	isfilepath
	is filepath set?
string	filepath
	path to the file
bool	isfilename
	is filename set?
string	filename
	name of the file
Friends
class	MMSThemeManager
class	MMSDialogManager

Detailed Description

A data access class for the textbox widget.

This class is the base for the MMSTextBoxWidget 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 MMSTextBoxWidget.

Author:: Jens Schneider

Definition at line 90 of file mmstextboxwidgetclass.h.

Constructor & Destructor Documentation

MMSTextBoxWidgetClass::MMSTextBoxWidgetClass ( )

Constructor of class MMSTextBoxWidgetClass.

Definition at line 46 of file mmstextboxwidgetclass.cpp.

Member Function Documentation

void MMSTextBoxWidgetClass::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 60 of file mmstextboxwidgetclass.cpp.

void MMSTextBoxWidgetClass::unsetAll ( ) [virtual]

Mark all attributes as not set.

Reimplemented from MMSTextBaseClass.

Definition at line 50 of file mmstextboxwidgetclass.cpp.

void MMSTextBoxWidgetClass::setClassName ( string className )

Set the name of the theme class.

Parameters:

classname

name of the class

Definition at line 172 of file mmstextboxwidgetclass.cpp.

string MMSTextBoxWidgetClass::getClassName ( )

Get the name of the theme class.

Returns:: name of the class

Definition at line 176 of file mmstextboxwidgetclass.cpp.

bool MMSTextBoxWidgetClass::isWrap ( )

Check if the wrap flag is set.

Definition at line 181 of file mmstextboxwidgetclass.cpp.

void MMSTextBoxWidgetClass::setWrap ( bool wrap )

Set the wrap flag.

Parameters:

wrap

wrap the text if set to true

Definition at line 185 of file mmstextboxwidgetclass.cpp.

void MMSTextBoxWidgetClass::unsetWrap ( )

Mark the wrap flag as not set.

Definition at line 190 of file mmstextboxwidgetclass.cpp.

bool MMSTextBoxWidgetClass::getWrap ( )

Get the wrap flag.

Returns:: wrap flag

Definition at line 194 of file mmstextboxwidgetclass.cpp.

bool MMSTextBoxWidgetClass::isSplitWords ( )

Check if splitwords is set.

Definition at line 198 of file mmstextboxwidgetclass.cpp.

void MMSTextBoxWidgetClass::setSplitWords ( bool splitwords )

Set the splitwords flag.

Parameters:

splitwords

split words at the end of a line

Note:: This works only if the wrap flag is set.

Definition at line 202 of file mmstextboxwidgetclass.cpp.

void MMSTextBoxWidgetClass::unsetSplitWords ( )

Mark splitwords as not set.

Definition at line 207 of file mmstextboxwidgetclass.cpp.

bool MMSTextBoxWidgetClass::getSplitWords ( )

Get the splitwords flag.

Returns:: splitwords flag

Definition at line 211 of file mmstextboxwidgetclass.cpp.

bool MMSTextBoxWidgetClass::isTranslate ( )

Check if the translate flag is set.

Definition at line 216 of file mmstextboxwidgetclass.cpp.

void MMSTextBoxWidgetClass::setTranslate ( bool translate )

Set the translate flag.

Parameters:

translate

true/false

Definition at line 220 of file mmstextboxwidgetclass.cpp.

void MMSTextBoxWidgetClass::unsetTranslate ( )

Mark the translate flag as not set.

Definition at line 225 of file mmstextboxwidgetclass.cpp.

bool MMSTextBoxWidgetClass::getTranslate ( )

Get the translate flag.

Returns:: true/false

Definition at line 229 of file mmstextboxwidgetclass.cpp.

bool MMSTextBoxWidgetClass::isFilePath ( )

Check if the filepath is set.

Definition at line 233 of file mmstextboxwidgetclass.cpp.

void MMSTextBoxWidgetClass::setFilePath ( string filepath )

Set the filepath which is used to load the text.

Parameters:

filepath

path to the file

Definition at line 237 of file mmstextboxwidgetclass.cpp.

void MMSTextBoxWidgetClass::unsetFilePath ( )

Mark the filepath as not set.

Definition at line 242 of file mmstextboxwidgetclass.cpp.

string MMSTextBoxWidgetClass::getFilePath ( )

Get the filepath which is used to load the text.

Returns:: path to the file

Definition at line 246 of file mmstextboxwidgetclass.cpp.

bool MMSTextBoxWidgetClass::isFileName ( )

Check if the filename is set.

Definition at line 250 of file mmstextboxwidgetclass.cpp.

void MMSTextBoxWidgetClass::setFileName ( string filename )

Set the filename which is used to load the text.

Parameters:

filename

name of the file

Definition at line 254 of file mmstextboxwidgetclass.cpp.

void MMSTextBoxWidgetClass::unsetFileName ( )

Mark the filename as not set.

Definition at line 259 of file mmstextboxwidgetclass.cpp.

string MMSTextBoxWidgetClass::getFileName ( )

Get the filename which is used to load the text.

Returns:: name of the file

Definition at line 263 of file mmstextboxwidgetclass.cpp.

Friends And Related Function Documentation

friend class MMSThemeManager [friend]

Reimplemented from MMSTextBaseClass.

Definition at line 249 of file mmstextboxwidgetclass.h.

friend class MMSDialogManager [friend]

Reimplemented from MMSTextBaseClass.

Definition at line 250 of file mmstextboxwidgetclass.h.

Member Data Documentation

string MMSTextBoxWidgetClass::className [private]

name of the theme class

Definition at line 93 of file mmstextboxwidgetclass.h.

bool MMSTextBoxWidgetClass::iswrap [private]

is wrap flag set?

Definition at line 96 of file mmstextboxwidgetclass.h.

bool MMSTextBoxWidgetClass::wrap [private]

wrap (true/false) the text

Definition at line 99 of file mmstextboxwidgetclass.h.

bool MMSTextBoxWidgetClass::issplitwords [private]

is splitwords flag set?

Definition at line 102 of file mmstextboxwidgetclass.h.

bool MMSTextBoxWidgetClass::splitwords [private]

splitwords (true/false)

Definition at line 105 of file mmstextboxwidgetclass.h.

bool MMSTextBoxWidgetClass::istranslate [private]

is translate set?

Definition at line 108 of file mmstextboxwidgetclass.h.

bool MMSTextBoxWidgetClass::translate [private]

if true the text will be translated before displayed

Definition at line 111 of file mmstextboxwidgetclass.h.

bool MMSTextBoxWidgetClass::isfilepath [private]

is filepath set?

Definition at line 114 of file mmstextboxwidgetclass.h.

string MMSTextBoxWidgetClass::filepath [private]

path to the file

Definition at line 117 of file mmstextboxwidgetclass.h.

bool MMSTextBoxWidgetClass::isfilename [private]

is filename set?

Definition at line 120 of file mmstextboxwidgetclass.h.

string MMSTextBoxWidgetClass::filename [private]

name of the file

Definition at line 123 of file mmstextboxwidgetclass.h.

MMSWidgetClass MMSTextBoxWidgetClass::widgetClass

stores base widget attributes

Definition at line 137 of file mmstextboxwidgetclass.h.

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

MMSTextBoxWidgetClass 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