Provides the necessary functionalities and properties to a Widget to display static text.
See Also
Static Variables
Name | Description |
widget | Parent Widget where the Label component is defined. |
Declaration
|
length | Total amount of characters currently cached. |
Declaration
|
font | Reference to the Font used by the active Label. |
Declaration
|
size | Size of the string in pixels based on the current Font used by the Label. |
Declaration
|
Variables
Name | Description |
margin | Specify the margin to use when drawing the Label. |
Declaration
|
centered | Determine if the string of the Label should be centered. |
Declaration
|
selection | The current text selection represented by the character index where the selection begin (X component) and the end index (Y component). |
Declaration
|
highlight | Similar as selection; this property provides a way to visually highlight a sub-string. |
Declaration
|
string | The current text the Label should display. |
Declaration
|
Functions
Name | Description |
WordWrap | Force words that are end up outside of the Label width to be placed on the next line. |
Declaration
|
GetAlignment | Helper that return the Label alignment size in pixels taking in consideration if its margin and centered state. |
Declaration ivec2 GetAlignment( void )
|
SetFont | Set the Font to use to draw the Label string. |
Declaration void SetFont( Font *font ) Parameters
font : Reference to an existing Font.
|