class MASKING_DLL_DECLSPEC Label

Label is a very simple widget for creating both static and dynamic textual labels.

Inheritance:

Label - Widget - Rect

Public Methods

Label()

default constructor

~Label()

destructor

void Setup(int x, int y, int w, int h, int key, int flags, const char* text, int a=0)

Shortcut for Widget::Setup, SetText and SetAlignment

virtual void SetText(const char* t)

Sets the text string the label is supposed to print out

virtual void SetNumber(int value)

The label can render numbers as well as normal text.

virtual void SetNumber(double value)

See Setnumber (int)

virtual char* GetText()

Returns the label's text

virtual int GetInt()

This function attempts to convert as much of the text as possible to an integer.

virtual double GetDouble()

This function attempts to convert as much of the text as possible to a double.

virtual void SetAlignment(int a)

Sets the alignment method the label should use to render text.

virtual int GetAlignment()

returns the current alignment

virtual void AlignLeft()

Shortcut for SetAlignment (0);

virtual void AlignRight()

Shortcut for SetAlignment (1);

virtual void AlignCentre()

Shortcut for SetAlignment (2);

virtual void SetVAlignment(int value)

Sets the vertical alignment.

virtual int GetVAlignment()

returns the current vertical alignment setting

virtual bool GetWordWrap()

returns the current word-wrapping setting

virtual void SetWordWrap(bool value)

turns word-wrapping on or off

virtual int GetPreferredHeight()

Calculates and returns the height required to print the entire text with the current font and at the current width

Protected Methods

void MsgInitSkin()

Sets the text background and font colours to the default skin values

virtual void UpdateSize()

If the D_AUTOSIZE flag is set this function resizes the label to the length and height of the text

void Draw(Bitmap &canvas)

Renders the text to the canvas.

Documentation

Label is a very simple widget for creating both static and dynamic textual labels. It can display multi-line text with automatic wordwrapping. It treats newline characters as hard line breaks.

The label can automatically resize itself to the length and height of the text and can render the text with transparent background which is perfect for static text because it minimizes the chances of redraw but if you want a label that changes dynamically (for example to display the value of a slider or the current time) this doesn't work to well because when the text changes and the label is redrawn the old text can show through. In that case you should clear the D_AUTOSIZE flag, set the text's size to the maximum length of the text you expect to display and set the text background with the SetTextMode() function.

note: the autosize option doesn't work well with non left-aligned labels.

void MsgInitSkin()

Sets the text background and font colours to the default skin values

virtual void UpdateSize()

If the D_AUTOSIZE flag is set this function resizes the label to the length and height of the text

void Draw(Bitmap &canvas)

Renders the text to the canvas. If the text mode colour is different than -1 it first fills the canvas with this colour then it renders the text. If the size of the widget is different from the size of the actual text, the text is horizontally aligned according to the alignment settings and is centered vertically.

Label()

default constructor

~Label()

destructor

void Setup(int x, int y, int w, int h, int key, int flags, const char* text, int a=0)

Shortcut for Widget::Setup, SetText and SetAlignment

virtual void SetText(const char* t)

Sets the text string the label is supposed to print out

virtual void SetNumber(int value)

The label can render numbers as well as normal text. Pass an integer or a double and the label will render them as text. It will even make sure that just enough decimal places are rendered for doubles.

virtual void SetNumber(double value)

See Setnumber (int)

virtual char* GetText()

Returns the label's text

virtual int GetInt()

This function attempts to convert as much of the text as possible to an integer. If the text doesn't represent a number, 0 is returned.

virtual double GetDouble()

This function attempts to convert as much of the text as possible to a double. If the text doesn't represent a number, 0 is returned.

virtual void SetAlignment(int a)

Sets the alignment method the label should use to render text. Valid values for a are 0 for left alignment, 1 for right alignment and 2 for centered text. Note that this has meaning only if the D_AUTOSIZE flag is turned off. By default it isn't which means the label will automatically resize itself to the length and height of the text.

virtual int GetAlignment()

returns the current alignment

virtual void AlignLeft()

Shortcut for SetAlignment (0);

virtual void AlignRight()

Shortcut for SetAlignment (1);

virtual void AlignCentre()

Shortcut for SetAlignment (2);

virtual void SetVAlignment(int value)

Sets the vertical alignment. Possible values are 0 for top alignment, 1 for bottom and 2 for vertical centre.

virtual int GetVAlignment()

returns the current vertical alignment setting

virtual bool GetWordWrap()

returns the current word-wrapping setting

virtual void SetWordWrap(bool value)

turns word-wrapping on or off

virtual int GetPreferredHeight()

Calculates and returns the height required to print the entire text with the current font and at the current width

Direct child classes:

FPS
EditBox
Button

Alphabetic index Hierarchy of classes