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

===== Toolbar Tab Constructor =====

----

==== Description ====

Constructs a toolbar tab gui object. Tab after being constructed needs to be added to the toolbar for it to be visible in the application.

  * Toolbar Tab Name - //string//

==== Examples ====

  * <code lua> local tab1 = gui.ToolbarTab("Tab1")</code>

----
===== Add Group =====

----

==== Description ====

Add Toolbar Group to the tab of the given **name** and **width** or by pointer to existing toolbar group. Width is optional and is by default 3 cols long.

  * Toolbar Group Label - //string// , Width - //int// (Number of Columns)
    * returns //ToolbarGroup// 
  * Pointer to Toolbar Group - //ToolbarGroup//

==== Examples ====

  * <code lua> local group1 = tab1:addGroup("Group1") </code>
  * <code lua> local group2 = tab1:addGroup("Group2", 4) </code>
  * <code lua> local group1 = gui.ToolbarGroup("Group3")
 tab1:addGroup(group1) </code>

----

===== Find Group =====

----

==== Description ====

Find toolbar group in tab by group label.

  * Toolbar Group Label - //string//
    * returns //ToolbarGroup// 

==== Examples ====

  * <code lua> local group1 = tab1:groupByName("Group1") </code>

----

===== Label =====

----

==== Description ====

Get and set label for the toolbar tab.

==== Examples ====

  * <code lua> message(tab1:label()) </code>
  * <code lua> tab1:setLabel("New Tab")</code>

----

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

----

==== Description ====

Enable or disable the toolbar tab.

==== Examples ====

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

----

===== Remove =====

----

==== Description ====

Remove the current toolbat tab from the toolbar.

==== Examples ====

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

----

===== Add Button =====

----

==== Description ====

Add Toolbar Button to the tab by passing in Toolbar Button object and name of group to add button to.

  * Pointer to Toolbar Button - //ToolbarButton// , Toolbar Group Name - //string//

==== Examples ====

  * <code lua> tab1:addButton(button1, "Modify") </code>

----

===== Get Group =====

----

==== Description ====

Get Toolbar Group by name from the tab.

  * Toolbar Group Label - //string//
    * returns //ToolbarGroup//

==== Examples ====

  * <code lua> local group1 = tab1:groupByName("Group1") </code>

----

===== List of all groups =====

----

==== Description ====

Return list containing all groups in the tab.

==== Examples ====

  * <code lua> local groupsList = tab1:groups() </code>

----

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

----

==== Description ====

Find toolbar button in the group of the given name in the tab.

  * Toolbar Group object - //ToolbarGroup// , Toolbar Button Label - //string//
    * returns //ToolbarButton//

==== Examples ====

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

----

===== Remove Group =====

----

==== Description ====

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

  * Toolbar Group object - //ToolbarGroup//
  * Label of Toolbar Group - //string//

==== Examples ====

  * <code lua> tab1:removeGroup("Group1") </code>
  * <code lua> tab1:removeGroup(group1) </code>

----