ui/events/keycodes/keyboard_code_conversion_x.h

   1 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef UI_EVENTS_KEYCODES_KEYBOARD_CODE_CONVERSION_X_H_
   6 #define UI_EVENTS_KEYCODES_KEYBOARD_CODE_CONVERSION_X_H_
   7
   8 #include "base/basictypes.h"
   9 #include "base/strings/string16.h"
  10 #include "ui/events/events_base_export.h"
  11 #include "ui/events/keycodes/keyboard_codes_posix.h"
  12
  13 typedef union _XEvent XEvent;
  14 typedef struct _XDisplay XDisplay;
  15
  16 namespace ui {
  17
  18 enum class DomCode;
  19 enum class DomKey;
  20
  21 EVENTS_BASE_EXPORT KeyboardCode KeyboardCodeFromXKeyEvent(const XEvent* xev);
  22
  23 EVENTS_BASE_EXPORT KeyboardCode KeyboardCodeFromXKeysym(unsigned int keysym);
  24
  25 EVENTS_BASE_EXPORT DomCode CodeFromXEvent(const XEvent* xev);
  26
  27 // Returns a character on a standard US PC keyboard from an XEvent.
  28 EVENTS_BASE_EXPORT uint16 GetCharacterFromXEvent(const XEvent* xev);
  29
  30 // Returns DomKey and character from an XEvent.
  31 EVENTS_BASE_EXPORT void GetMeaningFromXEvent(const XEvent* xev,
  32                                              DomKey* key,
  33                                              base::char16* character);
  34
  35 // Converts a KeyboardCode into an X KeySym.
  36 EVENTS_BASE_EXPORT int XKeysymForWindowsKeyCode(KeyboardCode keycode,
  37                                                 bool shift);
  38
  39 // Returns a XKeyEvent keycode (scancode) for a KeyboardCode. Keyboard layouts
  40 // are usually not injective, so inverse mapping should be avoided when
  41 // practical. A round-trip keycode -> KeyboardCode -> keycode will not
  42 // necessarily return the original keycode.
  43 EVENTS_BASE_EXPORT unsigned int XKeyCodeForWindowsKeyCode(KeyboardCode key_code,
  44                                                           int flags,
  45                                                           XDisplay* display);
  46
  47 // Converts an X keycode into ui::KeyboardCode.
  48 EVENTS_BASE_EXPORT KeyboardCode
  49     DefaultKeyboardCodeFromHardwareKeycode(unsigned int hardware_code);
  50
  51 // Initializes a core XKeyEvent from an XI2 key event.
  52 EVENTS_BASE_EXPORT void InitXKeyEventFromXIDeviceEvent(const XEvent& src,
  53                                                        XEvent* dst);
  54
  55 }  // namespace ui
  56
  57 #endif  // UI_EVENTS_KEYCODES_KEYBOARD_CODE_CONVERSION_X_H_