TextΒΆ

class Text

A static text window, that can display text with user defined style, font and color

Hierarchy

class Text < class Window

Children classes : class Edit

Members

Methods:

string text gettext ( ) Get the Text window text string
nil setcolor ( ui.color color ) Set the Text window color
nil setfont ( string|nil font , number size ) Set the Text window font and size.
nil setshadow ( ui.color shadowcolor , number shadowdistance ) Set the Text window shadowing properties
nil settext ( string text ) Set the Text window text string to display

Inherited from class Window

Methods:

nil destroy ( ) Destroy the window and all its children windows
nil setx ( number x , number parentpivot , number pivot ) Set the X window placement
nil sety ( number y , number parentpivot , number pivot ) Set the Y window placement
nil setw ( number w , number parentmul , number childadd , number childmul ) Set the window width
nil seth ( number h , number parentmul , number childadd , number childmul ) Set the window height
nil getx ( ) Get the window X coordinate in the parent space
nil gety ( ) Get the window Y coordinate in the parent space
nil getw ( ) Get the window width
nil geth ( ) Get the window height
nil hide ( ) Hide the window
nil show ( ) Show the window
nil disable ( ) Disable the window
nil enable ( ) Enable the window
nil addtracker ( table tracker ) Add a tracker to this window. A tracker receives notification when the tracked window is invalidated or destroyed. A tracker may implement onTrackedDestroyed and onTrackedInvalidated to get notifications on such events
nil removetracker ( table tracker ) Remove a tracker of this window.
nil setcolor ( ui.color color ) Change the window color, see also ui.color function
nil getparent ( string|nil parentclass ) Get the first parent window of given class (immediate parent if no class is provided)
nil settopmost ( ) Set the window as top most in children order
nil getchild ( string|number name ) Get a child window
Window container getcontainer ( ) Get the main container of a window
nil settitle ( string name ) Change the window title
nil setfocus ( ) Set the focus to the window
nil getroot ( ) Return the root window of this window

Documentation

string text gettext ( )

Get the Text window text string

Return:

  • text The window text

nil setcolor ( ui.color color )

Set the Text window color

Arguments:

  • color The text color

nil setfont ( string|nil font , number size )

Set the Text window font and size.

This function changes the text font properties. Note that font names are system dependent. Use Text.normal and Text.bold to use predefined fonts.
Arguments:

  • font The text font face name, or nil for default font
  • size The text size

nil setshadow ( ui.color shadowcolor , number shadowdistance )

Set the Text window shadowing properties

Arguments:

  • shadowcolor The text shadow color
  • shadowdistance The text shadow distance in pixels

nil settext ( string text )

Set the Text window text string to display

Arguments:

  • text The text to display