TextButton¶

class TextButton

A clickable button window with text

Hierarchy

class TextButton < class Window

Members

Methods:

nil

buttonclicked

( )

The buttonclicked method is called when the user clicked the button

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

nil buttonclicked ( )

The buttonclicked method is called when the user clicked the button

This method is a callback to be implemented if you want the TextButton to react to user clicking the button.

local mybutton = ui.textbutton ("mybutton", parent, "Ok")

mybutton:setx (0)

mybutton:sety (0)

mybutton:setw (0, 1)

mybutton:seth (20)

function mybutton:buttonclicked ()

    print ("mybutton was clicked")

end