Toolbar Button GUI Class

Github Link

 namespace lc::ui::api 

Constructs a toolbar button gui object. Button after being constructed needs to be added to a group for it to be visible in the application.

• Toolbar Button Name - string , Icon Path - string , Lua Callback - kaguya::LuaRef , Tooltip(Default = “”) - string , Checkable(Default = false) - bool
• Toolbar Button Name - string , Icon Path - string , Tooltip(Default = “”) - string , Checkable(Default = false) - bool

•  local button1 = gui.ToolbarButton("Button1", "icon_path", function() message("Test") end) 

•  local button1 = gui.ToolbarButton("Button1", "icon_path") 

•  local button1 = gui.ToolbarButton("Button1", "icon_path", function() message("Test") end), "Tooltip", true) 

Add lua function callback to be called when the toolbar button is clicked. Multiple callbacks can be added. Callbacks can also be named callbacks i.e. associated with a name so that it can be later removed by use of the name.

• Lua Callback - kaguya::LuaRef
• Callback name - string , Lua Callback - kaguya::LuaRef

•  button1:addCallback(function() run_command("LINE") end) 

•  button1:addCallback("message_callback", function() message("Test") end) 

Remove lua function called associated with the given name. Only named callbacks can be removed.

• Callback name - string

•  button1:removeCallback("message_callback") 

Set the tooltip for the button.

• New tooltip - string

•  button1:setTooltip("New Tooltip") 

Get and set label for the toolbar button.

•  message(button1:label()) 

•  button1:setLabel("New Button")

Enable or disable the toolbar button.

•  button1:enable() 

•  button1:disable() 

Hide or show the toolbar button.

•  button1:hide() 

•  button1:show() 

Remove the current toolbar button from the group.

•  button1:remove() 

Return if the button is checkable or not.

•  local isCheckable = button1:checkable()