juce_KeyPress.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  KeyPress
{
public:
    //==============================================================================
    KeyPress() = default;

    ~KeyPress() = default;

    KeyPress (int keyCode,
              ModifierKeys modifiers,
              juce_wchar textCharacter) noexcept;

    explicit KeyPress (int keyCode) noexcept;

    KeyPress (const KeyPress&) = default;

    KeyPress& operator= (const KeyPress&) = default;

    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                               { return keyCode != 0; }

    int getKeyCode() const noexcept                             { return keyCode; }

    ModifierKeys getModifiers() const noexcept                  { return mods; }

    juce_wchar getTextCharacter() const noexcept                { return textCharacter; }

    bool isKeyCode (int keyCodeToCompare) const noexcept        { return keyCode == keyCodeToCompare; }
 
    //==============================================================================
    static KeyPress createFromDescription (const String& textVersion);

    String getTextDescription() const;

    String getTextDescriptionWithIcons() const;
 
    //==============================================================================
    bool isCurrentlyDown() const;

    static bool isKeyCurrentlyDown (int keyCode);
 
    //==============================================================================
    // Key codes
    //
    // Note that the actual values of these are platform-specific and may change
    // without warning, so don't store them anywhere as constants. For persisting/retrieving
    // KeyPress objects, use getTextDescription() and createFromDescription() instead.
    //
 
    static const int spaceKey;      
    static const int escapeKey;     
    static const int returnKey;     
    static const int tabKey;        
 
    static const int deleteKey;     
    static const int backspaceKey;  
    static const int insertKey;     
 
    static const int upKey;         
    static const int downKey;       
    static const int leftKey;       
    static const int rightKey;      
    static const int pageUpKey;     
    static const int pageDownKey;   
    static const int homeKey;       
    static const int endKey;        
 
    static const int F1Key;         
    static const int F2Key;         
    static const int F3Key;         
    static const int F4Key;         
    static const int F5Key;         
    static const int F6Key;         
    static const int F7Key;         
    static const int F8Key;         
    static const int F9Key;         
    static const int F10Key;        
    static const int F11Key;        
    static const int F12Key;        
    static const int F13Key;        
    static const int F14Key;        
    static const int F15Key;        
    static const int F16Key;        
    static const int F17Key;        
    static const int F18Key;        
    static const int F19Key;        
    static const int F20Key;        
    static const int F21Key;        
    static const int F22Key;        
    static const int F23Key;        
    static const int F24Key;        
    static const int F25Key;        
    static const int F26Key;        
    static const int F27Key;        
    static const int F28Key;        
    static const int F29Key;        
    static const int F30Key;        
    static const int F31Key;        
    static const int F32Key;        
    static const int F33Key;        
    static const int F34Key;        
    static const int F35Key;        
 
    static const int numberPad0;     
    static const int numberPad1;     
    static const int numberPad2;     
    static const int numberPad3;     
    static const int numberPad4;     
    static const int numberPad5;     
    static const int numberPad6;     
    static const int numberPad7;     
    static const int numberPad8;     
    static const int numberPad9;     
 
    static const int numberPadAdd;            
    static const int numberPadSubtract;       
    static const int numberPadMultiply;       
    static const int numberPadDivide;         
    static const int numberPadSeparator;      
    static const int numberPadDecimalPoint;   
    static const int numberPadEquals;         
    static const int numberPadDelete;         
 
    static const int playKey;        
    static const int stopKey;        
    static const int fastForwardKey; 
    static const int rewindKey;      
 
private:
    //==============================================================================
    int keyCode = 0;
    ModifierKeys mods;
    juce_wchar textCharacter = 0;
 
    JUCE_LEAK_DETECTOR (KeyPress)
};
 
} // namespace juce