mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-09-13 06:48:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: adjust the generated nvim_open_win docs

Browse Source 
The format here is not meant to be ideal, just a backstop until
auto-generation has been fixed.
This commit is contained in:
Björn Linse
2019-03-12 13:55:22 +01:00
parent f9d3e69cc9
commit dec3e027d9
1 changed files with 36 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
runtime/doc/api.txt
View File

@@ -647,30 +647,42 @@ nvim_open_win({buffer}, {enter}, {width}, {height}, {options})
{height} height of window (in character cells) {height} height of window (in character cells)
{options} dict of options for configuring window {options} dict of options for configuring window
positioning accepts the following keys: positioning accepts the following keys:
`relative`: If set, the window becomes a
floating window. The window will be placed with `relative`: If set, the window becomes a
row,col coordinates relative one of the floating window. The window will be placed with
following: "editor" the global editor grid row,col coordinates relative one of the
"win" a window. Use 'win' option below to following:
specify window id, or current window will be "editor" the global editor grid
used by default. "cursor" the cursor position "win" a window. Use 'win' option below to
in current window. `anchor`: the corner of the specify window id, or current window will
float that the row,col position defines "NW" be used by default.
north-west (default) "NE" north-east "SW" "cursor" the cursor position in current window.
south-west "SE" south-east `focusable`: Whether
window can be focused by wincmds and mouse `anchor`: the corner of the float that the row,col
events. Defaults to true. Even if set to false, position defines
the window can still be entered using "NW" north-west (default)
|nvim_set_current_win()| API call. `row`: row "NE" north-east
position. Screen cell height are used as unit. "SW" south-west
Can be floating point. `col`: column position. "SE" south-east
Screen cell width is used as unit. Can be
floating point. `win`: when using `focusable`: Whether window can be focused by wincmds and
relative='win', window id of the window where mouse events. Defaults to true. Even if set to false,
the position is defined. `external` GUI should the window can still be entered using
display the window as an external top-level |nvim_set_current_win()| API call.
window. Currently accepts no other positioning
options together with this. `row`: row position. Screen cell height are used as unit.
Can be floating point.
`col`: column position. Screen cell width is used as
unit. Can be floating point.
`win`: when using relative='win', window id of the window
where the position is defined.
`external`: GUI should display the window as an external
top-level window. Currently accepts no other
positioning options together with this.
With editor positioning row=0, col=0 refers to the top-left With editor positioning row=0, col=0 refers to the top-left
corner of the screen-grid and row=Lines-1, Columns-1 refers to corner of the screen-grid and row=Lines-1, Columns-1 refers to
the bottom-right corner. Floating point values are allowed, the bottom-right corner. Floating point values are allowed,