diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2019-11-25 08:56:42 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-11-25 08:56:42 -0800 |
| commit | 36d1335a667d54c26ab7cca23bc60998cb8e0fb2 (patch) | |
| tree | af85eb985ad73cad656b3b16221fde95bcbc0f68 /runtime | |
| parent | 4a77df2e518a51ffd5a5fe311424b4b5305009a7 (diff) | |
| download | rneovim-36d1335a667d54c26ab7cca23bc60998cb8e0fb2.tar.gz rneovim-36d1335a667d54c26ab7cca23bc60998cb8e0fb2.tar.bz2 rneovim-36d1335a667d54c26ab7cca23bc60998cb8e0fb2.zip | |
UI: emit mouse_on/mouse_off on attach #11455
closes #11372
Diffstat (limited to 'runtime')
| -rw-r--r-- | runtime/doc/develop.txt | 4 | ||||
| -rw-r--r-- | runtime/doc/ui.txt | 14 |
2 files changed, 9 insertions, 9 deletions
diff --git a/runtime/doc/develop.txt b/runtime/doc/develop.txt index ba887a83c8..4c1430ab1f 100644 --- a/runtime/doc/develop.txt +++ b/runtime/doc/develop.txt @@ -349,8 +349,8 @@ External UIs are expected to implement these common features: chords (<C-,> <C-Enter> <C-S-x> <D-x>) and patterns ("shift shift") that do not potentially conflict with Nvim defaults, plugins, etc. - Consider the "option_set" |ui-global| event as a hint for other GUI - behaviors. UI-related options ('guifont', 'ambiwidth', …) are published in - this event. + behaviors. Various UI-related options ('guifont', 'ambiwidth', …) are + published in this event. See also "mouse_on", "mouse_off". vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/runtime/doc/ui.txt b/runtime/doc/ui.txt index a2f19593ae..d5f4a59ab3 100644 --- a/runtime/doc/ui.txt +++ b/runtime/doc/ui.txt @@ -201,8 +201,8 @@ the editor. sent from Nvim, like for |ui-cmdline|. ["mode_change", mode, mode_idx] - The mode changed. The first parameter `mode` is a string representing - the current mode. `mode_idx` is an index into the array received in + Editor mode changed. The `mode` parameter is a string representing + the current mode. `mode_idx` is an index into the array emitted in the `mode_info_set` event. UIs should change the cursor style according to the properties specified in the corresponding item. The set of modes reported will change in new versions of Nvim, for @@ -211,11 +211,11 @@ the editor. ["mouse_on"] ["mouse_off"] - Tells the client whether mouse support, as determined by |'mouse'| - option, is considered to be active in the current mode. This is mostly - useful for a terminal frontend, or other situations where Nvim mouse - would conflict with other usages of the mouse. It is safe for a client - to ignore this and always send mouse events. + |'mouse'| was enabled/disabled in the current editor mode. Useful for + a terminal UI, or other situations where Nvim mouse would conflict + with other usages of the mouse. UIs may ignore this and always send + mouse input, because 'mouse' decides the behavior of |nvim_input()| + implicitly. ["busy_start"] ["busy_stop"] |