134 lines
5.1 KiB
C++
134 lines
5.1 KiB
C++
/*
|
|
==============================================================================
|
|
|
|
This file is part of the JUCE library.
|
|
Copyright (c) 2017 - ROLI Ltd.
|
|
|
|
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 5 End-User License
|
|
Agreement and JUCE 5 Privacy Policy (both updated and effective as of the
|
|
27th April 2017).
|
|
|
|
End User License Agreement: www.juce.com/juce-5-licence
|
|
Privacy Policy: www.juce.com/juce-5-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
|
|
{
|
|
|
|
//==============================================================================
|
|
/**
|
|
A component to allow editing of the keymaps stored by a KeyPressMappingSet
|
|
object.
|
|
|
|
@see KeyPressMappingSet
|
|
|
|
@tags{GUI}
|
|
*/
|
|
class JUCE_API KeyMappingEditorComponent : public Component
|
|
{
|
|
public:
|
|
//==============================================================================
|
|
/** Creates a KeyMappingEditorComponent.
|
|
|
|
@param mappingSet this is the set of mappings to display and edit. Make sure the
|
|
mappings object is not deleted before this component!
|
|
@param showResetToDefaultButton if true, then at the bottom of the list, the
|
|
component will include a 'reset to defaults' button.
|
|
*/
|
|
KeyMappingEditorComponent (KeyPressMappingSet& mappingSet,
|
|
bool showResetToDefaultButton);
|
|
|
|
/** Destructor. */
|
|
~KeyMappingEditorComponent() override;
|
|
|
|
//==============================================================================
|
|
/** Sets up the colours to use for parts of the component.
|
|
|
|
@param mainBackground colour to use for most of the background
|
|
@param textColour colour to use for the text
|
|
*/
|
|
void setColours (Colour mainBackground,
|
|
Colour textColour);
|
|
|
|
/** Returns the KeyPressMappingSet that this component is acting upon. */
|
|
KeyPressMappingSet& getMappings() const noexcept { return mappings; }
|
|
|
|
/** Returns the ApplicationCommandManager that this component is connected to. */
|
|
ApplicationCommandManager& getCommandManager() const noexcept { return mappings.getCommandManager(); }
|
|
|
|
|
|
//==============================================================================
|
|
/** Can be overridden if some commands need to be excluded from the list.
|
|
|
|
By default this will use the KeyPressMappingSet's shouldCommandBeVisibleInEditor()
|
|
method to decide what to return, but you can override it to handle special cases.
|
|
*/
|
|
virtual bool shouldCommandBeIncluded (CommandID commandID);
|
|
|
|
/** Can be overridden to indicate that some commands are shown as read-only.
|
|
|
|
By default this will use the KeyPressMappingSet's shouldCommandBeReadOnlyInEditor()
|
|
method to decide what to return, but you can override it to handle special cases.
|
|
*/
|
|
virtual bool isCommandReadOnly (CommandID commandID);
|
|
|
|
/** This can be overridden to let you change the format of the string used
|
|
to describe a keypress.
|
|
|
|
This is handy if you're using non-standard KeyPress objects, e.g. for custom
|
|
keys that are triggered by something else externally. If you override the
|
|
method, be sure to let the base class's method handle keys you're not
|
|
interested in.
|
|
*/
|
|
virtual String getDescriptionForKeyPress (const KeyPress& key);
|
|
|
|
//==============================================================================
|
|
/** A set of colour IDs to use to change the colour of various aspects of the editor.
|
|
|
|
These constants can be used either via the Component::setColour(), or LookAndFeel::setColour()
|
|
methods.
|
|
|
|
@see Component::setColour, Component::findColour, LookAndFeel::setColour, LookAndFeel::findColour
|
|
*/
|
|
enum ColourIds
|
|
{
|
|
backgroundColourId = 0x100ad00, /**< The background colour to fill the editor background. */
|
|
textColourId = 0x100ad01, /**< The colour for the text. */
|
|
};
|
|
|
|
//==============================================================================
|
|
/** @internal */
|
|
void parentHierarchyChanged() override;
|
|
/** @internal */
|
|
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
|