Differences

This shows you the differences between two versions of the page.

--- dev:v3:gui_api:toolbar:toolbartab [2020/07/07 04:59] – created jedi18
+++ dev:v3:gui_api:toolbar:toolbartab [2020/07/07 08:29] (current) – jedi18
@@ Line 19: / Line 19: @@
 ----
-===== Add Toolbar Group =====
+===== Add Group =====
 ----
@@ Line 40: / Line 40: @@
 ----
-===== Remove Callback =====
+===== Find Group =====
 ----
@@ Line 46: / Line 46: @@
 ==== Description ====
-Remove lua function called associated with the given name. Only named callbacks can be removed.
+Find toolbar group in tab by group label.
-  * Callback name - //string//
+  * Toolbar Group Label - //string//
+    * returns //ToolbarGroup//
 ==== Examples ====
-  * <code lua> item1:removeCallback("message_callback") </code>
+  * <code lua> local group1 = tab1:groupByName("Group1") </code>
 ----
@@ Line 62: / Line 63: @@
 ==== Description ====
-Get and set label for the menu item.
+Get and set label for the toolbar tab.
 ==== Examples ====
-  * <code lua> message(item1:label()) </code>
+  * <code lua> message(tab1:label()) </code>
-  * <code lua> item1:setLabel("New Label")</code>
+  * <code lua> tab1:setLabel("New Tab")</code>
 ----
-===== Hide and Show =====
+===== Enable and Disable =====
 ----
@@ Line 77: / Line 78: @@
 ==== Description ====
-Hide or show the menu item.
+Enable or disable the toolbar tab.
 ==== Examples ====
-  * <code lua> item1:hide() </code>
+  * <code lua> tab1:enable() </code>
-  * <code lua> item1:show() </code>
+  * <code lua> tab1:disable() </code>
 ----
-===== Position =====
+===== Remove =====
 ----
@@ Line 92: / Line 93: @@
 ==== Description ====
-Get the current menu item position or set the menu item position. Other items are rearranged accordingly.
+Remove the current toolbat tab from the toolbar.
-  * New Position - //int//
+==== 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> local pos = item1:position() </code>
+  * <code lua> tab1:addButton(button1, "Modify") </code>
-  * <code lua> item1:setPosition(2) </code>
 ----
-===== Remove =====
+===== Get Group =====
 ----
@@ Line 109: / Line 123: @@
 ==== Description ====
-Remove the current menu item from the parent menu.
+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> item1:remove() </code>
+  * <code lua> tab1:removeGroup("Group1") </code>
+  * <code lua> tab1:removeGroup(group1) </code>
 ----

Wiki

User Tools

Site Tools

Differences

Page Tools