aboutsummaryrefslogtreecommitdiff
path: root/runtime
diff options
context:
space:
mode:
authorBjörn Linse <bjorn.linse@gmail.com>2019-03-02 17:26:50 +0100
committerGitHub <noreply@github.com>2019-03-02 17:26:50 +0100
commit7a6da502b9d8deecfc89d1497a8e8da15e65f31e (patch)
treee3811b52dd00e67175383f11f1b67b42acc88f4c /runtime
parent0aba4d825a5b18c5fa937c0426788f61f756e086 (diff)
parent9a1675b065394734ddaef91a314896028e2b1d46 (diff)
downloadrneovim-7a6da502b9d8deecfc89d1497a8e8da15e65f31e.tar.gz
rneovim-7a6da502b9d8deecfc89d1497a8e8da15e65f31e.tar.bz2
rneovim-7a6da502b9d8deecfc89d1497a8e8da15e65f31e.zip
Merge pull request #6619 from bfredl/floating
Floating windows in TUI and Remote UI
Diffstat (limited to 'runtime')
-rw-r--r--runtime/doc/ui.txt18
-rw-r--r--runtime/doc/windows.txt4
2 files changed, 20 insertions, 2 deletions
diff --git a/runtime/doc/ui.txt b/runtime/doc/ui.txt
index 77a829b150..270c4fb556 100644
--- a/runtime/doc/ui.txt
+++ b/runtime/doc/ui.txt
@@ -520,19 +520,33 @@ tabs.
size). If the window was previously hidden, it should now be shown
again.
+["win_float_pos", grid, win, anchor, anchor_grid, anchor_row, anchor_col, focusable]
+ Display or reconfigure floating window `win`. The window should be
+ displayed above another grid `anchor_grid` at the specified position
+ `anchor_row` and `anchor_col`. For the meaning of `anchor` and more
+ details of positioning, see |nvim_open_win()|.
+
+["win_external_pos", grid, win]
+ Display or reconfigure external window `win`. The window should be
+ displayed as a separate top-level window in the desktop envirionment,
+ or something similar.
+
["win_hide", grid]
- Stop displaying the window.
+ Stop displaying the window. The window can be shown again later.
["win_scroll_over_start"]
Hint that following `grid_scroll` on the default grid should
scroll over windows. This is a temporary workaround to allow
UIs to use the builtin message drawing. Later on, messages will be
- drawn on a dedicated grid.
+ drawn on a dedicated grid. Using |ui-messages| also avoids this issue.
["win_scroll_over_reset"]
Hint that scrolled over windows should be redrawn again, and not be
overdrawn by default grid scrolling anymore.
+["win_close", grid]
+ Close the window.
+
See |ui-linegrid| for grid events.
See |nvim_ui_try_resize_grid| in |api-ui| to request changing the grid size.
See |nvim_input_mouse| for sending mouse events to Nvim.
diff --git a/runtime/doc/windows.txt b/runtime/doc/windows.txt
index 2e4b6f6e76..6e1ad0f1f4 100644
--- a/runtime/doc/windows.txt
+++ b/runtime/doc/windows.txt
@@ -197,6 +197,10 @@ CTRL-W ^ Does ":split #", split window in two and edit alternate file.
When a count is given, it becomes ":split #N", split window
and edit buffer N.
+CTRL-W ge *CTRL-W_ge*
+ Detach the current window as an external window.
+ Only available when using an UI with |ui-multigrid| support.
+
Note that the 'splitbelow' and 'splitright' options influence where a new
window will appear.