juce_ApplicationCommandInfo.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_APPLICATIONCOMMANDINFO_H_INCLUDED
#define JUCE_APPLICATIONCOMMANDINFO_H_INCLUDED
 
 
//==============================================================================
struct JUCE_API  ApplicationCommandInfo
{
    //==============================================================================
    explicit ApplicationCommandInfo (CommandID commandID) noexcept;
 
    //==============================================================================
    void setInfo (const String& shortName,
                  const String& description,
                  const String& categoryName,
                  int flags) noexcept;
 
    void setActive (bool isActive) noexcept;
 
    void setTicked (bool isTicked) noexcept;
 
    void addDefaultKeypress (int keyCode, ModifierKeys modifiers) noexcept;
 
    //==============================================================================
    CommandID commandID;
 
    String shortName;
 
    String description;
 
    String categoryName;
 
    Array<KeyPress> defaultKeypresses;
 
    //==============================================================================
    enum CommandFlags
    {
        isDisabled                  = 1 << 0,
 
        isTicked                    = 1 << 1,
 
        wantsKeyUpDownCallbacks     = 1 << 2,
 
        hiddenFromKeyEditor         = 1 << 3,
 
        readOnlyInKeyEditor         = 1 << 4,
 
        dontTriggerVisualFeedback   = 1 << 5
    };
 
    int flags;
};
 
 
#endif   // JUCE_APPLICATIONCOMMANDINFO_H_INCLUDED