openshot-audio
0.1.6
|
#include <juce_KeyPressMappingSet.h>
Manages and edits a list of keypresses, which it uses to invoke the appropriate command in an ApplicationCommandManager.
Normally, you won't actually create a KeyPressMappingSet directly, because each ApplicationCommandManager contains its own KeyPressMappingSet, so typically you'd create yourself an ApplicationCommandManager, and call its ApplicationCommandManager::getKeyMappings() method to get a pointer to its KeyPressMappingSet.
For one of these to actually use keypresses, you'll need to add it as a KeyListener to the top-level component for which you want to handle keystrokes. So for example:
KeyPressMappingSet derives from ChangeBroadcaster so that interested parties can register to be told when a command or mapping is added, removed, etc.
There's also a UI component called KeyMappingEditorComponent that can be used to easily edit the key mappings.
|
explicit |
Creates a KeyPressMappingSet for a given command manager.
Normally, you won't actually create a KeyPressMappingSet directly, because each ApplicationCommandManager contains its own KeyPressMappingSet, so the best thing to do is to create your ApplicationCommandManager, and use the ApplicationCommandManager::getKeyMappings() method to access its mappings.
When a suitable keypress happens, the manager's invoke() method will be used to invoke the appropriate command.
KeyPressMappingSet::KeyPressMappingSet | ( | const KeyPressMappingSet & | other | ) |
Creates an copy of a KeyPressMappingSet.
KeyPressMappingSet::~KeyPressMappingSet | ( | ) |
Destructor.
void KeyPressMappingSet::addKeyPress | ( | CommandID | commandID, |
const KeyPress & | newKeyPress, | ||
int | insertIndex = -1 |
||
) |
Assigns a keypress to a command.
If the keypress is already assigned to a different command, it will first be removed from that command, to avoid it triggering multiple functions.
commandID | the ID of the command that you want to add a keypress to. If this is 0, the keypress will be removed from anything that it was previously assigned to, but not re-assigned |
newKeyPress | the new key-press |
insertIndex | if this is less than zero, the key will be appended to the end of the list of keypresses; otherwise the new keypress will be inserted into the existing list at this index |
void KeyPressMappingSet::clearAllKeyPresses | ( | ) |
Removes all keypresses that are assigned to any commands.
void KeyPressMappingSet::clearAllKeyPresses | ( | CommandID | commandID | ) |
Removes all keypresses that are assigned to a particular command.
|
noexcept |
Returns true if the given command is linked to this key.
XmlElement * KeyPressMappingSet::createXml | ( | bool | saveDifferencesFromDefaultSet | ) | const |
Creates an XML representation of the current mappings.
This will produce a lump of XML that can be later reloaded using restoreFromXml() to recreate the current mapping state.
The object that is returned must be deleted by the caller.
saveDifferencesFromDefaultSet | if this is false, then all keypresses will be saved into the XML. If it's true, then the XML will only store the differences between the current mappings and the default mappings you'd get from calling resetToDefaultMappings(). The advantage of saving a set of differences from the default is that if you change the default mappings (in a new version of your app, for example), then these will be merged into a user's saved preferences. |
Looks for a command that corresponds to a keypress.
|
inlinenoexcept |
Returns a list of keypresses that are assigned to a particular command.
commandID | the command's ID |
|
overridevirtual |
Callback to indicate that the currently focused component has changed.
Implements FocusChangeListener.
|
overridevirtual |
Called to indicate that a key has been pressed.
If your implementation returns true, then the key event is considered to have been consumed, and will not be passed on to any other components. If it returns false, then the key will be passed to other components that might want to use it.
key | the keystroke, including modifier keys |
originatingComponent | the component that received the key event |
Implements KeyListener.
|
overridevirtual |
Called when any key is pressed or released.
When this is called, classes that might be interested in the state of one or more keys can use KeyPress::isKeyCurrentlyDown() to check whether their key has changed.
If your implementation returns true, then the key event is considered to have been consumed, and will not be passed on to any other components. If it returns false, then the key will be passed to other components that might want to use it.
originatingComponent | the component that received the key event |
isKeyDown | true if a key is being pressed, false if one is being released |
Reimplemented from KeyListener.
void KeyPressMappingSet::removeKeyPress | ( | CommandID | commandID, |
int | keyPressIndex | ||
) |
Removes one of the keypresses that are assigned to a command. See the getKeyPressesAssignedToCommand() for the list of keypresses to which the keyPressIndex refers.
void KeyPressMappingSet::removeKeyPress | ( | const KeyPress & | keypress | ) |
Removes a keypress from any command that it may be assigned to.
void KeyPressMappingSet::resetToDefaultMapping | ( | CommandID | commandID | ) |
Resets all key-mappings to the defaults for a particular command.
void KeyPressMappingSet::resetToDefaultMappings | ( | ) |
Reset all mappings to the defaults, as dictated by the ApplicationCommandManager.
bool KeyPressMappingSet::restoreFromXml | ( | const XmlElement & | xmlVersion | ) |
Tries to recreate the mappings from a previously stored state.
The XML passed in must have been created by the createXml() method.
If the stored state makes any reference to commands that aren't currently available, these will be ignored.
If the set of mappings being loaded was a set of differences (using createXml (true)), then this will call resetToDefaultMappings() and then merge the saved mappings on top. If the saved set was created with createXml (false), then this method will first clear all existing mappings and load the saved ones as a complete set.