openshot-audio
0.1.5
|
#include <juce_KeyPress.h>
Public Member Functions | |
KeyPress () noexcept | |
KeyPress (int keyCode, ModifierKeys modifiers, juce_wchar textCharacter) noexcept | |
KeyPress (int keyCode) noexcept | |
KeyPress (const KeyPress &other) noexcept | |
KeyPress & | operator= (const KeyPress &other) noexcept |
bool | operator== (const KeyPress &other) const noexcept |
bool | operator!= (const KeyPress &other) const noexcept |
bool | operator== (int keyCode) const noexcept |
bool | operator!= (int keyCode) const noexcept |
bool | isValid () const noexcept |
int | getKeyCode () const noexcept |
ModifierKeys | getModifiers () const noexcept |
juce_wchar | getTextCharacter () const noexcept |
bool | isKeyCode (int keyCodeToCompare) const noexcept |
String | getTextDescription () const |
String | getTextDescriptionWithIcons () const |
bool | isCurrentlyDown () const |
Static Public Member Functions | |
static KeyPress | createFromDescription (const String &textVersion) |
static bool | isKeyCurrentlyDown (int keyCode) |
Static Public Attributes | |
static const int | spaceKey = XK_space & 0xff |
static const int | escapeKey = XK_Escape & 0xff |
static const int | returnKey = XK_Return & 0xff |
static const int | tabKey = XK_Tab & 0xff |
static const int | deleteKey = (XK_Delete & 0xff) | Keys::extendedKeyModifier |
static const int | backspaceKey = XK_BackSpace & 0xff |
static const int | insertKey = (XK_Insert & 0xff) | Keys::extendedKeyModifier |
static const int | upKey = (XK_Up & 0xff) | Keys::extendedKeyModifier |
static const int | downKey = (XK_Down & 0xff) | Keys::extendedKeyModifier |
static const int | leftKey = (XK_Left & 0xff) | Keys::extendedKeyModifier |
static const int | rightKey = (XK_Right & 0xff) | Keys::extendedKeyModifier |
static const int | pageUpKey = (XK_Page_Up & 0xff) | Keys::extendedKeyModifier |
static const int | pageDownKey = (XK_Page_Down & 0xff) | Keys::extendedKeyModifier |
static const int | homeKey = (XK_Home & 0xff) | Keys::extendedKeyModifier |
static const int | endKey = (XK_End & 0xff) | Keys::extendedKeyModifier |
static const int | F1Key = (XK_F1 & 0xff) | Keys::extendedKeyModifier |
static const int | F2Key = (XK_F2 & 0xff) | Keys::extendedKeyModifier |
static const int | F3Key = (XK_F3 & 0xff) | Keys::extendedKeyModifier |
static const int | F4Key = (XK_F4 & 0xff) | Keys::extendedKeyModifier |
static const int | F5Key = (XK_F5 & 0xff) | Keys::extendedKeyModifier |
static const int | F6Key = (XK_F6 & 0xff) | Keys::extendedKeyModifier |
static const int | F7Key = (XK_F7 & 0xff) | Keys::extendedKeyModifier |
static const int | F8Key = (XK_F8 & 0xff) | Keys::extendedKeyModifier |
static const int | F9Key = (XK_F9 & 0xff) | Keys::extendedKeyModifier |
static const int | F10Key = (XK_F10 & 0xff) | Keys::extendedKeyModifier |
static const int | F11Key = (XK_F11 & 0xff) | Keys::extendedKeyModifier |
static const int | F12Key = (XK_F12 & 0xff) | Keys::extendedKeyModifier |
static const int | F13Key = (XK_F13 & 0xff) | Keys::extendedKeyModifier |
static const int | F14Key = (XK_F14 & 0xff) | Keys::extendedKeyModifier |
static const int | F15Key = (XK_F15 & 0xff) | Keys::extendedKeyModifier |
static const int | F16Key = (XK_F16 & 0xff) | Keys::extendedKeyModifier |
static const int | numberPad0 = (XK_KP_0 & 0xff) | Keys::extendedKeyModifier |
static const int | numberPad1 = (XK_KP_1 & 0xff) | Keys::extendedKeyModifier |
static const int | numberPad2 = (XK_KP_2 & 0xff) | Keys::extendedKeyModifier |
static const int | numberPad3 = (XK_KP_3 & 0xff) | Keys::extendedKeyModifier |
static const int | numberPad4 = (XK_KP_4 & 0xff) | Keys::extendedKeyModifier |
static const int | numberPad5 = (XK_KP_5 & 0xff) | Keys::extendedKeyModifier |
static const int | numberPad6 = (XK_KP_6 & 0xff) | Keys::extendedKeyModifier |
static const int | numberPad7 = (XK_KP_7 & 0xff)| Keys::extendedKeyModifier |
static const int | numberPad8 = (XK_KP_8 & 0xff)| Keys::extendedKeyModifier |
static const int | numberPad9 = (XK_KP_9 & 0xff)| Keys::extendedKeyModifier |
static const int | numberPadAdd = (XK_KP_Add & 0xff)| Keys::extendedKeyModifier |
static const int | numberPadSubtract = (XK_KP_Subtract & 0xff)| Keys::extendedKeyModifier |
static const int | numberPadMultiply = (XK_KP_Multiply & 0xff)| Keys::extendedKeyModifier |
static const int | numberPadDivide = (XK_KP_Divide & 0xff)| Keys::extendedKeyModifier |
static const int | numberPadSeparator = (XK_KP_Separator & 0xff)| Keys::extendedKeyModifier |
static const int | numberPadDecimalPoint = (XK_KP_Decimal & 0xff)| Keys::extendedKeyModifier |
static const int | numberPadEquals = (XK_KP_Equal & 0xff)| Keys::extendedKeyModifier |
static const int | numberPadDelete = (XK_KP_Delete & 0xff)| Keys::extendedKeyModifier |
static const int | playKey = ((int) 0xffeeff00) | Keys::extendedKeyModifier |
static const int | stopKey = ((int) 0xffeeff01) | Keys::extendedKeyModifier |
static const int | fastForwardKey = ((int) 0xffeeff02) | Keys::extendedKeyModifier |
static const int | rewindKey = ((int) 0xffeeff03) | Keys::extendedKeyModifier |
Represents a key press, including any modifier keys that are needed.
E.g. a KeyPress might represent CTRL+C, SHIFT+ALT+H, Spacebar, Escape, etc.
|
noexcept |
Creates a KeyPress for a key and some modifiers.
e.g. CTRL+C would be: KeyPress ('c', ModifierKeys::ctrlModifier) SHIFT+Escape would be: KeyPress (KeyPress::escapeKey, ModifierKeys::shiftModifier)
keyCode | a code that represents the key - this value must be one of special constants listed in this class, or an 8-bit character code such as a letter (case is ignored), digit or a simple key like "," or ".". Note that this isn't the same as the textCharacter parameter, so for example a keyCode of 'a' and a shift-key modifier should have a textCharacter value of 'A'. |
modifiers | the modifiers to associate with the keystroke |
textCharacter | the character that would be printed if someone typed this keypress into a text editor. This value may be null if the keypress is a non-printing character |
|
explicitnoexcept |
Creates a keypress with a keyCode but no modifiers or text character.
Converts a textual key description to a KeyPress.
This attempts to decode a textual version of a keypress, e.g. "CTRL + C" or "SPACE".
This isn't designed to cope with any kind of input, but should be given the strings that are created by the getTextDescription() method.
If the string can't be parsed, the object returned will be invalid.
|
inlinenoexcept |
Returns the key code itself.
This will either be one of the special constants defined in this class, or an 8-bit character code.
|
inlinenoexcept |
Returns the key modifiers.
|
inlinenoexcept |
Returns the character that is associated with this keypress.
This is the character that you'd expect to see printed if you press this keypress in a text editor or similar component.
String KeyPress::getTextDescription | ( | ) | const |
Creates a textual description of the key combination.
e.g. "CTRL + C" or "DELETE".
To store a keypress in a file, use this method, along with createFromDescription() to retrieve it later.
String KeyPress::getTextDescriptionWithIcons | ( | ) | const |
Creates a textual description of the key combination, using unicode icon symbols if possible.
On OSX, this uses the Apple symbols for command, option, shift, etc, instead of the textual modifier key descriptions that are returned by getTextDescription()
bool KeyPress::isCurrentlyDown | ( | ) | const |
Checks whether the user is currently holding down the keys that make up this KeyPress.
Note that this will return false if any extra modifier keys are down - e.g. if the keypress is CTRL+X and the user is actually holding CTRL+ALT+x then it will be false.
|
inlinenoexcept |
Checks whether the KeyPress's key is the same as the one provided, without checking the modifiers.
The values for key codes can either be one of the special constants defined in this class, or an 8-bit character code.
|
static |
Checks whether a particular key is held down, irrespective of modifiers.
The values for key codes can either be one of the special constants defined in this class, or an 8-bit character code.
|
inlinenoexcept |
Returns true if this is a valid KeyPress.
A null keypress can be created by the default constructor, in case it's needed.
|
noexcept |
Returns true if this keypress is not for the given keycode without any modifiers.
Copies this KeyPress from another one.
|
noexcept |
Returns true if this keypress is for the given keycode without any modifiers.
|
static |
key-code for the backspace key
|
static |
key-code for the delete key (not backspace)
|
static |
key-code for the cursor-down key
|
static |
key-code for the end key
|
static |
key-code for the escape key
|
static |
key-code for the F10 key
|
static |
key-code for the F11 key
|
static |
key-code for the F12 key
|
static |
key-code for the F13 key
|
static |
key-code for the F14 key
|
static |
key-code for the F15 key
|
static |
key-code for the F16 key
|
static |
key-code for the F1 key
|
static |
key-code for the F2 key
|
static |
key-code for the F3 key
|
static |
key-code for the F4 key
|
static |
key-code for the F5 key
|
static |
key-code for the F6 key
|
static |
key-code for the F7 key
|
static |
key-code for the F8 key
|
static |
key-code for the F9 key
|
static |
key-code for a multimedia 'fast-forward' key, (not all keyboards will have one)
|
static |
key-code for the home key
|
static |
key-code for the insert key
|
static |
key-code for the cursor-left key
|
static |
key-code for the 0 on the numeric keypad.
|
static |
key-code for the 1 on the numeric keypad.
|
static |
key-code for the 2 on the numeric keypad.
|
static |
key-code for the 3 on the numeric keypad.
|
static |
key-code for the 4 on the numeric keypad.
|
static |
key-code for the 5 on the numeric keypad.
|
static |
key-code for the 6 on the numeric keypad.
|
static |
key-code for the 7 on the numeric keypad.
|
static |
key-code for the 8 on the numeric keypad.
|
static |
key-code for the 9 on the numeric keypad.
|
static |
key-code for the add sign on the numeric keypad.
|
static |
key-code for the decimal point sign on the numeric keypad.
|
static |
key-code for the delete key on the numeric keypad.
|
static |
key-code for the divide sign on the numeric keypad.
|
static |
key-code for the equals key on the numeric keypad.
|
static |
key-code for the multiply sign on the numeric keypad.
|
static |
key-code for the comma on the numeric keypad.
|
static |
key-code for the subtract sign on the numeric keypad.
|
static |
key-code for the page-down key
|
static |
key-code for the page-up key
|
static |
key-code for a multimedia 'play' key, (not all keyboards will have one)
|
static |
key-code for the return key
|
static |
key-code for a multimedia 'rewind' key, (not all keyboards will have one)
|
static |
key-code for the cursor-right key
|
static |
key-code for the space bar
|
static |
key-code for a multimedia 'stop' key, (not all keyboards will have one)
|
static |
key-code for the tab key
|
static |
key-code for the cursor-up key