diff options
Diffstat (limited to 'runtime/doc/ui.txt')
| -rw-r--r-- | runtime/doc/ui.txt | 40 |
1 files changed, 23 insertions, 17 deletions
diff --git a/runtime/doc/ui.txt b/runtime/doc/ui.txt index 73eb2210f5..bfcd0369ad 100644 --- a/runtime/doc/ui.txt +++ b/runtime/doc/ui.txt @@ -25,13 +25,20 @@ done by an embedder, see |ui-startup| below for details, but an UI can also connect to a running nvim instance and invoke this method. `options` must be a dictionary with these (optional) keys: `rgb` Decides the color format. *ui-rgb* - Set true (default) for 24-bit RGB colors. - Set false for terminal colors (max of 256). + true: (default) 24-bit RGB colors + false: Terminal colors (8-bit, max 256) + `override` Decides how UI capabilities are resolved. + true: Enable requested UI capabilities, even + if not supported by all connected UIs + (including |TUI|). + false: (default) Disable UI capabilities not + supported by all connected UIs + (including TUI). *ui-ext-options* - `ext_popupmenu` Externalize the popupmenu. |ui-popupmenu| + `ext_popupmenu` Externalize |popupmenu-completion| and + 'wildmenu'. |ui-popupmenu| `ext_tabline` Externalize the tabline. |ui-tabline| `ext_cmdline` Externalize the cmdline. |ui-cmdline| - `ext_wildmenu` Externalize the wildmenu (deprecated). |ui-wildmenu| `ext_messages` Externalize messages. |ui-messages| `ext_linegrid` Use new revision of the grid events. |ui-linegrid| `ext_multigrid` Use per-window grid based events. |ui-multigrid| @@ -245,9 +252,9 @@ numerical highlight ids to the actual attributes. implementation, where using the terminal builtin ("ANSI") defaults are expected. - Note: unlike the corresponding events in the first revision, the - screen is not always cleared after sending this event. The GUI has to - repaint the screen with changed background color itself. + Note: Unlike the corresponding |ui-grid-old| events, the screen is not + always cleared after sending this event. The UI must repaint the + screen with changed background color itself. *ui-event-hl_attr_define* ["hl_attr_define", id, rgb_attr, cterm_attr, info] @@ -554,6 +561,7 @@ See |nvim_input_mouse| for sending mouse events to Nvim. Popupmenu Events *ui-popupmenu* Only sent if `ext_popupmenu` option is set in |ui-options|. +Events for |popupmenu-completion| and command-line 'wildmenu'. ["popupmenu_show", items, selected, row, col, grid] Show |popupmenu-completion|. `items` is an array of completion items @@ -590,9 +598,7 @@ Only sent if `ext_tabline` option is set in |ui-options| Cmdline Events *ui-cmdline* Only sent if `ext_cmdline` option is set in |ui-options|. To handle -command-line completion (wildmenu), use |ui-popupmenu| events activated by -|ext_popupmenu| option. (The `ext_wildmenu` option only exists for backwards -compatibility). +command-line 'wildmenu', enable |ui-popupmenu| and handle its events. ["cmdline_show", content, pos, firstc, prompt, indent, level] content: List of [attrs, string] @@ -650,18 +656,18 @@ compatibility). ============================================================================== Message Events *ui-messages* -Only sent if `ext_messages` option is set in |ui-options|. This option implies -`ext_linegrid` and `ext_cmdline` also being set. |ui-linegrid| and |ui-cmdline| events -will thus also be sent. +Only sent if `ext_messages` option is set in |ui-options|. This option +implicitly enables `ext_linegrid` and `ext_cmdline`. |ui-linegrid| and +|ui-cmdline| events will thus also be sent. This extension allows the UI to control the display of messages that otherwise would have been displayed in the message/cmdline area in the bottom of the screen. -Activating this extension means that Nvim will allocate no screen space for -the cmdline or messages, and 'cmdheight' will be set to zero. Attempting to -change 'cmdheight' will silently be ignored. |ui-cmdline| events will be used -to represent the state of the cmdline. +Activating this extension means that Nvim will not allocate screen space for +the cmdline or messages, 'cmdheight' will be zero. Attempting to change +'cmdheight' will be silently ignored. |ui-cmdline| events represent the state +of the cmdline. ["msg_show", kind, content, replace_last] Display a message to the user. |