MGUI::CTRL_TEXT Class Reference

Control to display non-editable multi-line text in optionally scrollable view. More...

#include <mgui/ctrl.h>

Inheritance diagram for MGUI::CTRL_TEXT:

Public Types
enum	STYLE { STYLE_NoScrollBars = 0x0000, STYLE_ScrollH = 0x0001, STYLE_ScrollV = 0x0002, STYLE_ScrollBoth = (STYLE_ScrollH\|STYLE_ScrollV), STYLE_WidthInPixels = 0x0004, STYLE_NoFrame = 0x0008, STYLE_NoMargin = 0x0010 }
Public Member Functions
void	Clear ()
void	ClearSelection ()
void	Create (MGUI::LAYOUT_PANE_BASE &ParentPane, int width=40, int height=10, STYLE style=STYLE_NoScrollBars, MGUI::LAYOUT_SIZEALIGN sizealign=MGUI::LAYOUT_SIZEALIGN_Expand)
void	SetSelection (int StartChar=0, int EndChar=-1, bool NoScroll=true)
void	SetString (const MISTRING &string)

Detailed Description

Control to display non-editable multi-line text in optionally scrollable view.

Style for text control.

Enumerator:

STYLE_NoScrollBars
STYLE_ScrollH
STYLE_ScrollV
STYLE_ScrollBoth
STYLE_WidthInPixels
STYLE_NoFrame	Don't include frame around control.
STYLE_NoMargin	Don't include margin around control.

void MGUI::CTRL_TEXT::Clear ( )

Constructor.

Clear the text.

void MGUI::CTRL_TEXT::ClearSelection ( )

Clear the current selection.

void MGUI::CTRL_TEXT::Create	(	MGUI::LAYOUT_PANE_BASE &	ParentPane,
		int	width = `40`,
		int	height = `10`,
		STYLE	style = `STYLE_NoScrollBars`,
		MGUI::LAYOUT_SIZEALIGN	sizealign = `MGUI::LAYOUT_SIZEALIGN_Expand`
	)

Create control.

Parameters:

	ParentPane	Parent pane
	width	Width in characters or pixels per style flags
	height	Height in text lines
	style	Scroll bar display style

void MGUI::CTRL_TEXT::SetSelection	(	int	StartChar = `0`,
		int	EndChar = `-1`,
		bool	NoScroll = `true`
	)

Select range of characters in string.

Parameters:

	StartChar	Starting character position in string, 0 for beginning
	EndChar	Ending character position, -1 for end of string
	NoScroll	Indicates whether to scroll caret into view

void MGUI::CTRL_TEXT::SetString ( const MISTRING & string )

Set text to display.

Parameters:

string

String to display

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