juce_ApplicationCommandInfo.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
{
 
//==============================================================================
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;
};
 
} // namespace juce