MityDSP::tcGuiDisplay Class Reference

#include <ggui/gui_display.h>

Inheritance diagram for MityDSP::tcGuiDisplay:

List of all members.

Public Member Functions
	tcGuiDisplay (const char *name, tcBench *bench, int idd)
	~tcGuiDisplay ()
virtual bool	ParseXML (TiXmlElement *ahDom)
void	create ()
void	set_animate (bool animate)
void	set_normal_fg_color (tsRgb color)
void	set_error_fg_color (tsRgb color)
void	set_warn_fg_color (tsRgb color)
void	set_normal_bg_color (tsRgb color, bool trans)
void	set_error_bg_color (tsRgb color, bool trans)
void	set_warn_bg_color (tsRgb color, bool trans)
void	set_text (const char *text)
void	set_max_chars (uint8 max_chars)
int	get_max_chars (void) const
void	set_status (DISPLAY_STATUS status)
tsRgb	get_normal_fg_color ()
tsRgb	get_error_fg_color ()
tsRgb	get_warn_fg_color ()
tsRgb	get_normal_bg_color ()
tsRgb	get_error_bg_color ()
tsRgb	get_warn_bg_color ()
bool	does_l_mouse ()
void	animate ()
void	draw (tcGuiDspDisplay &pd)

---

Detailed Description

The tcGuiDisplay class is derived tcGuiObject class implementing a text label widget that includes some animation features and a programmable background highlighting color for error states including NORMAL, WARNING, and ERROR.

See also:

tcGuiDisplay Page

---

Constructor & Destructor Documentation

tcGuiDisplay::tcGuiDisplay	(	const char *	name,
		tcBench *	bench,
		int	idd
	)

Constructor

Parameters:

	name	Object ID name from the XML file.
	bench	The Controlling tcBench object for this widget.
	name	The windows control ID that we assigned to this control.

tcGuiDisplay::~tcGuiDisplay

(

)

Destructor

---

Member Function Documentation

bool tcGuiDisplay::ParseXML

(

TiXmlElement *

apElement

)

[virtual]

Parse common XML elements from the DOM.

Reimplemented from MityDSP::tcGuiObject.

void tcGuiDisplay::create

(

)

[virtual]

This function creates the text display control.

Note:

This function is called after all of the XML file settings are read.

Reimplemented from MityDSP::tcGuiObject.

void MityDSP::tcGuiDisplay::set_animate

(

bool

animate

)

[inline, virtual]

Reimplemented from MityDSP::tcGuiObject.

void MityDSP::tcGuiDisplay::set_normal_fg_color

(

tsRgb

color

)

[inline]

void MityDSP::tcGuiDisplay::set_error_fg_color

(

tsRgb

color

)

[inline]

void MityDSP::tcGuiDisplay::set_warn_fg_color

(

tsRgb

color

)

[inline]

void MityDSP::tcGuiDisplay::set_normal_bg_color	(	tsRgb	color,
		bool	trans
	)			[inline]

void MityDSP::tcGuiDisplay::set_error_bg_color	(	tsRgb	color,
		bool	trans
	)			[inline]

void MityDSP::tcGuiDisplay::set_warn_bg_color	(	tsRgb	color,
		bool	trans
	)			[inline]

void tcGuiDisplay::set_text

(

const char *

text

)

[virtual]

This function modifies the display text

Note:

This function differs from the xml_set_text() function in that it will modify the actual windows control. This is called after display creation, usually from within the script virtual machine.

Parameters:

text

The new text for the display

Reimplemented from MityDSP::tcGuiObject.

void tcGuiDisplay::set_max_chars

(

uint8

max_chars

)

Set the maximum number of characters to display prior to wrapping/scrolling.

Parameters:

max_chars

The new maximum number of characters

int MityDSP::tcGuiDisplay::get_max_chars

(

void

)

const [inline]

void tcGuiDisplay::set_status

(

DISPLAY_STATUS

status

)

Sets the current error status of the widget, which will update the displayed text colors and background.

Parameters:

status

new status to use for widget.

Note:

this routine will invalidate the widget if a status change is asserted.

tsRgb MityDSP::tcGuiDisplay::get_normal_fg_color

(

)

[inline]

tsRgb MityDSP::tcGuiDisplay::get_error_fg_color

(

)

[inline]

tsRgb MityDSP::tcGuiDisplay::get_warn_fg_color

(

)

[inline]

tsRgb MityDSP::tcGuiDisplay::get_normal_bg_color

(

)

[inline]

tsRgb MityDSP::tcGuiDisplay::get_error_bg_color

(

)

[inline]

tsRgb MityDSP::tcGuiDisplay::get_warn_bg_color

(

)

[inline]

bool MityDSP::tcGuiDisplay::does_l_mouse

(

)

[inline, virtual]

Reimplemented from MityDSP::tcGuiObject.

void tcGuiDisplay::animate

(

)

[virtual]

Handle display widget animation (scrolling, etc.). This method should be called periodically from the top level framework when the widget is visible.

Reimplemented from MityDSP::tcGuiObject.

void tcGuiDisplay::draw

(

tcGuiDspDisplay &

pd

)

[virtual]

This function draws the display

Parameters:

pd

reference to painting device context to render into.

Reimplemented from MityDSP::tcGuiObject.