juce_KeyPressMappingSet.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  KeyPressMappingSet  : public KeyListener,
                                      public ChangeBroadcaster,
                                      private FocusChangeListener
{
public:
    //==============================================================================
    explicit KeyPressMappingSet (ApplicationCommandManager&);

    KeyPressMappingSet (const KeyPressMappingSet&);

    ~KeyPressMappingSet() override;
 
    //==============================================================================
    ApplicationCommandManager& getCommandManager() const noexcept       { return commandManager; }
 
    //==============================================================================
    Array<KeyPress> getKeyPressesAssignedToCommand (CommandID commandID) const;

    void addKeyPress (CommandID commandID,
                      const KeyPress& newKeyPress,
                      int insertIndex = -1);

    void resetToDefaultMappings();

    void resetToDefaultMapping (CommandID commandID);

    void clearAllKeyPresses();

    void clearAllKeyPresses (CommandID commandID);

    void removeKeyPress (CommandID commandID, int keyPressIndex);

    void removeKeyPress (const KeyPress& keypress);

    bool containsMapping (CommandID commandID, const KeyPress& keyPress) const noexcept;
 
    //==============================================================================
    CommandID findCommandForKeyPress (const KeyPress& keyPress) const noexcept;
 
    //==============================================================================
    bool restoreFromXml (const XmlElement& xmlVersion);

    std::unique_ptr<XmlElement> createXml (bool saveDifferencesFromDefaultSet) const;
 
    //==============================================================================
    bool keyPressed (const KeyPress&, Component*) override;
    bool keyStateChanged (bool isKeyDown, Component*) override;
    void globalFocusChanged (Component*) override;
 
private:
    //==============================================================================
    ApplicationCommandManager& commandManager;
 
    struct CommandMapping
    {
        CommandID commandID;
        Array<KeyPress> keypresses;
        bool wantsKeyUpDownCallbacks;
    };
 
    OwnedArray<CommandMapping> mappings;
 
    struct KeyPressTime
    {
        KeyPress key;
        uint32 timeWhenPressed;
    };
 
    OwnedArray<KeyPressTime> keysDown;
 
    void invokeCommand (const CommandID, const KeyPress&, const bool isKeyDown,
                        const int millisecsSinceKeyPressed, Component* originator) const;
 
    KeyPressMappingSet& operator= (const KeyPressMappingSet&);
    JUCE_LEAK_DETECTOR (KeyPressMappingSet)
};
 
} // namespace juce