third_party/WebKit/Source/platform/PlatformKeyboardEvent.h

   1 /*
   2  * Copyright (C) 2004, 2005, 2006 Apple Computer, Inc.  All rights reserved.
   3  * Copyright (C) 2008 Collabora, Ltd.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 #ifndef PlatformKeyboardEvent_h
  28 #define PlatformKeyboardEvent_h
  29
  30 #include "platform/PlatformEvent.h"
  31 #include "platform/PlatformExport.h"
  32 #include "wtf/text/WTFString.h"
  33
  34 namespace blink {
  35
  36 class PlatformKeyboardEvent : public PlatformEvent {
  37     WTF_MAKE_FAST_ALLOCATED(PlatformKeyboardEvent);
  38 public:
  39     PlatformKeyboardEvent()
  40         : PlatformEvent(PlatformEvent::KeyDown)
  41         , m_windowsVirtualKeyCode(0)
  42         , m_nativeVirtualKeyCode(0)
  43         , m_isSystemKey(false)
  44     {
  45     }
  46
  47     PlatformKeyboardEvent(Type type, const String& text, const String& unmodifiedText, const String& keyIdentifier, const String& code, const String& key, int windowsVirtualKeyCode, int nativeVirtualKeyCode, bool isSystemKey, Modifiers modifiers, double timestamp)
  48         : PlatformEvent(type, modifiers, timestamp)
  49         , m_text(text)
  50         , m_unmodifiedText(unmodifiedText)
  51         , m_keyIdentifier(keyIdentifier)
  52         , m_code(code)
  53         , m_key(key)
  54         , m_windowsVirtualKeyCode(windowsVirtualKeyCode)
  55         , m_nativeVirtualKeyCode(nativeVirtualKeyCode)
  56         , m_isSystemKey(isSystemKey)
  57     {
  58     }
  59
  60     PLATFORM_EXPORT void disambiguateKeyDownEvent(Type);
  61
  62     // Text as as generated by processing a virtual key code with a keyboard layout
  63     // (in most cases, just a character code, but the layout can emit several
  64     // characters in a single keypress event on some platforms).
  65     // This may bear no resemblance to the ultimately inserted text if an input method
  66     // processes the input.
  67     // Will be null for KeyUp and RawKeyDown events.
  68     String text() const { return m_text; }
  69
  70     // Text that would have been generated by the keyboard if no modifiers were pressed
  71     // (except for Shift); useful for shortcut (accelerator) key handling.
  72     // Otherwise, same as text().
  73     String unmodifiedText() const { return m_unmodifiedText; }
  74
  75     String keyIdentifier() const { return m_keyIdentifier; }
  76
  77     String code() const { return m_code; }
  78     String key() const { return m_key; }
  79
  80     // Most compatible Windows virtual key code associated with the event.
  81     // Zero for Char events.
  82     int windowsVirtualKeyCode() const { return m_windowsVirtualKeyCode; }
  83
  84     int nativeVirtualKeyCode() const { return m_nativeVirtualKeyCode; }
  85
  86     bool isAutoRepeat() const { return modifiers() & IsAutoRepeat; }
  87     bool isKeypad() const { return modifiers() & IsKeyPad; }
  88     bool isSystemKey() const { return m_isSystemKey; }
  89
  90     PLATFORM_EXPORT static bool currentCapsLockState();
  91     PLATFORM_EXPORT static void getCurrentModifierState(bool& shiftKey, bool& ctrlKey, bool& altKey, bool& metaKey);
  92
  93 protected:
  94     String m_text;
  95     String m_unmodifiedText;
  96     String m_keyIdentifier;
  97     String m_code;
  98     String m_key;
  99     int m_windowsVirtualKeyCode;
 100     int m_nativeVirtualKeyCode;
 101     bool m_isSystemKey;
 102
 103 private:
 104     friend class Internals;
 105     enum OverrideCapsLockState {
 106         Default,
 107         On,
 108         Off
 109     };
 110     // Allows overriding the current caps lock state for testing purposes.
 111     PLATFORM_EXPORT static void setCurrentCapsLockState(OverrideCapsLockState state) { s_overrideCapsLockState = state; }
 112     PLATFORM_EXPORT static OverrideCapsLockState s_overrideCapsLockState;
 113 };
 114
 115 } // namespace blink
 116
 117 #endif // PlatformKeyboardEvent_h