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

50
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 `relative`: If set, the window becomes a
floating window. The window will be placed with floating window. The window will be placed with
row,col coordinates relative one of the row,col coordinates relative one of the
following: "editor" the global editor grid following:
"editor" the global editor grid
"win" a window. Use 'win' option below to "win" a window. Use 'win' option below to
specify window id, or current window will be specify window id, or current window will
used by default. "cursor" the cursor position be used by default.
in current window. `anchor`: the corner of the "cursor" the cursor position in current window.
float that the row,col position defines "NW"
north-west (default) "NE" north-east "SW" `anchor`: the corner of the float that the row,col
south-west "SE" south-east `focusable`: Whether position defines
window can be focused by wincmds and mouse "NW" north-west (default)
events. Defaults to true. Even if set to false, "NE" north-east
"SW" south-west
"SE" south-east
`focusable`: Whether window can be focused by wincmds and
mouse events. Defaults to true. Even if set to false,
the window can still be entered using the window can still be entered using
|nvim_set_current_win()| API call. `row`: row |nvim_set_current_win()| API call.
position. Screen cell height are used as unit.
Can be floating point. `col`: column position. `row`: row position. Screen cell height are used as unit.
Screen cell width is used as unit. Can be Can be floating point.
floating point. `win`: when using
relative='win', window id of the window where `col`: column position. Screen cell width is used as
the position is defined. `external` GUI should unit. Can be floating point.
display the window as an external top-level
window. Currently accepts no other positioning `win`: when using relative='win', window id of the window
options together with this. 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,