A class for controlling MenuBar components. More...

#include <juce_MenuBarModel.h>

Inheritance diagram for juce::MenuBarModel:

Collaboration diagram for juce::MenuBarModel:

[legend]

Classes
class	Listener
	A class to receive callbacks when a MenuBarModel changes. More...

Public Member Functions
	MenuBarModel () noexcept

	~MenuBarModel () override
	Destructor. More...

void	addListener (Listener *listenerToAdd)
	Registers a listener for callbacks when the menu items in this model change. More...

void	applicationCommandInvoked (const ApplicationCommandTarget::InvocationInfo &) override

void	applicationCommandListChanged () override

virtual StringArray	getMenuBarNames ()=0
	This method must return a list of the names of the menus. More...

virtual PopupMenu	getMenuForIndex (int topLevelMenuIndex, const String &menuName)=0
	This should return the popup menu to display for a given top-level menu. More...

void	handleAsyncUpdate () override

void	handleMenuBarActivate (bool isActive)

virtual void	menuBarActivated (bool isActive)
	This is called when the user starts/stops navigating the menu bar. More...

void	menuItemsChanged ()
	Call this when some of your menu items have changed. More...

virtual void	menuItemSelected (int menuItemID, int topLevelMenuIndex)=0
	This is called when a menu item has been clicked on. More...

void	removeListener (Listener *listenerToRemove)
	Removes a listener. More...

void	setApplicationCommandManagerToWatch (ApplicationCommandManager *manager)
	Tells the menu bar to listen to the specified command manager, and to update itself when the commands change. More...

Static Public Member Functions
static const PopupMenu *	getMacExtraAppleItemsMenu ()
	OSX ONLY - Returns the menu that was last passed as the extraAppleMenuItems argument to setMacMainMenu(), or nullptr if none was specified. More...

static MenuBarModel *	getMacMainMenu ()
	OSX ONLY - Returns the menu model that is currently being shown as the main menu bar. More...

static void	setMacMainMenu (MenuBarModel newMenuBarModel, const PopupMenu extraAppleMenuItems=nullptr, const String &recentItemsMenuName=String())
	OSX ONLY - Sets the model that is currently being shown as the main menu bar at the top of the screen on the Mac. More...

Private Member Functions
void	cancelPendingUpdate () noexcept
	This will stop any pending updates from happening. More...

void	handleUpdateNowIfNeeded ()
	If an update has been triggered and is pending, this will invoke it synchronously. More...

bool	isUpdatePending () const noexcept
	Returns true if there's an update callback in the pipeline. More...

void	triggerAsyncUpdate ()
	Causes the callback to be triggered at a later time. More...

Private Attributes
ListenerList< Listener >	listeners

ApplicationCommandManager *	manager

Detailed Description

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

{GUI}

Constructor & Destructor Documentation

◆ MenuBarModel()

juce::MenuBarModel::MenuBarModel ( )

noexcept

◆ ~MenuBarModel()

juce::MenuBarModel::~MenuBarModel ( )

override

Destructor.

Member Function Documentation

◆ addListener()

void juce::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.

See also: removeListener

◆ applicationCommandInvoked()

void juce::MenuBarModel::applicationCommandInvoked ( const ApplicationCommandTarget::InvocationInfo & )

overridevirtual

Implements juce::ApplicationCommandManagerListener.

◆ applicationCommandListChanged()

void juce::MenuBarModel::applicationCommandListChanged ( )

overridevirtual

Implements juce::ApplicationCommandManagerListener.

◆ cancelPendingUpdate()

void juce::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* juce::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()

static MenuBarModel* juce::MenuBarModel::getMacMainMenu ( )

static

OSX ONLY - Returns the menu model that is currently being shown as the main menu bar.

◆ getMenuBarNames()

virtual StringArray juce::MenuBarModel::getMenuBarNames ( )

pure virtual

This method must return a list of the names of the menus.

◆ getMenuForIndex()

virtual PopupMenu juce::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 juce::MenuBarModel::handleAsyncUpdate ( )

overridevirtual

Implements juce::AsyncUpdater.

◆ handleMenuBarActivate()

void juce::MenuBarModel::handleMenuBarActivate ( bool isActive )

◆ handleUpdateNowIfNeeded()

void juce::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 juce::AsyncUpdater::isUpdatePending ( ) const

noexceptinherited

Returns true if there's an update callback in the pipeline.

◆ menuBarActivated()

virtual void juce::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 juce::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.

See also: addListener, removeListener, MenuBarListener

◆ menuItemSelected()

virtual void juce::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 juce::MenuBarModel::removeListener ( Listener * listenerToRemove )

Removes a listener.

See also: addListener

◆ setApplicationCommandManagerToWatch()

void juce::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.

◆ setMacMainMenu()

static void juce::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 juce::AsyncUpdater::triggerAsyncUpdate ( )

inherited

Causes the callback to be triggered at a later time.

This method returns immediately, after which a callback to the handleAsyncUpdate() method will be made by the message thread as soon as possible.

If an update callback is already pending but hasn't happened yet, calling this method will have no effect.

It's thread-safe to call this method from any thread, BUT beware of calling it from a real-time (e.g. audio) thread, because it involves posting a message to the system queue, which means it may block (and in general will do on most OSes).

Member Data Documentation

◆ listeners

ListenerList<Listener> juce::MenuBarModel::listeners

private

◆ manager

ApplicationCommandManager* juce::MenuBarModel::manager

private

The documentation for this class was generated from the following file:

juce_MenuBarModel.h

Classes

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MenuBarModel()

◆ ~MenuBarModel()

Member Function Documentation

◆ addListener()

◆ applicationCommandInvoked()

◆ applicationCommandListChanged()

◆ cancelPendingUpdate()

◆ getMacExtraAppleItemsMenu()

◆ getMacMainMenu()

◆ getMenuBarNames()

◆ getMenuForIndex()

◆ handleAsyncUpdate()

◆ handleMenuBarActivate()

◆ handleUpdateNowIfNeeded()

◆ isUpdatePending()

◆ menuBarActivated()

◆ menuItemsChanged()

◆ menuItemSelected()

◆ removeListener()

◆ setApplicationCommandManagerToWatch()

◆ setMacMainMenu()

◆ triggerAsyncUpdate()

Member Data Documentation

◆ listeners

◆ manager