MGUI::GADGET_TEXTBLOCK Class Reference

Simple textblock gadget with tooltip support. More...

Inheritance diagram for MGUI::GADGET_TEXTBLOCK:

Public Member Functions
	GADGET_TEXTBLOCK (MGUI::TOOLCANVAS *pCanvas, PLACEMENT PlacementsAllowed, FLAGS flags=FLAG_None, CANVASDEVICES CanvasDevices=CANVASDEVICE_Memory)
	~GADGET_TEXTBLOCK ()
const TEXTSTYLE &	GetTextStyle () const
void	SetText (const MISTRING &text)
void	SetTextColorBG (const COLOR &color)
void	SetTextColorFG (const COLOR &color)
void	SetTextFont (const MISTRING &FontName)
void	SetTextSize (UINT16 TextSize)
void	SetTextStyle (const TEXTSTYLE &style)
void	SetToolTip (const MISTRING &tooltip)

Detailed Description

Simple textblock gadget with tooltip support.

MGUI::GADGET_TEXTBLOCK::GADGET_TEXTBLOCK	(	MGUI::TOOLCANVAS *	pCanvas,
		PLACEMENT	PlacementsAllowed,
		FLAGS	flags = `FLAG_None`,
		CANVASDEVICES	CanvasDevices = `CANVASDEVICE_Memory`
	)

Contructor.

Parameters:

	pCanvas	Canvas to contain gadget
	PlacementsAllowed	Allowed placements

MGUI::GADGET_TEXTBLOCK::~GADGET_TEXTBLOCK ( )

Destructor.

const TEXTSTYLE& MGUI::GADGET_TEXTBLOCK::GetTextStyle ( ) const [inline]

Get complete text style.

void MGUI::GADGET_TEXTBLOCK::SetText ( const MISTRING & text ) [inline]

Set text string.

void MGUI::GADGET_TEXTBLOCK::SetTextColorBG ( const COLOR & color )

Set text background color.

Will automatically set halo style based on whether transparent or not.

void MGUI::GADGET_TEXTBLOCK::SetTextColorFG ( const COLOR & color )

Set text foreground color.

void MGUI::GADGET_TEXTBLOCK::SetTextFont ( const MISTRING & FontName )

Set text font.

Will use default font if not specified.

void MGUI::GADGET_TEXTBLOCK::SetTextSize ( UINT16 TextSize )

Set text size in pixels.

void MGUI::GADGET_TEXTBLOCK::SetTextStyle ( const TEXTSTYLE & style ) [inline]

Set complete text style.

void MGUI::GADGET_TEXTBLOCK::SetToolTip ( const MISTRING & tooltip ) [inline]

Set tooltip string.

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