openshot-audio  0.1.2
Classes | Public Member Functions | List of all members
MenuBarModel Class Referenceabstract

#include <juce_MenuBarModel.h>

Inheritance diagram for MenuBarModel:
AsyncUpdater ApplicationCommandManagerListener

Classes

class  Listener
 

Public Member Functions

 MenuBarModel () noexcept
 
virtual ~MenuBarModel ()
 
void menuItemsChanged ()
 
void setApplicationCommandManagerToWatch (ApplicationCommandManager *manager) noexcept
 
void addListener (Listener *listenerToAdd) noexcept
 
void removeListener (Listener *listenerToRemove) noexcept
 
virtual StringArray getMenuBarNames ()=0
 
virtual PopupMenu getMenuForIndex (int topLevelMenuIndex, const String &menuName)=0
 
virtual void menuItemSelected (int menuItemID, int topLevelMenuIndex)=0
 
void applicationCommandInvoked (const ApplicationCommandTarget::InvocationInfo &) override
 
void applicationCommandListChanged () override
 
void handleAsyncUpdate () override
 

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

Constructor & Destructor Documentation

MenuBarModel::MenuBarModel ( )
noexcept
MenuBarModel::~MenuBarModel ( )
virtual

Destructor.

Member Function Documentation

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
void MenuBarModel::applicationCommandInvoked ( const ApplicationCommandTarget::InvocationInfo )
overridevirtual

Called when an app command is about to be invoked.

Implements ApplicationCommandManagerListener.

void MenuBarModel::applicationCommandListChanged ( )
overridevirtual

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.

virtual StringArray MenuBarModel::getMenuBarNames ( )
pure virtual

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

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
topLevelMenuIndexthe index of the top-level menu to show
menuNamethe name of the top-level menu item to show
void MenuBarModel::handleAsyncUpdate ( )
overridevirtual

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.

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.

See also
addListener, removeListener, MenuBarListener
virtual void MenuBarModel::menuItemSelected ( int  menuItemID,
int  topLevelMenuIndex 
)
pure virtual

This is called when a menu item has been clicked on.

Parameters
menuItemIDthe item ID of the PopupMenu item that was selected
topLevelMenuIndexthe 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)
void MenuBarModel::removeListener ( Listener listenerToRemove)
noexcept

Removes a listener.

See also
addListener
void MenuBarModel::setApplicationCommandManagerToWatch ( ApplicationCommandManager manager)
noexcept

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.


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