comparison runtime/doc/popup.txt @ 17180:8581779aa16f v8.1.1589

patch 8.1.1589: popup window does not indicate scroll position commit https://github.com/vim/vim/commit/75fb0854e93913c4d2cfcd6ef634173c4d13a093 Author: Bram Moolenaar <Bram@vim.org> Date: Tue Jun 25 05:15:58 2019 +0200 patch 8.1.1589: popup window does not indicate scroll position Problem: Popup window does not indicate scroll position. Solution: Add a scrollbar.
author Bram Moolenaar <Bram@vim.org>
date Tue, 25 Jun 2019 05:30:06 +0200
parents 23609a6d8cc7
children 983950357c40
comparison
equal deleted inserted replaced
17179:9c7fd1b6445b 17180:8581779aa16f
85 that it is in. 85 that it is in.
86 86
87 87
88 88
89 TODO: 89 TODO:
90 - When the lines do not fit show a scrollbar (like in the popup menu).
91 - Use the mouse wheel for scrolling.
92 - Have a way to scroll to the botton. (#4577)
90 - Why does 'nrformats' leak from the popup window buffer??? 93 - Why does 'nrformats' leak from the popup window buffer???
91 - When the lines do not fit show a scrollbar (like in the popup menu).
92 Use the mouse wheel for scrolling.
93 - Disable commands, feedkeys(), CTRL-W, etc. in a popup window. 94 - Disable commands, feedkeys(), CTRL-W, etc. in a popup window.
94 Use ERROR_IF_POPUP_WINDOW for more commands. 95 Use ERROR_IF_POPUP_WINDOW for more commands.
95 - Add 'balloonpopup': instead of showing text, let the callback open a popup 96 - Add 'balloonpopup': instead of showing text, let the callback open a popup
96 window and return the window ID. The popup will then be closed when the 97 window and return the window ID. The popup will then be closed when the
97 mouse moves, except when it moves inside the popup. 98 mouse moves, except when it moves inside the popup.
345 \ 'padding': [0,1,0,1], 346 \ 'padding': [0,1,0,1],
346 \ }) 347 \ })
347 < The PopupNotification highlight group is used instead of 348 < The PopupNotification highlight group is used instead of
348 WarningMsg if it is defined. 349 WarningMsg if it is defined.
349 350
351 This popup should only be used with the |+timers| feature,
352 otherwise it will not disappear.
353
350 The position will be adjusted to avoid overlap with other 354 The position will be adjusted to avoid overlap with other
351 notifications. 355 notifications.
352 Use {options} to change the properties. 356 Use {options} to change the properties.
353 357
354 358
368 highlight 372 highlight
369 padding 373 padding
370 border 374 border
371 borderhighlight 375 borderhighlight
372 borderchars 376 borderchars
377 scrollbar
373 zindex 378 zindex
374 mask 379 mask
375 time 380 time
376 moved 381 moved
377 filter 382 filter
473 minwidth Minimum width of the contents, excluding border and 478 minwidth Minimum width of the contents, excluding border and
474 padding. 479 padding.
475 firstline First buffer line to display. When larger than one it 480 firstline First buffer line to display. When larger than one it
476 looks like the text scrolled up. When out of range 481 looks like the text scrolled up. When out of range
477 the last buffer line will at the top of the window. 482 the last buffer line will at the top of the window.
483 Also see "scrollbar".
478 hidden When TRUE the popup exists but is not displayed; use 484 hidden When TRUE the popup exists but is not displayed; use
479 `popup_show()` to unhide it. 485 `popup_show()` to unhide it.
480 {not implemented yet} 486 {not implemented yet}
481 tabpage When -1: display the popup on all tab pages. 487 tabpage When -1: display the popup on all tab pages.
482 When 0 (the default): display the popup on the current 488 When 0 (the default): display the popup on the current
523 When the list has two characters the first is used for 529 When the list has two characters the first is used for
524 the border lines, the second for the corners. 530 the border lines, the second for the corners.
525 By default a double line is used all around when 531 By default a double line is used all around when
526 'encoding' is "utf-8" and 'ambiwidth' is "single", 532 'encoding' is "utf-8" and 'ambiwidth' is "single",
527 otherwise ASCII characters are used. 533 otherwise ASCII characters are used.
534 scrollbar non-zero: show a scrollbar when the text doesn't fit.
535 zero: do not show a scrollbar. Default is non-zero.
528 zindex Priority for the popup, default 50. Minimum value is 536 zindex Priority for the popup, default 50. Minimum value is
529 1, maximum value is 32000. 537 1, maximum value is 32000.
530 mask A list of lists with coordinates, defining parts of 538 mask A list of lists with coordinates, defining parts of
531 the popup that are transparent. See |popup-mask|. 539 the popup that are transparent. See |popup-mask|.
532 time Time in milliseconds after which the popup will close. 540 time Time in milliseconds after which the popup will close.