#include <MenuManagerInterface.h>
Inherited by AzToolsFramework::MenuManager [private]
.
Public Member Functions | |
AZ_RTTI (MenuManagerInterface, "{D70B7989-62BD-447E-ADF6-0971EC4B7DEE}") | |
virtual MenuManagerOperationResult | RegisterMenu (const AZStd::string &menuIdentifier, const MenuProperties &properties)=0 |
virtual MenuManagerOperationResult | RegisterMenuBar (const AZStd::string &menuBarIdentifier, QMainWindow *mainWindow)=0 |
virtual bool | IsMenuRegistered (const AZStd::string &menuIdentifier) const =0 |
virtual MenuManagerOperationResult | AddActionToMenu (const AZStd::string &menuIdentifier, const AZStd::string &actionIdentifier, int sortIndex)=0 |
virtual MenuManagerOperationResult | AddActionsToMenu (const AZStd::string &menuIdentifier, const AZStd::vector< AZStd::pair< AZStd::string, int > > &actions)=0 |
virtual MenuManagerOperationResult | RemoveActionFromMenu (const AZStd::string &menuIdentifier, const AZStd::string &actionIdentifier)=0 |
virtual MenuManagerOperationResult | RemoveActionsFromMenu (const AZStd::string &menuIdentifier, const AZStd::vector< AZStd::string > &actionIdentifiers)=0 |
virtual MenuManagerOperationResult | AddSeparatorToMenu (const AZStd::string &menuIdentifier, int sortIndex)=0 |
virtual MenuManagerOperationResult | AddSubMenuToMenu (const AZStd::string &menuIdentifier, const AZStd::string &subMenuIdentifier, int sortIndex)=0 |
virtual MenuManagerOperationResult | AddSubMenusToMenu (const AZStd::string &menuIdentifier, const AZStd::vector< AZStd::pair< AZStd::string, int > > &subMenus)=0 |
virtual MenuManagerOperationResult | RemoveSubMenuFromMenu (const AZStd::string &menuIdentifier, const AZStd::string &subMenuIdentifier)=0 |
virtual MenuManagerOperationResult | RemoveSubMenusFromMenu (const AZStd::string &menuIdentifier, const AZStd::vector< AZStd::string > &subMenuIdentifiers)=0 |
virtual MenuManagerOperationResult | AddWidgetToMenu (const AZStd::string &menuIdentifier, const AZStd::string &widgetActionIdentifier, int sortIndex)=0 |
virtual MenuManagerOperationResult | AddMenuToMenuBar (const AZStd::string &menuBarIdentifier, const AZStd::string &menuIdentifier, int sortIndex)=0 |
virtual MenuManagerIntegerResult | GetSortKeyOfActionInMenu (const AZStd::string &menuIdentifier, const AZStd::string &actionIdentifier) const =0 |
virtual MenuManagerIntegerResult | GetSortKeyOfSubMenuInMenu (const AZStd::string &menuIdentifier, const AZStd::string &subMenuIdentifier) const =0 |
virtual MenuManagerIntegerResult | GetSortKeyOfWidgetInMenu (const AZStd::string &menuIdentifier, const AZStd::string &widgetActionIdentifier) const =0 |
virtual MenuManagerIntegerResult | GetSortKeyOfMenuInMenuBar (const AZStd::string &menuBarIdentifier, const AZStd::string &menuIdentifier) const =0 |
virtual MenuManagerOperationResult | DisplayMenuAtScreenPosition (const AZStd::string &menuIdentifier, const QPoint &screenPosition) const =0 |
virtual MenuManagerOperationResult | DisplayMenuUnderCursor (const AZStd::string &menuIdentifier) const =0 |
MenuManagerInterface Interface to register and manage menus in the Editor.
|
pure virtual |
Add multiple Actions to a Menu.
menuIdentifier | The identifier for the menu the actions are being added to. |
actions | A vector of pairs of identifiers for the actions to add to the menu and their sort position. |
|
pure virtual |
Add an Action to a Menu. Will prompt an update of the menu.
menuIdentifier | The identifier for the menu the action is being added to. |
actionIdentifier | The identifier for the action to add to the menu. |
sortIndex | An integer defining the position the action should appear in the menu. |
|
pure virtual |
Add a Menu to a Menu Bar.
menuBarIdentifier | The identifier for the menu bar the menu is being added to. |
menuIdentifier | The identifier for the menu to add to the menu bar. |
sortIndex | An integer defining the position the menu should appear in the menu bar. |
|
pure virtual |
Add a Separator to a Menu.
menuIdentifier | The identifier for the menu the separator is being added to. |
sortIndex | An integer defining the position the separator should appear in the menu. |
|
pure virtual |
Add multiple Sub-Menus to a Menu.
menuIdentifier | The identifier for the menu the sub-menus are being added to. |
actions | A vector of pairs of identifiers for the sub-menus to add to the menu and their sort position. |
|
pure virtual |
Add a Sub-Menu to a Menu.
menuIdentifier | The identifier for the menu the sub-menu is being added to. |
subMenuIdentifier | The identifier for the sub-menu to add to the menu. |
sortIndex | An integer defining the position the sub-menu should appear in the menu. |
|
pure virtual |
Add a Widget to a Menu.
menuIdentifier | The identifier for the menu the sub-menu is being added to. |
widgetActionIdentifier | The identifier to the widget to add to the menu. |
sortIndex | An integer defining the position the widget should appear in the menu. |
|
pure virtual |
Show the menu at the position provided.
menuIdentifier | The identifier for the menu to display. |
screenPosition | The position where the menu should appear. |
|
pure virtual |
Show the menu under the mouse cursor.
menuIdentifier | The identifier for the menu to display. |
|
pure virtual |
Retrieve the sort key of an action in a menu from its identifier.
menuIdentifier | The identifier for the menu to query. |
actionIdentifier | The identifier for the action whose sort key to get in the menu. |
|
pure virtual |
Retrieve the sort key of a sub-menu in a menu from its identifier.
menuBarIdentifier | The identifier for the menu bar to query. |
menuIdentifier | The identifier for the menu whose sort key to get in the menu bar. |
|
pure virtual |
Retrieve the sort key of a sub-menu in a menu from its identifier.
menuIdentifier | The identifier for the menu to query. |
subMenuIdentifier | The identifier for the sub-menu whose sort key to get in the menu. |
|
pure virtual |
Retrieve the sort key of a widget action in a menu from its identifier.
menuIdentifier | The identifier for the menu to query. |
widgetActionIdentifier | The identifier for the widget whose sort key to get in the menu. |
|
pure virtual |
Returns whether a menu with the identifier queried is registered to the Menu Manager.
menuIdentifier | The identifier for the menu to query. |
|
pure virtual |
Register a new Menu to the Menu Manager.
menuIdentifier | The identifier for the menu that is being registered. |
properties | The properties object for the newly registered menu. |
|
pure virtual |
Register a new Menu Bar to the Menu Manager.
menuBarIdentifier | The identifier for the menu bar that is being registered. |
mainWindow | Pointer to the QMainWindow to associate the menu bar with. |
|
pure virtual |
Removes an Action from a Menu.
menuIdentifier | The identifier for the menu the action is being removed from. |
actionIdentifier | The identifier for the action to remove from the menu. |
|
pure virtual |
Removes multiple Actions from a Menu.
menuIdentifier | The identifier for the menu the actions are being removed from. |
actionIdentifiers | A vector of identifiers for the actions to remove from the menu. |
|
pure virtual |
Removes a Sub-Menu from a Menu.
menuIdentifier | The identifier for the menu the sub-menu is being removed from. |
subMenuIdentifier | The identifier for the sub-menu to remove from the menu. |
|
pure virtual |
Removes multiple Sub-Menus from a Menu.
menuIdentifier | The identifier for the menu the sub-menus are being removed from. |
subMenuIdentifiers | A vector of identifiers for the sub-menus to remove from the menu. |