Wiki

User Tools

Site Tools

Trace:
dev:v3:gui_api:menu:main_window

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
dev:v3:gui_api:menu:main_window [2020/07/06 14:29] – [Description] jedi18dev:v3:gui_api:menu:main_window [2020/07/06 14:39] (current) – [Main Window Menu GUI API Functions] jedi18
Line 1: Line 1:
 ====== Main Window Menu GUI API Functions ====== ====== Main Window Menu GUI API Functions ======
 [[https://github.com/LibreCAD/LibreCAD_3/blob/master/lcUI/mainwindow.h|Github Link]] [[https://github.com/LibreCAD/LibreCAD_3/blob/master/lcUI/mainwindow.h|Github Link]]
-<code cpp-qt> namespace lc::ui::api </code>+<code lua> namespace lc::ui::api </code>
 ---- ----
  
Line 12: Line 12:
 Add a menu to the MenuBar of the Main Window. Menu is an instance of the Menu GUI class. Add a menu to the MenuBar of the Main Window. Menu is an instance of the Menu GUI class.
 Will not add if another menu of the same label already exists in the menu bar. Will not add if another menu of the same label already exists in the menu bar.
-//Note :- Menu of same label may exist in a menu inside a menu of the menu bar i.e. more than one level away from the menu bar.+\\ Note :- Menu of same label may exist in a menu inside a menu of the menu bar i.e. more than one level away from the menu bar.
  
-  * Menu Name +  * Menu Name - //string// 
-  * Pointer to Menu GUI object+  * Pointer to Menu GUI object - //menu gui object//
  
 ==== Examples ==== ==== Examples ====
Line 30: Line 30:
 ==== Description ==== ==== Description ====
  
-Return pointer to menu of the given name or position present in the menu bar.+Return pointer to menu of the given **name** or **position** present in the menu bar. Returns nullptr if not present.
  
-  * <code cpp-qt> lc::ui::api::Menu* menuByName(const std::string& menuName) </code>   +  * Menu Label - //string// 
-     * Get menu by name/label +  * Menu Position - //int// (Starting from 0 on the left most menu)
-     * Parameters :- +
-       - Menu Name - **Name/Label** of the menu to be returned. +
-     * Returns :- +
-       * **Pointer to the menu** of the given name in the menu bar. +
- +
- +
-  * <code cpp-qt> lc::ui::api::Menu* menuByPosition(int pos) </code>   +
-     * Get menu by position +
-     * Parameters :- +
-       - Position (int) - **Position** of the menu in the menu bar (Starting from 0 on the left most menu) +
-     * Returns :- +
-       - **Pointer to menu** of the given position in the menu bar.+
  
 ==== Examples ==== ==== Examples ====
Line 60: Line 48:
 ==== Description ==== ==== Description ====
  
-Remove menu of the given name or at the given position from the menu bar. Does nothing if menu does not exist in the menu bar.+Remove menu of the given **name** or at the given **position** from the menu bar. Does nothing if menu does not exist in the menu bar.
  
-  * <code cpp-qt> void removeMenu(const char* menuLabel) </code>   +  * Menu Label - //string// 
-     * Remove menu of the given name/label +  * Menu Position - //int// (Starting from 0 as the left most menu)
-     * Parameters :- +
-       - Menu Name - **Name/Label** of the menu to be removed. +
- +
- +
-  * <code cpp-qt> void removeMenu(int position) </code>   +
-     * Remove menu at the given position in the menu bar. +
-     * Parameters :- +
-       - Position (int) - **Position** of the menu in the menu bar (Starting from 0 on the left most menu)+
  
 ==== Examples ==== ==== Examples ====
Line 88: Line 68:
 Find and return the first menu item found of the given **label**/**object name** present in any of the menus recursively (menu bar as well as menus inside other menus). Find and return the first menu item found of the given **label**/**object name** present in any of the menus recursively (menu bar as well as menus inside other menus).
  
-  * <code cpp-qt> lc::ui::api::MenuItem* findMenuItem(std::string label) </code>   +  * Menu Item Label - //string// 
-     * Find menu item of the given label +  * Menu Item Qt Object Name - //string//
-     * Parameters :- +
-       - Menu Item Name - **Name/Label** of the menu item to be found. +
-     * Returns :- +
-       - **Pointer to menu item** found of the given label. +
- +
- +
-  * <code cpp-qt> lc::ui::api::MenuItem* findMenuItemByObjectName(std::string objectName) </code>   +
-     * Find menu item of the given qt object name. +
-     * Parameters :- +
-       - Object name - **Qt object name** of the menu item to be found. +
-     * Returns :- +
-       - **Pointer to menu item** found of the given object name.+
 ==== Examples ==== ==== Examples ====
  
dev/v3/gui_api/menu/main_window.1594045788.txt.gz · Last modified: 2020/07/06 14:29 by jedi18

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki