juce_ApplicationCommandTarget.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  ApplicationCommandTarget
{
public:
    //==============================================================================
    ApplicationCommandTarget();

    virtual ~ApplicationCommandTarget();
 
    //==============================================================================
    struct JUCE_API  InvocationInfo
    {
        //==============================================================================
        InvocationInfo (const CommandID commandID);
 
        //==============================================================================
        CommandID commandID;

        int commandFlags;
 
        //==============================================================================
        enum InvocationMethod
        {
            direct = 0,     
            fromKeyPress,   
            fromMenu,       
            fromButton      
        };

        InvocationMethod invocationMethod;
 
        //==============================================================================
        Component* originatingComponent;
 
        //==============================================================================
        KeyPress keyPress;

        bool isKeyDown;

        int millisecsSinceKeyPressed;
    };
 
    //==============================================================================
    virtual ApplicationCommandTarget* getNextCommandTarget() = 0;

    virtual void getAllCommands (Array<CommandID>& commands) = 0;

    virtual void getCommandInfo (CommandID commandID, ApplicationCommandInfo& result) = 0;

    virtual bool perform (const InvocationInfo& info) = 0;
 
    //==============================================================================
    bool invoke (const InvocationInfo& invocationInfo,
                 const bool asynchronously);

    bool invokeDirectly (const CommandID commandID,
                         const bool asynchronously);
 
    //==============================================================================
    ApplicationCommandTarget* getTargetForCommand (const CommandID commandID);

    bool isCommandActive (const CommandID commandID);

    ApplicationCommandTarget* findFirstTargetParentComponent();
 
private:
    //==============================================================================
    class CommandMessage;
    friend class CommandMessage;
 
    bool tryToInvoke (const InvocationInfo&, bool async);
 
    JUCE_DECLARE_WEAK_REFERENCEABLE (ApplicationCommandTarget)
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ApplicationCommandTarget)
};
 
} // namespace juce