diff options
author | Bram Moolenaar <Bram@vim.org> | 2019-07-18 13:46:42 +0200 |
---|---|---|
committer | Bram Moolenaar <Bram@vim.org> | 2019-07-18 13:46:42 +0200 |
commit | df9c6cad8cc318e26e99c3b055f0788e7d6582de (patch) | |
tree | d4dda056c1fb416f0a00d791c50629dab843dc57 /runtime/doc/popup.txt | |
parent | d6bcff457799e491c3d27880858ec08e758e1849 (diff) |
patch 8.1.1713: highlighting cursor line only works with popup_menu()v8.1.1713
Problem: Highlighting cursor line only works with popup_menu().
Solution: Add the "cursorline" property. (Naruhiko Nishino, closes #4671)
Diffstat (limited to 'runtime/doc/popup.txt')
-rw-r--r-- | runtime/doc/popup.txt | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/runtime/doc/popup.txt b/runtime/doc/popup.txt index cbe83107de..1b39bcf679 100644 --- a/runtime/doc/popup.txt +++ b/runtime/doc/popup.txt @@ -303,7 +303,7 @@ popup_getoptions({id}) *popup_getoptions()* zero. When all values are one then an empty list is included. "borderhighlight" is not included when all values are empty. - "scrollbarhighlight" and "thumbhighlight" are onlu included + "scrollbarhighlight" and "thumbhighlight" are only included when set. "tabpage" will be -1 for a global popup, zero for a popup on @@ -345,7 +345,7 @@ popup_hide({id}) *popup_hide()* popup_locate({row}, {col}) *popup_locate()* - Return the |window-ID| of the popup at screen positoin {row} + Return the |window-ID| of the popup at screen position {row} and {col}. If there are multiple popups the one with the highest zindex is returned. If there are no popups at this position then zero is returned. @@ -362,6 +362,7 @@ popup_menu({what}, {options}) *popup_menu()* \ drag: 1, \ wrap: 0, \ border: [], + \ cursorline: 1, \ padding: [0,1,0,1], \ filter: 'popup_filter_menu', \ }) @@ -429,6 +430,7 @@ popup_setoptions({id}, {options}) *popup_setoptions()* callback close drag + cursorline filter firstline flip @@ -598,6 +600,11 @@ The second argument of |popup_create()| is a dictionary with options: {start} or after {end} The popup also closes if the cursor moves to another line or to another window. + cursorline non-zero: Highlight the cursor line. Also scrolls the + text to show this line (only works properly + when 'wrap' is off). + zero: Do not highlight the cursor line. + Default is zero, except for |popup_menu()|. filter A callback that can filter typed characters, see |popup-filter|. callback A callback that is called when the popup closes, e.g. @@ -695,8 +702,8 @@ If the text does not fit in the popup a scrollbar is displayed on the right of the window. This can be disabled by setting the "scrollbar" option to zero. When the scrollbar is displayed mouse scroll events, while the mouse pointer is on the popup, will cause the text to scroll up or down as you would expect. -A click in the upper halve of the scrollbar will scroll the text one line -down. A click in the lower halve wil scroll the text one line up. However, +A click in the upper half of the scrollbar will scroll the text one line +down. A click in the lower half wil scroll the text one line up. However, this is limited so that the popup does not get smaller. @@ -709,7 +716,7 @@ list has four numbers: leftmost, negative for counting from the right, -1 for rightmost endcol last column, like "col" - line start line, positive for conting from the top, 1 for top, + line start line, positive for counting from the top, 1 for top, negative for counting from the bottom, -1 for bottom endline end line, like "line" |