Merging keyCode and keyIdentifier and adjusting the docs accordingly
authorHeilig Benedek <benecene@gmail.com>
Mon, 16 Nov 2015 13:51:26 +0000 (14:51 +0100)
committerHeilig Benedek <benecene@gmail.com>
Mon, 16 Nov 2015 13:51:26 +0000 (14:51 +0100)
atom/common/keyboad_util.cc
atom/common/keyboad_util.h
atom/common/native_mate_converters/blink_converter.cc
docs/api/web-contents.md

index 9426377..7d7c5d9 100644 (file)
@@ -73,7 +73,7 @@ ui::KeyboardCode KeyboardCodeFromCharCode(base::char16 c, bool* shifted) {
 }
 
 // Return key code of the char.
-ui::KeyboardCode KeyboardCodeFromKeyIdentifier(std::string chr) {
+ui::KeyboardCode KeyboardCodeFromKeyIdentifier(const std::string& chr) {
   if (chr == "enter")        return ui::VKEY_RETURN;
   if (chr == "backspace")    return ui::VKEY_BACK;
   if (chr == "delete")       return ui::VKEY_DELETE;
index 78e8021..4a85c19 100644 (file)
@@ -16,7 +16,7 @@ namespace atom {
 ui::KeyboardCode KeyboardCodeFromCharCode(base::char16 c, bool* shifted);
 
 // Return key code of the char from a string representation of the char
-ui::KeyboardCode KeyboardCodeFromKeyIdentifier(std::string chr);
+ui::KeyboardCode KeyboardCodeFromKeyIdentifier(const std::string& chr);
 
 }  // namespace atom
 
index e82b656..2c87127 100644 (file)
@@ -164,7 +164,7 @@ bool Converter<blink::WebKeyboardEvent>::FromV8(
 
   if (dict.Get("keyCode", &code))
     out->windowsKeyCode = atom::KeyboardCodeFromCharCode(code, &shifted);
-  else if (dict.Get("keyIdentifier", &identifier))
+  else if (dict.Get("keyCode", &identifier))
     out->windowsKeyCode = atom::KeyboardCodeFromKeyIdentifier(
       base::StringToLowerASCII(identifier));
   else
index 50d39ac..6acfae5 100644 (file)
@@ -593,14 +593,12 @@ Disable device emulation enabled by `webContents.enableDeviceEmulation`.
 Sends an input `event` to the page.
 
 For keyboard events, the `event` object also have following properties:
-(only one of `keyCode` and `keyIdentifier` is required)
-
-* `keyCode` Char (**required**) - A single character that will be sent as
-  keyboard event. Can be any UTF-8 character.
-* `keyIdentifier` String (**required**) - A text representation of the character
-  that will be sent as keyboard event, can be `Enter`, `Backspace`, `Delete`,
-  `Tab`, `Escape`, `Control`, `Alt`, `Shift`, `End`, `Home`, `Insert`, `Left`,
-  `Up`, `Right`, `Down`, `PageUp`, `PageDown`, `PrintScreen`
+
+* `keyCode` Char or String (**required**) - The character that will be sent
+  as the keyboard event. Can be a single UTF-8 character, or the name of the
+  key that generates the event. Accepted key names are `enter`, `backspace`,
+  `delete`, `tab`, `escape`, `control`, `alt`, `shift`, `end`, `home`, `insert`,
+  `left`, `up`, `right`, `down`, `pageUp`, `pageDown`, `printScreen`
 
 For mouse events, the `event` object also have following properties: