MityDSP::tcFrameBench Class Reference

Inheritance diagram for MityDSP::tcFrameBench:

List of all members.

Public Member Functions
	tcFrameBench (void)
	~tcFrameBench (void)
void	print (const char *fmt,...)
void	invalidate (tcRect &rect, tcRect *bckgrnd_redraw=NULL)
int	GetInvalidRegion (tcRect &rect)
tcView *	GetView (const char *apViewName)
Public Member Functions inherited from MityDSP::tcBench
	tcBench ()
virtual	~tcBench ()
void	register_display (tcGuiDspDisplay *display)
void	register_font (const tsFontDecl &fd, bool default_font=false)
void	register_font (tcDspFont *apFont, bool default_font=false)
void	register_image (const char *name, const tcBitmap &bmp)
int	open_text (const char *apXmlText)
int	open_file (const char *apXmlFile)
int	open (const char *apXml, bool abIsFileName=false)
void	set_update_rate (int update_rate_ms)
int	get_update_rate_ms ()
teGuiResult	lbutton_down (int x, int y)
bool	lbutton_up (int x, int y)
bool	mouse_move (int x, int y, int flags)
virtual teGuiLock	check_obj_lock (int id)
tcDspFont *	get_default_font ()
virtual void	draw ()
virtual void	draw (tcRect &rect)
virtual void	animate ()
int	show_first_view ()
int	show_view (const char *name)
const char *	current_view ()
const char *	first_view ()
const char *	next_view (const char *name)
tcGuiObject *	find_object (const char *name)
const tcBitmap *	find_image (const char *name)
const tcBitmap *	find_image (const GSTRING &name)
void	add_object (tcGuiObject *apObject)
int	get_font_align (const char *name)
tsRgb	find_color (const char *name)
tsRgb	find_color (GSTRING &name)
tsRgb *	find_color_def (const char *name)
tsRgb *	find_color_def (GSTRING &name)
tcDspFont *	find_font_def (const char *name)
tcDspFont *	find_font_def (GSTRING &name)
int	find_offset (const char *name)
int	find_offset (GSTRING &name)
int *	find_offset_def (const char *name)
int *	find_offset_def (GSTRING &name)
tcGuiImage *	add_image_def_name (const char *id_str)

Protected Attributes
LCK_Handle	mhLock
	MityDSP Lock Handle for thread safe invalidation.
tcRect	mcInvalidRect [5]
	the effecitive invalide region requiring painting.
int	mnNumActiveRects
Protected Attributes inherited from MityDSP::tcBench
tcGuiDspDisplay *	m_display
GUIOBJ_LIST *	m_object_list
tcRawImageList *	m_image_list
tcViewList	m_view_list
tcView *	m_current_view
tcDspFont *	m_default_font
int	m_current_color_id
uint32	m_num_colors
GSTRING	m_color_names [MAX_COLOR_DEFS]
tsRgb	m_color_defs [MAX_COLOR_DEFS]
GSTRING	m_font_names [MAX_FONT_DEFS]
tcDspFont *	m_font_defs [MAX_FONT_DEFS]
uint32	m_num_fonts
int	m_offset_defs [MAX_OFFSET_DEFS]
int	m_current_offset_id
uint32	m_num_offsets
GSTRING	m_offset_names [MAX_OFFSET_DEFS]
int	m_current_idd
int	m_update_rate_ms
tcGuiRadioGroup *	m_current_radiogroup
char	mpActiveFont [MAX_FN_LENGTH]

Additional Inherited Members
Public Attributes inherited from MityDSP::tcBench
tcGuiObject *	m_lcapture_object
Protected Member Functions inherited from MityDSP::tcBench
virtual void	display_object_cleanup ()
tsRgb	scan_color (const char *string)
int	find_offset_name (const char *name)
int	find_offset_name (GSTRING &name)
int	scan_offset (const char *string)
uint32	add_color_def_name (const char *id_str)
uint32	add_offset_def_name (const char *id_str)
uint32	add_region_def_name (const char *id_str)

---

Detailed Description

The tcFrameBench class provides an implementation of the ggui tcBench framwork class, which is responsible for managing all GUI objects and views in a ggui based system. The tcFrameBench implementation primarily is responsible for managing invalidation requests and provides hooks for debug print information.

This class is used internally by the tcGuiFramework class instantiations.

---

Constructor & Destructor Documentation

tcFrameBench::tcFrameBench

(

void

)

Constructor.

tcFrameBench::~tcFrameBench

(

void

)

Destructor (typically not reached)

---

Member Function Documentation

void tcFrameBench::print ( const char *  fmt,   ...  )

virtual

Debug method used to route error messages generated by the GGUI library (primariy during parsing of the skin.xml file) to the tcDspError::report() method provided by the MityDSP core library. See tcDspError for further information.

Parameters:

[in]

fmt

printf style format for following arguments.

Implements MityDSP::tcBench.

void tcFrameBench::invalidate ( tcRect &  rect, tcRect *  bckgrnd_redraw = NULL  )

virtual

Main screen invalidation routine.

In it's current implementation, the main Framework manages a single invalidation rectangle. For GUI events that generate multiple invalidation areas within on paint event, the rectangles are effectively or'ed together.

Parameters:

[in]	rect	rectangular area (in screen coordinates) to be invalidated
[in]	bckgrnd_redraw	currently not used.

Note:

this routine is thread safe.

Implements MityDSP::tcBench.

int tcFrameBench::GetInvalidRegion

(

tcRect &

rect

)

Acquires the final invalid rectangle that has been invalidated for the given refresh period. This routine clears the working invalid rectangle update return, so subsequent invalidations start from an empty (0 width/hieght) rectangle.

Parameters:

[out]

rect

final rectangle structure to be filled in.

Note:

this routine is thread safe.

tcView* MityDSP::tcFrameBench::GetView ( const char *  apViewName )

inline

Utility method to get a named XML view (or screen).

Parameters:

apViewName

name of the view to acquire

Returns:

valid view or NULL if no view with specified name is found.

---

Member Data Documentation

LCK_Handle MityDSP::tcFrameBench::mhLock

protected

MityDSP Lock Handle for thread safe invalidation.

tcRect MityDSP::tcFrameBench::mcInvalidRect[5]

protected

the effecitive invalide region requiring painting.

int MityDSP::tcFrameBench::mnNumActiveRects

protected