diff options
author | Dongdong Zhou <dzhou121@gmail.com> | 2017-02-23 05:33:14 +0000 |
---|---|---|
committer | Björn Linse <bjorn.linse@gmail.com> | 2017-10-26 09:35:12 +0200 |
commit | 439c39a2cfb0712eb68ad76354b1fd7e92bb71fe (patch) | |
tree | c8418962db8b412fd293f6f25c583ad4a8688e54 /runtime/doc/msgpack_rpc.txt | |
parent | f0c2f82e90046487a8c12c10ca6c8da23470ef09 (diff) | |
download | rneovim-439c39a2cfb0712eb68ad76354b1fd7e92bb71fe.tar.gz rneovim-439c39a2cfb0712eb68ad76354b1fd7e92bb71fe.tar.bz2 rneovim-439c39a2cfb0712eb68ad76354b1fd7e92bb71fe.zip |
ext_cmdline: allow external ui to draw cmdline
Diffstat (limited to 'runtime/doc/msgpack_rpc.txt')
-rw-r--r-- | runtime/doc/msgpack_rpc.txt | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/runtime/doc/msgpack_rpc.txt b/runtime/doc/msgpack_rpc.txt index 98a74ccfd6..4a82b3a1bd 100644 --- a/runtime/doc/msgpack_rpc.txt +++ b/runtime/doc/msgpack_rpc.txt @@ -260,12 +260,23 @@ a dictionary with these (optional) keys: colors. Set to false to use terminal color codes (at most 256 different colors). + `ext_popupmenu` Externalize the popupmenu. |ui-ext-popupmenu| `ext_tabline` Externalize the tabline. |ui-ext-tabline| Externalized widgets will not be drawn by Nvim; only high-level data will be published in new UI event kinds. + `popupmenu_external`: Instead of drawing the completion popupmenu on + the grid, Nvim will send higher-level events to + the ui and let it draw the popupmenu. + Defaults to false. + cmdline_external: Instead of drawing the cmdline on + the grid, Nvim will send higher-level events to + the ui and let it draw the cmdline. + Defaults to false. + + Nvim will then send msgpack-rpc notifications, with the method name "redraw" and a single argument, an array of screen updates (described below). These should be processed in order. Preferably the user should only be able to see @@ -441,5 +452,27 @@ states might be represented as separate modes. curtab: Current Tabpage tabs: List of Dicts [{ "tab": Tabpage, "name": String }, ...] +["cmdline_enter"] + Enter the cmdline. + +["cmdline_leave"] + Leave the cmdline. + +["cmdline_firstc", firstc] + The first character of the command, which could be : / ? etc. With + the firstc, you know wheither it's a command or a search. + +["cmdline", content, pos] + When cmdline_external is set to true, nvim will not draw the cmdline + on the grad, instead nvim will send ui events of the cmdline content + and cursor position to the remote ui. The content is the full content + that should be displayed in the cmdline, and the pos is the position + of the cursor that in the cmdline. This event will be triggered when + you type in the cmdline. + +["cmdline_pos", pos] + When you move your cursor, nvim will send out this event which tells + you the current position of the cursor in the cmdline. + ============================================================================== vim:tw=78:ts=8:noet:ft=help:norl: |