ui/events/keycodes/keyboard_code_conversion_mac.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_MAC_H_
   6 #define UI_EVENTS_KEYCODES_KEYBOARD_CODE_CONVERSION_MAC_H_
   7
   8 #import <Cocoa/Cocoa.h>
   9
  10 #include "base/basictypes.h"
  11 #include "ui/events/events_base_export.h"
  12 #include "ui/events/keycodes/keyboard_codes_posix.h"
  13
  14 namespace ui {
  15
  16 enum class DomCode;
  17
  18 // We use windows virtual keycodes throughout our keyboard event related code,
  19 // including unit tests. But Mac uses a different set of virtual keycodes.
  20 // This function converts a windows virtual keycode into Mac's virtual key code
  21 // and corresponding unicode character. |flags| is the Cocoa modifiers mask
  22 // such as NSControlKeyMask, NSShiftKeyMask, etc.
  23 // When success, the corresponding Mac's virtual key code will be returned.
  24 // The corresponding unicode character will be stored in |character|, and the
  25 // corresponding unicode character ignoring the modifiers will be stored in
  26 // |characterIgnoringModifiers|.
  27 // -1 will be returned if the keycode can't be converted.
  28 // This function is mainly for simulating keyboard events in unit tests.
  29 // See |KeyboardCodeFromNSEvent| for reverse conversion.
  30 EVENTS_BASE_EXPORT int MacKeyCodeForWindowsKeyCode(
  31     KeyboardCode keycode,
  32     NSUInteger flags,
  33     unichar* character,
  34     unichar* characterIgnoringModifiers);
  35
  36 // This implementation cribbed from:
  37 //   third_party/WebKit/Source/web/mac/WebInputEventFactory.mm
  38 // Converts |event| into a |KeyboardCode|.  The mapping is not direct as the Mac
  39 // has a different notion of key codes.
  40 EVENTS_BASE_EXPORT KeyboardCode KeyboardCodeFromNSEvent(NSEvent* event);
  41
  42 EVENTS_BASE_EXPORT DomCode CodeFromNSEvent(NSEvent* event);
  43
  44 } // namespace ui
  45
  46 #endif  // UI_EVENTS_KEYCODES_KEYBOARD_CODE_CONVERSION_MAC_H_