juce_KeyMappingEditorComponent.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  KeyMappingEditorComponent  : public Component
{
public:
    //==============================================================================
    KeyMappingEditorComponent (KeyPressMappingSet& mappingSet,
                               bool showResetToDefaultButton);

    ~KeyMappingEditorComponent() override;
 
    //==============================================================================
    void setColours (Colour mainBackground,
                     Colour textColour);

    KeyPressMappingSet& getMappings() const noexcept                { return mappings; }

    ApplicationCommandManager& getCommandManager() const noexcept   { return mappings.getCommandManager(); }
 
 
    //==============================================================================
    virtual bool shouldCommandBeIncluded (CommandID commandID);

    virtual bool isCommandReadOnly (CommandID commandID);

    virtual String getDescriptionForKeyPress (const KeyPress& key);
 
    //==============================================================================
    enum ColourIds
    {
        backgroundColourId  = 0x100ad00,    
        textColourId        = 0x100ad01,    
    };
 
    //==============================================================================
    void parentHierarchyChanged() override;
    void resized() override;
 
private:
    //==============================================================================
    KeyPressMappingSet& mappings;
    TreeView tree;
    TextButton resetButton;
 
    class TopLevelItem;
    class ChangeKeyButton;
    class MappingItem;
    class CategoryItem;
    class ItemComponent;
    std::unique_ptr<TopLevelItem> treeItem;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (KeyMappingEditorComponent)
};
 
} // namespace juce