PlatformKeyboardEvent.h [plain text]
#pragma once
#include "CompositionUnderline.h"
#include "KeypressCommand.h"
#include "PlatformEvent.h"
#include <wtf/WindowsExtras.h>
#include <wtf/text/WTFString.h>
#if PLATFORM(COCOA)
#include <wtf/RetainPtr.h>
OBJC_CLASS NSEvent;
#endif
#if PLATFORM(IOS_FAMILY)
OBJC_CLASS WebEvent;
#endif
namespace WebCore {
class PlatformKeyboardEvent : public PlatformEvent {
WTF_MAKE_FAST_ALLOCATED;
public:
PlatformKeyboardEvent()
: PlatformEvent(PlatformEvent::KeyDown)
{
}
PlatformKeyboardEvent(Type type, const String& text, const String& unmodifiedText, const String& key, const String& code,
const String& keyIdentifier, int windowsVirtualKeyCode, bool isAutoRepeat, bool isKeypad, bool isSystemKey, OptionSet<Modifier> modifiers, WallTime timestamp)
: PlatformEvent(type, modifiers, timestamp)
, m_autoRepeat(isAutoRepeat)
, m_isKeypad(isKeypad)
, m_isSystemKey(isSystemKey)
, m_text(text)
, m_unmodifiedText(unmodifiedText)
, m_key(key)
, m_code(code)
, m_keyIdentifier(keyIdentifier)
, m_windowsVirtualKeyCode(windowsVirtualKeyCode)
{
}
WEBCORE_EXPORT void disambiguateKeyDownEvent(Type, bool backwardCompatibilityMode = false);
String text() const { return m_text; }
String unmodifiedText() const { return m_unmodifiedText; }
String keyIdentifier() const { return m_keyIdentifier; }
const String& key() const { return m_key; }
const String& code() const { return m_code; }
int windowsVirtualKeyCode() const { return m_windowsVirtualKeyCode; }
void setWindowsVirtualKeyCode(int code) { m_windowsVirtualKeyCode = code; }
#if USE(APPKIT) || USE(UIKIT_KEYBOARD_ADDITIONS) || PLATFORM(GTK) || USE(LIBWPE)
bool handledByInputMethod() const { return m_handledByInputMethod; }
#endif
#if PLATFORM(GTK) || USE(LIBWPE)
const Optional<Vector<WebCore::CompositionUnderline>>& preeditUnderlines() const { return m_preeditUnderlines; }
const Optional<uint64_t>& preeditSelectionRangeStart() const { return m_preeditSelectionRangeStart; }
const Optional<uint64_t>& preeditSelectionRangeLength() const { return m_preeditSelectionRangeLength; }
#endif
#if USE(APPKIT)
const Vector<KeypressCommand>& commands() const { return m_commands; }
#elif PLATFORM(GTK)
const Vector<String>& commands() const { return m_commands; }
#endif
bool isAutoRepeat() const { return m_autoRepeat; }
bool isKeypad() const { return m_isKeypad; }
bool isSystemKey() const { return m_isSystemKey; }
bool isSyntheticEvent() const { return m_isSyntheticEvent; }
void setIsSyntheticEvent() { m_isSyntheticEvent = true; }
WEBCORE_EXPORT static bool currentCapsLockState();
WEBCORE_EXPORT static void getCurrentModifierState(bool& shiftKey, bool& ctrlKey, bool& altKey, bool& metaKey);
WEBCORE_EXPORT static void setCurrentModifierState(OptionSet<Modifier>);
WEBCORE_EXPORT static OptionSet<Modifier> currentStateOfModifierKeys();
#if PLATFORM(COCOA)
#if !PLATFORM(IOS_FAMILY)
NSEvent* macEvent() const { return m_macEvent.get(); }
#else
::WebEvent *event() const { return m_Event.get(); }
#endif
#endif
#if PLATFORM(WIN)
PlatformKeyboardEvent(HWND, WPARAM, LPARAM, Type, bool);
#endif
#if PLATFORM(GTK)
static String keyValueForGdkKeyCode(unsigned);
static String keyCodeForHardwareKeyCode(unsigned);
static String keyIdentifierForGdkKeyCode(unsigned);
static int windowsKeyCodeForGdkKeyCode(unsigned);
static String singleCharacterString(unsigned);
static bool modifiersContainCapsLock(unsigned);
#endif
#if USE(LIBWPE)
static String keyValueForWPEKeyCode(unsigned);
static String keyCodeForHardwareKeyCode(unsigned);
static String keyIdentifierForWPEKeyCode(unsigned);
static int windowsKeyCodeForWPEKeyCode(unsigned);
static String singleCharacterString(unsigned);
#endif
protected:
bool m_autoRepeat { false };
bool m_isKeypad { false };
bool m_isSystemKey { false };
String m_text;
String m_unmodifiedText;
String m_key;
String m_code;
String m_keyIdentifier;
int m_windowsVirtualKeyCode { 0 };
bool m_isSyntheticEvent { false };
#if USE(APPKIT) || USE(UIKIT_KEYBOARD_ADDITIONS) || PLATFORM(GTK) || USE(LIBWPE)
bool m_handledByInputMethod { false };
#endif
#if PLATFORM(GTK) || USE(LIBWPE)
Optional<Vector<WebCore::CompositionUnderline>> m_preeditUnderlines;
Optional<uint64_t> m_preeditSelectionRangeStart;
Optional<uint64_t> m_preeditSelectionRangeLength;
#endif
#if USE(APPKIT)
Vector<KeypressCommand> m_commands;
#elif PLATFORM(GTK)
Vector<String> m_commands;
#endif
#if PLATFORM(COCOA)
#if !PLATFORM(IOS_FAMILY)
RetainPtr<NSEvent> m_macEvent;
#else
RetainPtr<::WebEvent> m_Event;
#endif
#endif
static Optional<OptionSet<Modifier>> s_currentModifiers;
};
}