A class for controlling MenuBar components. More...
Inherits AsyncUpdater, and ApplicationCommandManagerListener.
Classes | |
| class | Listener |
| A class to receive callbacks when a MenuBarModel changes. More... | |
Public Member Functions | |
| MenuBarModel () noexcept | |
| virtual | ~MenuBarModel () |
| Destructor. | |
| void | menuItemsChanged () |
| Call this when some of your menu items have changed. | |
| void | setApplicationCommandManagerToWatch (ApplicationCommandManager *manager) noexcept |
| Tells the menu bar to listen to the specified command manager, and to update itself when the commands change. | |
| void | addListener (Listener *listenerToAdd) noexcept |
| Registers a listener for callbacks when the menu items in this model change. | |
| void | removeListener (Listener *listenerToRemove) noexcept |
| Removes a listener. | |
| virtual const StringArray | getMenuBarNames ()=0 |
| This method must return a list of the names of the menus. | |
| virtual const PopupMenu | getMenuForIndex (int topLevelMenuIndex, const String &menuName)=0 |
| This should return the popup menu to display for a given top-level menu. | |
| virtual void | menuItemSelected (int menuItemID, int topLevelMenuIndex)=0 |
| This is called when a menu item has been clicked on. | |
| void | applicationCommandInvoked (const ApplicationCommandTarget::InvocationInfo &info) |
| Called when an app command is about to be invoked. | |
| void | applicationCommandListChanged () |
| Called when commands are registered or deregistered from the command manager, or when commands are made active or inactive. | |
| void | handleAsyncUpdate () |
| Called back to do whatever your class needs to do. | |
Static Public Member Functions | |
| static void | setMacMainMenu (MenuBarModel *newMenuBarModel, const PopupMenu *extraAppleMenuItems=nullptr) |
| MAC ONLY - Sets the model that is currently being shown as the main menu bar at the top of the screen on the Mac. | |
| static MenuBarModel * | getMacMainMenu () |
| MAC ONLY - Returns the menu model that is currently being shown as the main menu bar. | |
A class for controlling MenuBar components.
This class is used to tell a MenuBar what menus to show, and to respond to a menu being selected.
| MenuBarModel::MenuBarModel | ( | ) |
| virtual MenuBarModel::~MenuBarModel | ( | ) | [virtual] |
Destructor.
| void MenuBarModel::menuItemsChanged | ( | ) |
Call this when some of your menu items have changed.
This method will cause a callback to any MenuBarListener objects that are registered with this model.
If this model is displaying items from an ApplicationCommandManager, you can use the setApplicationCommandManagerToWatch() method to cause change messages to be sent automatically when the ApplicationCommandManager is changed.
| void MenuBarModel::setApplicationCommandManagerToWatch | ( | ApplicationCommandManager * | manager ) |
Tells the menu bar to listen to the specified command manager, and to update itself when the commands change.
This will also allow it to flash a menu name when a command from that menu is invoked using a keystroke.
| void MenuBarModel::addListener | ( | Listener * | listenerToAdd ) |
Registers a listener for callbacks when the menu items in this model change.
The listener object will get callbacks when this object's menuItemsChanged() method is called.
| void MenuBarModel::removeListener | ( | Listener * | listenerToRemove ) |
Removes a listener.
| virtual const StringArray MenuBarModel::getMenuBarNames | ( | ) | [pure virtual] |
This method must return a list of the names of the menus.
| virtual const PopupMenu MenuBarModel::getMenuForIndex | ( | int | topLevelMenuIndex, |
| const String & | menuName | ||
| ) | [pure virtual] |
This should return the popup menu to display for a given top-level menu.
| topLevelMenuIndex | the index of the top-level menu to show |
| menuName | the name of the top-level menu item to show |
| virtual void MenuBarModel::menuItemSelected | ( | int | menuItemID, |
| int | topLevelMenuIndex | ||
| ) | [pure virtual] |
This is called when a menu item has been clicked on.
| menuItemID | the item ID of the PopupMenu item that was selected |
| topLevelMenuIndex | the index of the top-level menu from which the item was chosen (just in case you've used duplicate ID numbers on more than one of the popup menus) |
| static void MenuBarModel::setMacMainMenu | ( | MenuBarModel * | newMenuBarModel, |
| const PopupMenu * | extraAppleMenuItems = nullptr |
||
| ) | [static] |
MAC ONLY - Sets the model that is currently being shown as the main menu bar at the top of the screen on the Mac.
You can pass 0 to stop the current model being displayed. Be careful not to delete a model while it is being used.
An optional extra menu can be specified, containing items to add to the top of the apple menu. (Confusingly, the 'apple' menu isn't the one with a picture of an apple, it's the one next to it, with your application's name at the top and the services menu etc on it). When one of these items is selected, the menu bar model will be used to invoke it, and in the menuItemSelected() callback the topLevelMenuIndex parameter will be -1. If you pass in an extraAppleMenuItems object then newMenuBarModel must be non-null.
| static MenuBarModel* MenuBarModel::getMacMainMenu | ( | ) | [static] |
MAC ONLY - Returns the menu model that is currently being shown as the main menu bar.
| void MenuBarModel::applicationCommandInvoked | ( | const ApplicationCommandTarget::InvocationInfo & | info ) | [virtual] |
Called when an app command is about to be invoked.
Implements ApplicationCommandManagerListener.
| void MenuBarModel::applicationCommandListChanged | ( | ) | [virtual] |
Called when commands are registered or deregistered from the command manager, or when commands are made active or inactive.
Note that if you're using this to watch for changes to whether a command is disabled, you'll need to make sure that ApplicationCommandManager::commandStatusChanged() is called whenever the status of your command might have changed.
Implements ApplicationCommandManagerListener.
| void MenuBarModel::handleAsyncUpdate | ( | ) | [virtual] |
Called back to do whatever your class needs to do.
This method is called by the message thread at the next convenient time after the triggerAsyncUpdate() method has been called.
Implements AsyncUpdater.
