diff options
| author | bruvzg <7645683+bruvzg@users.noreply.github.com> | 2019-06-04 10:30:59 +0300 |
|---|---|---|
| committer | bruvzg <7645683+bruvzg@users.noreply.github.com> | 2019-06-04 11:29:00 +0300 |
| commit | 8ff72987c07cba4d8e42c185e782ee4f43da0b46 (patch) | |
| tree | 260b0b6473c086505898461c4b8f15f4f06e42f6 /doc | |
| parent | 774a9fde84a0282c40da1dd891b613ed200ff9a8 (diff) | |
[macOS] Fixes unicode input with IME mode inactive, Improves IME mode documentation.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/InputEventKey.xml | 2 | ||||
| -rw-r--r-- | doc/classes/OS.xml | 9 |
2 files changed, 8 insertions, 3 deletions
diff --git a/doc/classes/InputEventKey.xml b/doc/classes/InputEventKey.xml index 86a1362230..53b1f74bd4 100644 --- a/doc/classes/InputEventKey.xml +++ b/doc/classes/InputEventKey.xml @@ -29,7 +29,7 @@ Key scancode, one of the [enum KeyList] constants. </member> <member name="unicode" type="int" setter="set_unicode" getter="get_unicode"> - Key unicode identifier when relevant. + Key unicode identifier when relevant. Unicode identifiers for the composite characters and complex scripts may not be available unless IME input mode is active. See [method OS.set_ime_active] for more information. </member> </members> <constants> diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index dd0fcd63e7..f7cd6c3e83 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -221,14 +221,16 @@ <return type="Vector2"> </return> <description> - Returns IME selection range. + Returns IME cursor position (currently edited portion of the string) relative to the characters in the composition string. + [code]NOTIFICATION_OS_IME_UPDATE[/code] is sent to the application to notify it of changes to the IME cursor position. </description> </method> <method name="get_ime_text" qualifiers="const"> <return type="String"> </return> <description> - Returns IME intermediate text. + Returns IME intermediate composition string. + [code]NOTIFICATION_OS_IME_UPDATE[/code] is sent to the application to notify it of changes to the IME composition string. </description> </method> <method name="get_latin_keyboard_variant" qualifiers="const"> @@ -710,6 +712,9 @@ </argument> <description> Sets whether IME input mode should be enabled. + If active IME handles key events before the application and creates an composition string and suggestion list. + Application can retrieve the composition status by using [method get_ime_selection] and [method get_ime_text] functions. + Completed composition string is committed when input is finished. </description> </method> <method name="set_ime_position"> |