summaryrefslogtreecommitdiffstats
path: root/runtime/doc
diff options
context:
space:
mode:
authorBram Moolenaar <Bram@vim.org>2019-04-08 20:01:47 +0200
committerBram Moolenaar <Bram@vim.org>2019-04-08 20:01:47 +0200
commit46ad288b9b2a6eb0430cf802ff5ce68a58629897 (patch)
treec4122a4f891cd211e2604b690cefef88b2d7c8ff /runtime/doc
parent9845f36aa6ba28e0aa388bb635d4bb8ab56f1a47 (diff)
patch 8.1.1140: not easy to find out what neighbors a window hasv8.1.1140
Problem: Not easy to find out what neighbors a window has. Solution: Add more arguments to winnr(). (Yegappan Lakshmanan, closes #3993)
Diffstat (limited to 'runtime/doc')
-rw-r--r--runtime/doc/eval.txt29
1 files changed, 21 insertions, 8 deletions
diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt
index 8a4a54c55b..c454f96dcb 100644
--- a/runtime/doc/eval.txt
+++ b/runtime/doc/eval.txt
@@ -10198,17 +10198,30 @@ winline() The result is a Number, which is the screen line of the cursor
*winnr()*
winnr([{arg}]) The result is a Number, which is the number of the current
window. The top window has number 1.
- When the optional argument is "$", the number of the
- last window is returned (the window count). >
- let window_count = winnr('$')
-< When the optional argument is "#", the number of the last
- accessed window is returned (where |CTRL-W_p| goes to).
- If there is no previous window or it is in another tab page 0
- is returned.
+
+ The optional argument {arg} supports the following values:
+ $ the number of the last window (the window
+ count).
+ # the number of the last accessed window (where
+ |CTRL-W_p| goes to). If there is no previous
+ window or it is in another tab page 0 is
+ returned.
+ {N}j the number of the Nth window below the
+ current window (where |CTRL-W_j| goes to).
+ {N}k the number of the Nth window above the current
+ window (where |CTRL-W_k| goes to).
+ {N}h the number of the Nth window left of the
+ current window (where |CTRL-W_h| goes to).
+ {N}l the number of the Nth window right of the
+ current window (where |CTRL-W_l| goes to).
The number can be used with |CTRL-W_w| and ":wincmd w"
|:wincmd|.
Also see |tabpagewinnr()| and |win_getid()|.
-
+ Examples: >
+ let window_count = winnr('$')
+ let prev_window = winnr('#')
+ let wnum = winnr('3k')
+<
*winrestcmd()*
winrestcmd() Returns a sequence of |:resize| commands that should restore
the current window sizes. Only works properly when no windows