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:

[legend]List of all members.

Public Types
enum	STYLE {   STYLE_NoScrollBars = 0x0000, STYLE_ScrollH = 0x0001, STYLE_ScrollV = 0x0002, STYLE_ScrollBoth = (STYLE_ScrollH|STYLE_ScrollV),   STYLE_WidthInPixels = 0x0004 }
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)
	CTRL_TEXT ()
CEdit &	GetCtrl ()
void	SetSelection (int StartChar=0, int EndChar=-1, bool NoScroll=true)
void	SetString (const MIUNICODE *string)
void	SetTabStops (SIMPLE_ARRAY< int > stops)
void	SetTabStops (int cxEachStop)

---

Detailed Description

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

Definition at line 2510 of file ctrl.h.

---

Member Enumeration Documentation

enum MGUI::CTRL_TEXT::STYLE

Style for text control. Enumeration values: STYLE_NoScrollBars  STYLE_ScrollH  STYLE_ScrollV  STYLE_ScrollBoth  STYLE_WidthInPixels  Definition at line 2514 of file ctrl.h.

---

Constructor & Destructor Documentation

MGUI::CTRL_TEXT::CTRL_TEXT (   )  [inline]

Constructor. Definition at line 2523 of file ctrl.h.

---

Member Function Documentation

void MGUI::CTRL_TEXT::Clear (   )

Clear the text.

void MGUI::CTRL_TEXT::ClearSelection (   )  [inline]

Clear the current selection. Definition at line 2535 of file ctrl.h.

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

CEdit& MGUI::CTRL_TEXT::GetCtrl (   )  [inline]

Get reference to MFC control (MFC only). Definition at line 2553 of file ctrl.h.

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

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 Definition at line 2558 of file ctrl.h.

void MGUI::CTRL_TEXT::SetString (  const MIUNICODE *  string  )

Set text to display. Parameters: string  String to display

void MGUI::CTRL_TEXT::SetTabStops (  SIMPLE_ARRAY< int >  stops  )  [inline]

Set variable tab stops. When text is copied to a multiple-line edit control, any tab character in the text will cause space to be generated up to the next tab stop. The default is one tab stop every 32 dialog units. Parameters: stops  Array of stops Definition at line 2588 of file ctrl.h.

void MGUI::CTRL_TEXT::SetTabStops (  int  cxEachStop  )  [inline]

Set equal tab stops (MFC only); When text is copied to a multiple-line edit control, any tab character in the text will cause space to be generated up to the next tab stop. The default is one tab stop every 32 dialog units. Parameters: cxEachStop  tab stops are to be set at every cxEachStop dialog units Definition at line 2578 of file ctrl.h.

---

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

• mgui/ctrl.h

---