Showing the changes to interface/src/scripting/MenuScriptingInterface.h (1 of 2 files). Show all
Unified · Split
| @@ -26,7 +26,7 @@ class MenuItemProperties; · 25 unmodified lines | |||
| 26 | * <p>A "grouping" provides a way to group a set of menus or menu items together so that they can all be set visible or invisible | 26 | * <p>A "grouping" provides a way to group a set of menus or menu items together so that they can all be set visible or invisible |
| 27 | * as a group.</p> There is currently only one available group: <code>"Developer"</code>. This grouping can be toggled in the | 27 | * as a group.</p> There is currently only one available group: <code>"Developer"</code>. This grouping can be toggled in the |
| 28 | * "Settings" menu.</p> | 28 | * "Settings" menu.</p> |
| 29 | * <p>If a menu item doesn't belong to a group it is always displayed.</p> | 29 | * <p>If a menu item doesn't belong to a group, it is always displayed.</p> |
| 30 | * | 30 | * |
| 31 | * @namespace Menu | 31 | * @namespace Menu |
| 32 | * | 32 | * |
| @@ -85,7 +85,7 @@ public slots: · 52 unmodified lines | |||
| 85 | /**jsdoc | 85 | /**jsdoc |
| 86 | * Checks whether a top-level menu exists. | 86 | * Checks whether a top-level menu exists. |
| 87 | * @function Menu.menuExists | 87 | * @function Menu.menuExists |
| 88 | * @param {string} menuName - Name of the menu to check for existence. | 88 | * @param {string} menuName - Name of the menu to check exists. |
| 89 | * @returns {boolean} <code>true</code> if the menu exists, otherwise <code>false</code>. | 89 | * @returns {boolean} <code>true</code> if the menu exists, otherwise <code>false</code>. |
| 90 | * @example <caption>Check if the "Developer" menu exists.</caption> | 90 | * @example <caption>Check if the "Developer" menu exists.</caption> |
| 91 | * if (Menu.menuExists("Developer")) { | 91 | * if (Menu.menuExists("Developer")) { |
| @@ -98,7 +98,7 @@ public slots: · 6 unmodified lines | |||
| 98 | * Adds a separator with an unclickable label below it. The separator will be placed at the bottom of the menu. To add a | 98 | * Adds a separator with an unclickable label below it. The separator will be placed at the bottom of the menu. To add a |
| 99 | * separator at a specific point in the menu, use {@link Menu.addMenuItem} with {@link Menu.MenuItemProperties} instead. | 99 | * separator at a specific point in the menu, use {@link Menu.addMenuItem} with {@link Menu.MenuItemProperties} instead. |
| 100 | * @function Menu.addSeparator | 100 | * @function Menu.addSeparator |
| 101 | * @param {string} menuName - Name of the menu to add a separator to. | 101 | * @param {string} menuName - Name of the menu to add the separator to. |
| 102 | * @param {string} separatorName - Name of the separator that will be displayed as the label below the separator line. | 102 | * @param {string} separatorName - Name of the separator that will be displayed as the label below the separator line. |
| 103 | * @example <caption>Add a separator.</caption> | 103 | * @example <caption>Add a separator.</caption> |
| 104 | * Menu.addSeparator("Developer", "Test Separator"); | 104 | * Menu.addSeparator("Developer", "Test Separator"); |
| @@ -119,7 +119,7 @@ public slots: · 14 unmodified lines | |||
| 119 | * Adds a new menu item to a menu. The menu item is specified using {@link Menu.MenuItemProperties}. | 119 | * Adds a new menu item to a menu. The menu item is specified using {@link Menu.MenuItemProperties}. |
| 120 | * @function Menu.addMenuItem | 120 | * @function Menu.addMenuItem |
| 121 | * @param {Menu.MenuItemProperties} properties - Properties of the menu item to create. | 121 | * @param {Menu.MenuItemProperties} properties - Properties of the menu item to create. |
| 122 | * @example <caption>Add a menu item at a particular position in the "Develope"r menu.</caption> | 122 | * @example <caption>Add a menu item at a particular position in the "Developer" menu.</caption> |
| 123 | * Menu.addMenuItem({ | 123 | * Menu.addMenuItem({ |
| 124 | * menuName: "Developer", | 124 | * menuName: "Developer", |
| 125 | * menuItemName: "Test", | 125 | * menuItemName: "Test", |
| @@ -133,7 +133,7 @@ public slots: · 7 unmodified lines | |||
| 133 | * Adds a new menu item to a menu. The new item is added at the end of the menu. | 133 | * Adds a new menu item to a menu. The new item is added at the end of the menu. |
| 134 | * @function Menu.addMenuItem | 134 | * @function Menu.addMenuItem |
| 135 | * @variation 0 | 135 | * @variation 0 |
| 136 | * @param {string} menuName - Name of the menu to add a menu item to. | 136 | * @param {string} menuName - Name of the menu to add the menu item to. |
| 137 | * @param {string} menuItem - Name of the menu item. This is what will be displayed in the menu. | 137 | * @param {string} menuItem - Name of the menu item. This is what will be displayed in the menu. |
| 138 | * @param {string} [shortcutKey] A shortcut key that can be used to trigger the menu item. | 138 | * @param {string} [shortcutKey] A shortcut key that can be used to trigger the menu item. |
| 139 | * @example <caption>Add a menu item to the end of the "Developer" menu.</caption> | 139 | * @example <caption>Add a menu item to the end of the "Developer" menu.</caption> |
| @@ -147,6 +147,7 @@ public slots: · 7 unmodified lines | |||
| 147 | * @function Menu.removeMenuItem | 147 | * @function Menu.removeMenuItem |
| 148 | * @param {string} menuName - Name of the menu to remove a menu item from. | 148 | * @param {string} menuName - Name of the menu to remove a menu item from. |
| 149 | * @param {string} menuItem - Name of the menu item to remove. | 149 | * @param {string} menuItem - Name of the menu item to remove. |
| 150 | * @example <caption>Remove a menu item from the "Developer" menu.</caption> | ||
| 150 | * Menu.removeMenuItem("Developer", "Test"); | 151 | * Menu.removeMenuItem("Developer", "Test"); |
| 151 | */ | 152 | */ |
| 152 | void removeMenuItem(const QString& menuName, const QString& menuitem); | 153 | void removeMenuItem(const QString& menuName, const QString& menuitem); |