A class for controlling MenuBar components.
More...
#include <juce_MenuBarModel.h>
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.
- See also
- MenuBarModel::Listener, MenuBarComponent, PopupMenu
◆ MenuBarModel()
| MenuBarModel::MenuBarModel |
( |
| ) |
|
|
noexcept |
◆ ~MenuBarModel()
| virtual MenuBarModel::~MenuBarModel |
( |
| ) |
|
|
virtual |
◆ addListener()
| void MenuBarModel::addListener |
( |
Listener * |
listenerToAdd | ) |
|
|
noexcept |
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.
- See also
- removeListener
◆ applicationCommandInvoked()
◆ applicationCommandListChanged()
| void MenuBarModel::applicationCommandListChanged |
( |
| ) |
|
|
overridevirtual |
◆ cancelPendingUpdate()
| void AsyncUpdater::cancelPendingUpdate |
( |
| ) |
|
|
noexceptinherited |
This will stop any pending updates from happening.
If called after triggerAsyncUpdate() and before the handleAsyncUpdate() callback happens, this will cancel the handleAsyncUpdate() callback.
Note that this method simply cancels the next callback - if a callback is already in progress on a different thread, this won't block until the callback finishes, so there's no guarantee that the callback isn't still running when the method returns.
◆ getMacExtraAppleItemsMenu()
| static const PopupMenu* MenuBarModel::getMacExtraAppleItemsMenu |
( |
| ) |
|
|
static |
OSX ONLY - Returns the menu that was last passed as the extraAppleMenuItems argument to setMacMainMenu(), or nullptr if none was specified.
◆ getMacMainMenu()
OSX ONLY - Returns the menu model that is currently being shown as the main menu bar.
◆ getMenuBarNames()
This method must return a list of the names of the menus.
◆ getMenuForIndex()
| virtual PopupMenu MenuBarModel::getMenuForIndex |
( |
int |
topLevelMenuIndex, |
|
|
const String & |
menuName |
|
) |
| |
|
pure virtual |
This should return the popup menu to display for a given top-level menu.
- Parameters
-
| topLevelMenuIndex | the index of the top-level menu to show |
| menuName | the name of the top-level menu item to show |
◆ handleAsyncUpdate()
| void MenuBarModel::handleAsyncUpdate |
( |
| ) |
|
|
overridevirtual |
◆ handleMenuBarActivate()
| void MenuBarModel::handleMenuBarActivate |
( |
bool |
isActive | ) |
|
◆ handleUpdateNowIfNeeded()
| void AsyncUpdater::handleUpdateNowIfNeeded |
( |
| ) |
|
|
inherited |
If an update has been triggered and is pending, this will invoke it synchronously.
Use this as a kind of "flush" operation - if an update is pending, the handleAsyncUpdate() method will be called immediately; if no update is pending, then nothing will be done.
Because this may invoke the callback, this method must only be called on the main event thread.
◆ isUpdatePending()
| bool AsyncUpdater::isUpdatePending |
( |
| ) |
const |
|
noexceptinherited |
Returns true if there's an update callback in the pipeline.
◆ menuBarActivated()
| virtual void MenuBarModel::menuBarActivated |
( |
bool |
isActive | ) |
|
|
virtual |
This is called when the user starts/stops navigating the menu bar.
- Parameters
-
| isActive | true when the user starts navigating the menu bar |
◆ menuItemsChanged()
| void MenuBarModel::menuItemsChanged |
( |
| ) |
|
◆ menuItemSelected()
| virtual void MenuBarModel::menuItemSelected |
( |
int |
menuItemID, |
|
|
int |
topLevelMenuIndex |
|
) |
| |
|
pure virtual |
This is called when a menu item has been clicked on.
- Parameters
-
| 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) |
◆ removeListener()
| void MenuBarModel::removeListener |
( |
Listener * |
listenerToRemove | ) |
|
|
noexcept |
◆ setApplicationCommandManagerToWatch()
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.
◆ setMacMainMenu()
| static void MenuBarModel::setMacMainMenu |
( |
MenuBarModel * |
newMenuBarModel, |
|
|
const PopupMenu * |
extraAppleMenuItems = nullptr, |
|
|
const String & |
recentItemsMenuName = String() |
|
) |
| |
|
static |
OSX 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 nullptr 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.
If the recentItemsMenuName parameter is non-empty, then any sub-menus with this name will be replaced by OSX's special recent-files menu.
◆ triggerAsyncUpdate()
| void AsyncUpdater::triggerAsyncUpdate |
( |
| ) |
|
|
inherited |
Causes the callback to be triggered at a later time.
This method returns immediately, having made sure that a callback to the handleAsyncUpdate() method will occur as soon as possible.
If an update callback is already pending but hasn't happened yet, calls to this method will be ignored.
It's thread-safe to call this method from any number of threads without needing to worry about locking.
◆ listeners
◆ manager
The documentation for this class was generated from the following file:
1.8.13