====== Toolbar Group GUI Class ======
[[https://github.com/LibreCAD/LibreCAD_3/blob/master/lcUI/widgets/guiAPI/toolbargroup.h|Github Link]]
<code cpp-qt> namespace lc::ui::api </code>
----

===== Toolbar Group Constructor =====

----

==== Description ====

Constructs a toolbar group gui object. Group after being constructed needs to be added to a tab for it to be visible in the application. Width is optional, by default width is 3.

  * Toolbar Group Name - //string//
  * Toolbar Group Name - //string// , Width - //int//

==== Examples ====

  * <code lua> local group1 = gui.ToolbarGroup("Group1") </code>
  * <code lua> local group1 = gui.ToolbarGroup("Group1", 4) </code>

----
===== Add Button =====

----

==== Description ====

Add Toolbar Button to the group of the given **name** and **icon** or by pointer to existing toolbar group. Toolbar button callback can also be passed in.

  * Toolbar Button Label - //string// , Icon path - //string//
    * returns //ToolbarButton// 
  * Toolbar Button Label - //string// , Icon path - //string// , Lua Callback - //kaguya::LuaRef//
    * returns //ToolbarButton//
  * Pointer to Toolbar Button - //ToolbarButton//

==== Examples ====

  * <code lua> local button1 = group1:addButton("Button1", "path_to_icon") </code>
  * <code lua> local button1 = group1:addButton("Button1", "path_to_icon", function() message("Button clicked") end) </code>
  * <code lua> local button1 = gui.ToolbarButton("Button1", "path_to_icon")
 group1:addButton(button1)</code>

----

===== Find Button =====

----

==== Description ====

Find toolbar button in group by button label.

  * Toolbar Button Label - //string//
    * returns //ToolbarButton// 

==== Examples ====

  * <code lua> local button1 = group1:buttonByName("Button1") </code>

----

===== Label =====

----

==== Description ====

Get and set label for the toolbar group.

==== Examples ====

  * <code lua> message(group1:label()) </code>
  * <code lua> group1:setLabel("New Group")</code>

----

===== Enable and Disable =====

----

==== Description ====

Enable or disable the toolbar group.

==== Examples ====

  * <code lua> group1:enable() </code>
  * <code lua> group1:disable() </code>

----

===== Hide and Show =====

----

==== Description ====

Hide or show the toolbar group.

==== Examples ====

  * <code lua> group1:hide() </code>
  * <code lua> group1:show() </code>

----

===== Remove =====

----

==== Description ====

Remove the current toolbar group from the tab.

==== Examples ====

  * <code lua> group1:remove() </code>

----

===== List of all buttons =====

----

==== Description ====

Return list containing all buttons in the group.

==== Examples ====

  * <code lua> local buttonList = group1:buttons() </code>

----

===== Remove Button =====

----

==== Description ====

Remove button of the given name or by passing in a toolbar button object.

  * Toolbar Button object - //ToolbarButton//
  * Label of Toolbar Button - //string//

==== Examples ====

  * <code lua> group1:removeButton("Button1") </code>
  * <code lua> group1:removeButton(button1) </code>

----

===== Width =====

----

==== Description ====

Get and set width of the toolbar group. Buttons are rearranged when width is changed.

==== Examples ====

  * <code lua> local w = group1:width() </code>
  * <code lua> group1:setWidth(2) </code>

----