KeyEvent.h

Go to the documentation of this file.

#pragma once
#include <Ultralight/Defines.h>
#include <Ultralight/KeyCodes.h>
#include <Ultralight/String.h>
#ifdef __OBJC__
#import <AppKit/NSEvent.h>
#endif

namespace ultralight {

class UExport KeyEvent {
public:
  enum Type {
    kType_KeyDown,

    kType_KeyUp,

    kType_RawKeyDown,

    kType_Char,
  };

  KeyEvent();

#ifdef _WIN32
  KeyEvent(Type type, uintptr_t wparam, intptr_t lparam, bool is_system_key);
#endif

#ifdef __OBJC__
  KeyEvent(NSEvent* evt);
#endif

  enum Modifiers : uint8_t {
    kMod_AltKey = 1 << 0,

    kMod_CtrlKey = 1 << 1,

    kMod_MetaKey = 1 << 2,

    kMod_ShiftKey = 1 << 3,
  };

  // The type of this KeyEvent
  Type type;

  unsigned modifiers;

  // The virtual key-code associated with this keyboard event. This is either
  // directly from the event (ie, WPARAM on Windows) or via a mapping function.
  // You can see a full list of the possible virtual key-codes in
  // KeyboardCodes.h
  int virtual_key_code;

  int native_key_code;

  String key_identifier;

  String text;

  String unmodified_text;

  bool is_keypad;

  bool is_auto_repeat;

  bool is_system_key;
};

void UExport GetKeyIdentifierFromVirtualKeyCode(int virtual_key_code,
  String& key_identifier_result);

}  // namespace ultralight