text label widget. More...
Inheritance diagram for Label:
Public Member Functions | |
| Label (string name) | |
| creates a label widget on the user inteface. More... | |
Public Attributes | |
| string | align |
| text alignement: "centred" | "left"| "right" | "top" | "bottom" | "topLeft" | "topRight" | "bottomLeft" | "bottomRight" | |
| number | alpha |
| transparency value between 0.0 and 1.0 | |
| string | backgroundColour |
| background colour: colour string that defines the desired colour. It can be either a named colour like "blue" or "red" or an hexadecimal string in RGB ("#FF00CC") or ARGB ("#3C00FECD") format | |
| string | backgroundColourWhenEditing |
| background colour when editing: colour string that defines the desired colour. It can be either a named colour like "blue" or "red" or an hexadecimal string in RGB ("#FF00CC") or ARGB ("#3C00FECD") format | |
| table | bounds |
| widget bounding rect {x,y,width,height} | |
| function | changed |
| callback function used by child widgets to be notified of changes | |
| string | displayName |
| widget display name | |
| bool | editable |
| whether the label text field can be edited. default value is false | |
| bool | enabled |
| boolean flag to enable / disable the widget | |
| string | font |
| path to TrueType font | |
| number | fontSize |
| font size | |
| int | height |
| widget height in pixels | |
| bool | interceptsMouseClicks |
| boolean flag to toggle mouse handling on widget | |
| float | minimumHorizontalScale |
| specifies the minimum amount that the font can be squashed horizontally before it starts using ellipsis. 0 for a default value. 1 for no stretching | |
| string | name |
| widget name | |
| bool | persistent |
| flag to tell if the widget values should be serialized when saving. True by default. Persistent widgets will call their changed function on reload | |
| table | position |
| widget position {x,y} | |
| bool | showLabel |
| show widgets label if any | |
| table | size |
| widget size {width, height} | |
| string | text |
| text to display on screen | |
| string | textColour |
| textColour: colour string that defines the desired colour. It can be either a named colour like "blue" or "red" or an hexadecimal string in RGB ("#FF00CC") or ARGB ("#3C00FECD") format | |
| string | textColourWhenEditing |
| textColour when editing: colour string that defines the desired colour. It can be either a named colour like "blue" or "red" or an hexadecimal string in RGB ("#FF00CC") or ARGB ("#3C00FECD") format | |
| string | tooltip |
| widget tooltip, default is name | |
| bool | visible |
| boolean flag to toggle widget visibility | |
| int | width |
| widget width in pixels | |
| int | x |
| x position in pixels | |
| int | y |
| y position in pixels | |
Detailed Description
text label widget.
creates a label widget on the user inteface.
l = Label("label")
l.text = "a long description"
l.align = "left"
l.backgroundColour = "black"
l.textColour = "orange"
Constructor & Destructor Documentation
| Label::Label | ( | string | name) |
creates a label widget on the user inteface.
- Parameters
-
name the name to give to the widget