juce_ApplicationCommandTarget.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2015 - ROLI Ltd.
 
   Permission is granted to use this software under the terms of either:
   a) the GPL v2 (or any later version)
   b) the Affero GPL v3
 
   Details of these licenses can be found at: www.gnu.org/licenses
 
   JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
   WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
   A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 
   ------------------------------------------------------------------------------
 
   To release a closed-source product which uses JUCE, commercial licenses are
   available: visit www.juce.com for more information.
 
  ==============================================================================
*/
 
#ifndef JUCE_APPLICATIONCOMMANDTARGET_H_INCLUDED
#define JUCE_APPLICATIONCOMMANDTARGET_H_INCLUDED
 
 
//==============================================================================
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:
    //==============================================================================
    WeakReference<ApplicationCommandTarget>::Master masterReference;
    friend class WeakReference<ApplicationCommandTarget>;
 
    class CommandMessage;
    friend class CommandMessage;
 
    bool tryToInvoke (const InvocationInfo&, bool async);
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ApplicationCommandTarget)
};
 
 
#endif   // JUCE_APPLICATIONCOMMANDTARGET_H_INCLUDED