namespace lc::ui::api
The Input GUI class is the parent class of all input gui widgets (except button and checkbox) which is added to the dialog widget. This is an abstract class.
Get and set label for the Input GUI widget.
message(input1:label())
input1:setLabel("New Input GUI")
Enable or disable the input gui widget.
input1:enable()
input1:disable()
namespace lc::ui::api
The Angle GUI class is used to enter an angle. Angle can be toggled between radians and degrees by clicking on the Rad/Deg button or by using the appropriate functions. Needs to be added to the dialog widget to be used.
Constructs an angle gui widget.
local angle1 = gui.Angle("Angle1")
Used to get the current value of the angle widget or set it to a desired value.
Note:- Always returns and expects the value to be in RADIANS . If the current display mode is in degrees, the angle is converted to degrees and displayed. When retrieving the mode dosen't matter, always returns in radians.
local val = angle1:value()
angle1:setValue(1.56)
Used to switch the display mode to degrees, if the value is in radians it is automatically converted and shown in degrees.
angle1:toDegrees()
Used to switch the display mode to radians, if the value is in degrees it is automatically converted and shown in radians.
angle1:toRadians()
Add a finish callback which is called when the user presses enter after entering the angle or clicks somewhere else and the input gui loses focus. This is different from the dialog widget finish callback.
angle1:addFinishCallback(function() message("Finished typing angle") end)
Add an on change callback which is called when the user types anything i.e. on any change to the input.
angle1:addOnChangeCallback(function() message(tostring(angle1:value())) end)
namespace lc::ui::api
The Button GUI class is used to add a button to the dialog widget. Callbacks can be added to the button which is called when the button is clicked.
Constructs an button gui widget
local button1 = gui.Button("button1")
Add a callback to be called whenever the user clicks on the button.
button1:addCallback(function() message("Button Clicked") end)
namespace lc::ui::api
The RadioButton GUI class is used to add a RadioButton to a radio group of the dialog widget. Callbacks can be added to the button which is called when the radiobutton is checked.
Constructs a radiobutton gui widget.
local radio1 = gui.RadioButton("radio1")
Add a callback to be called whenever the user clicks on the button toggling it's checked state.
radio1:addCallback(function(toggled) message(tostring(toggled)) end)
Used to get and the set the value of the radio button i.e. toggle the checked state of the radio button.
local val = radio1:checked()
radio1:setChecked(false)
namespace lc::ui::api
The Checkbox GUI class is used to add a checkbox to the dialog widget. Callbacks can be added to the checkbox which is called when the checkbox is checked or unchecked.
Constructs an checkbox gui widget
local check1 = gui.CheckBox("check1")
Add a callback to be called whenever the user checks or unchecks the checkbox.Passes in a bool representing whether the button is checked or not.
check1:addCallback(function(checked) message("Checkbox is checked - " .. tostring(checked)) end)
Check if the checkbox is checked or set the checkbox to be checked/unchecked.
local isChecked = check1:checked()
check1:setChecked(true)
namespace lc::ui::api
The ComboBox GUI class is used to add a combobox to the dialog widget. Callbacks can be added to the checkbox which is called when a element is selected, the name of the selected element is passed as a parameter to the callback.
Constructs an combobox gui widget
local combo1 = gui.ComboBox("combo1")
Add a callback to be called whenever selects an element from the combobox.Passes in a string representing the name of the selected element in the combobox.
combo1:addCallback(function(selected) message("Selected Element - " .. tostring(selected)) end)
Used to get the current element string of the combobox widget or set it to a desired element. If the user attempts to set an element that does not exist in the combobox, nothing happens. Element can also be set by specifying the index of the element to be selected.
local val = combo1:value()
combo1:setValue("Element1")
combo1:setValue(0)
Add an item to the combobox, if index is not specified it is added to the end of the combobox list.
combo1:addItem("Element1", 2)
combo1:addItem("Element2")