diff options
Diffstat (limited to 'runtime/doc')
| -rw-r--r-- | runtime/doc/api.txt | 8 | ||||
| -rw-r--r-- | runtime/doc/options.txt | 21 |
2 files changed, 26 insertions, 3 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index 065a052175..709e5885e4 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -284,14 +284,18 @@ highlighting, or |api-highlights|. By default, floats will use |hl-NormalFloat| as normal highlight, which links to |hl-Pmenu| in the builtin color scheme. The 'winhighlight' option can be used to override it. Currently, floating windows don't support any visual -decorations like a border or additional widgets like scrollbar. +decorations like a border or additional widgets like scrollbar. By default, +floats will inherit options from the current window. This is not always +useful for some options, like 'number'. Use `style='minimal'` flag to +|nvim_open_win()| to disable many UI features that are unwanted for a simple +float, like end-of-buffer region or special columns. Here is an example for creating a float with scratch buffer: > let buf = nvim_create_buf(v:false, v:true) call nvim_buf_set_lines(buf, 0, -1, v:true, ["test", "text"]) let opts = {'relative': 'cursor', 'width': 10, 'height': 2, 'col': 0, - \ 'row': 1, 'anchor': 'NW'} + \ 'row': 1, 'anchor': 'NW', 'style': 'minimal'} let win = nvim_open_win(buf, 0, opts) " optional: change highlight, otherwise Pmenu is used call nvim_win_set_option(win, 'winhl', 'Normal:MyHighlight') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 7c9ad3010e..8fc8a04df3 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -4202,7 +4202,7 @@ A jump table for the options with a short description can be found at |Q_op|. rows in the window, depending on whether 'number' or 'relativenumber' is set. Thus with the Vim default of 4 there is room for a line number up to 999. When the buffer has 1000 lines five columns will be used. - The minimum value is 1, the maximum value is 10. + The minimum value is 1, the maximum value is 20. *'omnifunc'* *'ofu'* 'omnifunc' 'ofu' string (default: empty) @@ -4552,6 +4552,25 @@ A jump table for the options with a short description can be found at |Q_op|. set for the newly edited buffer. See 'modifiable' for disallowing changes to the buffer. + *'redrawdebug'* *'rdb'* +'redrawdebug' 'rdb' string (default '') + global + Flags to change the way redrawing works, for debugging purposes. + Most useful with 'writedelay' set to some reasonable value. + Supports the following flags: + compositor Indicate what redraws come from the compositor + by briefly flashing the redrawn regions in colors + indicating the redraw type. These are the highlight + groups used (and their default colors): + RedrawDebugNormal gui=reverse normal redraw passed through + RedrawDebugClear guibg=Yellow clear event passed through + RedrawDebugComposed guibg=Green redraw event modified by the + compositor (due to + overlapping grids, etc) + RedrawDebugRecompose guibg=Red redraw generated by the + compositor itself, due to a + grid being moved or deleted. + *'redrawtime'* *'rdt'* 'redrawtime' 'rdt' number (default 2000) global |