juce_ApplicationCommandManager.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  ApplicationCommandManager   : private AsyncUpdater,
                                              private FocusChangeListener
{
public:
    //==============================================================================
    ApplicationCommandManager();

    ~ApplicationCommandManager() override;
 
    //==============================================================================
    void clearCommands();

    void registerCommand (const ApplicationCommandInfo& newCommand);

    void registerAllCommandsForTarget (ApplicationCommandTarget* target);

    void removeCommand (CommandID commandID);

    void commandStatusChanged();
 
    //==============================================================================
    int getNumCommands() const noexcept                                             { return commands.size(); }

    const ApplicationCommandInfo* getCommandForIndex (int index) const noexcept     { return commands [index]; }

    const ApplicationCommandInfo* getCommandForID (CommandID commandID) const noexcept;

    String getNameOfCommand (CommandID commandID) const noexcept;

    String getDescriptionOfCommand (CommandID commandID) const noexcept;

    StringArray getCommandCategories() const;

    Array<CommandID> getCommandsInCategory (const String& categoryName) const;
 
    //==============================================================================
    KeyPressMappingSet* getKeyMappings() const noexcept         { return keyMappings.get(); }
 
 
    //==============================================================================
    bool invokeDirectly (CommandID commandID, bool asynchronously);

    bool invoke (const ApplicationCommandTarget::InvocationInfo& invocationInfo,
                 bool asynchronously);
 
 
    //==============================================================================
    virtual ApplicationCommandTarget* getFirstCommandTarget (CommandID commandID);

    void setFirstCommandTarget (ApplicationCommandTarget* newTarget) noexcept;

    ApplicationCommandTarget* getTargetForCommand (CommandID commandID,
                                                   ApplicationCommandInfo& upToDateInfo);
 
    //==============================================================================
    void addListener (ApplicationCommandManagerListener* listener);

    void removeListener (ApplicationCommandManagerListener* listener);
 
    //==============================================================================
    static ApplicationCommandTarget* findDefaultComponentTarget();

    static ApplicationCommandTarget* findTargetForComponent (Component*);
 
 
private:
    //==============================================================================
    OwnedArray<ApplicationCommandInfo> commands;
    ListenerList<ApplicationCommandManagerListener> listeners;
    std::unique_ptr<KeyPressMappingSet> keyMappings;
    ApplicationCommandTarget* firstTarget = nullptr;
 
    void sendListenerInvokeCallback (const ApplicationCommandTarget::InvocationInfo&);
    void handleAsyncUpdate() override;
    void globalFocusChanged (Component*) override;
    ApplicationCommandInfo* getMutableCommandForID (CommandID) const noexcept;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ApplicationCommandManager)
};
 
 
//==============================================================================
class JUCE_API  ApplicationCommandManagerListener
{
public:
    //==============================================================================
    virtual ~ApplicationCommandManagerListener() = default;

    virtual void applicationCommandInvoked (const ApplicationCommandTarget::InvocationInfo&) = 0;

    virtual void applicationCommandListChanged() = 0;
};
 
} // namespace juce