From 14740eeb8a82ace268bc105e84d25f53e1b73d52 Mon Sep 17 00:00:00 2001 From: Heilig Benedek Date: Mon, 16 Nov 2015 14:51:26 +0100 Subject: [PATCH] Merging keyCode and keyIdentifier and adjusting the docs accordingly --- atom/common/keyboad_util.cc | 2 +- atom/common/keyboad_util.h | 2 +- .../common/native_mate_converters/blink_converter.cc | 2 +- docs/api/web-contents.md | 12 +++++------- 4 files changed, 8 insertions(+), 10 deletions(-) diff --git a/atom/common/keyboad_util.cc b/atom/common/keyboad_util.cc index 942637786198..7d7c5d99fabe 100644 --- a/atom/common/keyboad_util.cc +++ b/atom/common/keyboad_util.cc @@ -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; diff --git a/atom/common/keyboad_util.h b/atom/common/keyboad_util.h index 78e8021547d9..4a85c190635d 100644 --- a/atom/common/keyboad_util.h +++ b/atom/common/keyboad_util.h @@ -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 diff --git a/atom/common/native_mate_converters/blink_converter.cc b/atom/common/native_mate_converters/blink_converter.cc index e82b656e26ea..2c871276ba26 100644 --- a/atom/common/native_mate_converters/blink_converter.cc +++ b/atom/common/native_mate_converters/blink_converter.cc @@ -164,7 +164,7 @@ bool Converter::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 diff --git a/docs/api/web-contents.md b/docs/api/web-contents.md index 50d39ac91784..6acfae5c03be 100644 --- a/docs/api/web-contents.md +++ b/docs/api/web-contents.md @@ -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: