juce_MenuBarModel.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   By using JUCE, you agree to the terms of both the JUCE 7 End-User License
   Agreement and JUCE Privacy Policy.
 
   End User License Agreement: www.juce.com/juce-7-licence
   Privacy Policy: www.juce.com/juce-privacy-policy
 
   Or: You may also use this code under the terms of the GPL v3 (see
   www.gnu.org/licenses).
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
//==============================================================================
class JUCE_API  MenuBarModel      : private AsyncUpdater,
                                    private ApplicationCommandManagerListener
{
public:
    //==============================================================================
    MenuBarModel() noexcept;

    ~MenuBarModel() override;
 
    //==============================================================================
    void menuItemsChanged();

    void setApplicationCommandManagerToWatch (ApplicationCommandManager* manager);
 
    //==============================================================================
    class JUCE_API  Listener
    {
    public:
        virtual ~Listener() = default;
 
        //==============================================================================
        virtual void menuBarItemsChanged (MenuBarModel* menuBarModel) = 0;

        virtual void menuCommandInvoked (MenuBarModel* menuBarModel,
                                         const ApplicationCommandTarget::InvocationInfo& info) = 0;

        virtual void menuBarActivated (MenuBarModel* menuBarModel, bool isActive);
    };

    void addListener (Listener* listenerToAdd);

    void removeListener (Listener* listenerToRemove);
 
    //==============================================================================
    virtual StringArray getMenuBarNames() = 0;

    virtual PopupMenu getMenuForIndex (int topLevelMenuIndex,
                                       const String& menuName) = 0;

    virtual void menuItemSelected (int menuItemID,
                                   int topLevelMenuIndex) = 0;

    virtual void menuBarActivated (bool isActive);
 
    //==============================================================================
   #if JUCE_MAC || DOXYGEN
    static void setMacMainMenu (MenuBarModel* newMenuBarModel,
                                const PopupMenu* extraAppleMenuItems = nullptr,
                                const String& recentItemsMenuName = String());

    static MenuBarModel* getMacMainMenu();

    static const PopupMenu* getMacExtraAppleItemsMenu();
   #endif
 
    //==============================================================================
    void applicationCommandInvoked (const ApplicationCommandTarget::InvocationInfo&) override;
    void applicationCommandListChanged() override;
    void handleAsyncUpdate() override;
    void handleMenuBarActivate (bool isActive);
private:
    ApplicationCommandManager* manager;
    ListenerList<Listener> listeners;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (MenuBarModel)
};
 
 
} // namespace juce