vim: runtime/doc/popup.txt annotate

annotate runtime/doc/popup.txt @ 17320:33dccaafb214 v8.1.1659

patch 8.1.1659: popup window "mousemoved" values not correct commit https://github.com/vim/vim/commit/b05caa782dbab51db8de60940eff7992f8cfd882 Author: Bram Moolenaar <Bram@vim.org> Date: Wed Jul 10 21:55:54 2019 +0200 patch 8.1.1659: popup window "mousemoved" values not correct Problem: Popup window "mousemoved" values not correct. Solution: Convert text column to mouse column.

author	Bram Moolenaar <Bram@vim.org>
date	Wed, 10 Jul 2019 22:00:04 +0200
parents	8a095d343c59
children	d82b0cfb1e82

rev	line source
17257 cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	1 popup.txt For Vim version 8.1. Last change: 2019 Jul 04
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	2
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	3
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	4 VIM REFERENCE MANUAL by Bram Moolenaar
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	5
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	6
17257 cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	7 Displaying text in a floating window. popup popup-window
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	8
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	9
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	10 1. Introduction \|popup-intro\|
17257 cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	11 Window position and size \|popup-position\|
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	12 Closing the popup window \|popup-close\|
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	13 Popup buffer and window \|popup-buffer\|
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	14 2. Functions \|popup-functions\|
17257 cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	15 Details \|popup-function-details\|
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	16 3. Usage \|popup-usage\|
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	17 popup_create() arguments \|popup_create-arguments\|
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	18 Popup text properties \|popup-props\|
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	19 Popup filter \|popup-filter\|
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	20 Popup callback \|popup-callback\|
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	21 Popup scrollbar \|popup-scrollbar\|
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	22 Popup mask \|popup-mask\|
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	23 4. Examples \|popup-examples\|
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	24
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	25
16871 e5dab34ded73 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16859 diff changeset	26 {not available if the \|+textprop\| feature was disabled at compile time}
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	27
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	28 ==============================================================================
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	29 1. Introduction popup-intro
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	30
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	31 We are talking about popup windows here, text that goes on top of the regular
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	32 windows and is under control of a plugin. You cannot edit the text in the
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	33 popup window like with regular windows.
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	34
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	35 A popup window can be used for such things as:
16808 c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16806 diff changeset	36 - briefly show a message without overwriting the command line
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	37 - prompt the user with a dialog
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	38 - display contextual information while typing
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	39 - give extra information for auto-completion
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	40
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	41 The text in the popup window can be colored with \|text-properties\|. It is
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	42 also possible to use syntax highlighting.
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	43
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	44 The default color used is "Pmenu". If you prefer something else use the
eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	45 "highlight" argument or the 'wincolor' option, e.g.: >
eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	46 hi MyPopupColor ctermbg=lightblue guibg=lightblue
eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	47 call setwinvar(winid, '&wincolor', 'MyPopupColor')
eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	48
17045 7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	49 'hlsearch' highlighting is not displayed in a popup window.
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	50
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	51 A popup window has a window-ID like other windows, but behaves differently.
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	52 The size can be up to the whole Vim window and it overlaps other windows.
17075 dacd46fbaa90 patch 8.1.1537: using "tab" for popup window can be confusing Bram Moolenaar <Bram@vim.org> parents: 17051 diff changeset	53 Popup windows can also overlap each other. The "zindex" property specifies
dacd46fbaa90 patch 8.1.1537: using "tab" for popup window can be confusing Bram Moolenaar <Bram@vim.org> parents: 17051 diff changeset	54 what goes on top of what.
16808 c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16806 diff changeset	55
c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16806 diff changeset	56 The popup window contains a buffer, and that buffer is always associated with
17075 dacd46fbaa90 patch 8.1.1537: using "tab" for popup window can be confusing Bram Moolenaar <Bram@vim.org> parents: 17051 diff changeset	57 the popup window. The window cannot be in Normal, Visual or Insert mode, it
dacd46fbaa90 patch 8.1.1537: using "tab" for popup window can be confusing Bram Moolenaar <Bram@vim.org> parents: 17051 diff changeset	58 does not get keyboard focus. You can use functions like `setbufline()` to
16808 c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16806 diff changeset	59 change the text in the buffer. There are more differences from how this
c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16806 diff changeset	60 window and buffer behave compared to regular windows and buffers, see
c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16806 diff changeset	61 \|popup-buffer\|.
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	62
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	63 If this is not what you are looking for, check out other popup functionality:
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	64 - popup menu, see \|popup-menu\|
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	65 - balloon, see \|balloon-eval\|
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	66
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	67
17257 cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	68 WINDOW POSITION AND SIZE popup-position
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	69
16808 c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16806 diff changeset	70 The height of the window is normally equal to the number of, possibly
c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16806 diff changeset	71 wrapping, lines in the buffer. It can be limited with the "maxheight"
16871 e5dab34ded73 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16859 diff changeset	72 property. You can use empty lines to increase the height or the "minheight"
e5dab34ded73 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16859 diff changeset	73 property.
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	74
eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	75 The width of the window is normally equal to the longest line in the buffer.
eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	76 It can be limited with the "maxwidth" property. You can use spaces to
17045 7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	77 increase the width or use the "minwidth" property.
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	78
16896 52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	79 By default the 'wrap' option is set, so that no text disappears. Otherwise,
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	80 if there is not enough space then the window is shifted left in order to
17219 5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	81 display more text. When right-aligned the window is shifted right to display
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	82 more text. The shifting can be disabled with the "fixed" property.
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	83
16871 e5dab34ded73 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16859 diff changeset	84 Vim tries to show the popup in the location you specify. In some cases, e.g.
e5dab34ded73 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16859 diff changeset	85 when the popup would go outside of the Vim window, it will show it somewhere
17219 5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	86 nearby. E.g. if you use `popup_atcursor()` the popup normally shows just above
16871 e5dab34ded73 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16859 diff changeset	87 the current cursor position, but if the cursor is close to the top of the Vim
e5dab34ded73 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16859 diff changeset	88 window it will be placed below the cursor position.
e5dab34ded73 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16859 diff changeset	89
17036 235cbf491430 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17026 diff changeset	90 When the screen scrolls up for output of an Ex command, popups move too, so
235cbf491430 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17026 diff changeset	91 that they will not cover the output.
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	92
17045 7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	93 The current cursor position is displayed even when it is under a popup window.
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	94 That way you can still see where it is, even though you cannot see the text
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	95 that it is in.
16833 6699c03347d2 patch 8.1.1418: win_execute() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16829 diff changeset	96
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	97
17257 cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	98 CLOSING THE POPUP WINDOW popup-close
17219 5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	99
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	100 Normally the plugin that created the popup window is also in charge of closing
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	101 it. If somehow a popup hangs around, you can close all of them with: >
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	102 call popup_clear()
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	103 Some popups, such as notifications, close after a specified time. This can be
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	104 set with the "time" property on `popup_create()`.
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	105 Otherwise, a popup can be closed by clicking on the X in the top-right corner
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	106 or by clicking anywhere inside the popup. This must be enabled with the
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	107 "close" property. It is set by default for notifications.
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	108
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	109
17257 cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	110 POPUP BUFFER AND WINDOW popup-buffer
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	111
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	112 If a popup function is called to create a popup from text, a new buffer is
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	113 created to hold the text and text properties of the popup window. The buffer
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	114 is always associated with the popup window and manipulation is restricted:
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	115 - the buffer has no name
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	116 - 'buftype' is "popup"
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	117 - 'swapfile' is off
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	118 - 'bufhidden' is "hide"
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	119 - 'buflisted' is off
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	120 - 'undolevels' is -1: no undo at all
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	121 - all other buffer-local and window-local options are set to their Vim default
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	122 value.
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	123
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	124 It is possible to change the specifically mentioned options, but anything
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	125 might break then, so better leave them alone.
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	126
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	127 The window does have a cursor position, but the cursor is not displayed.
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	128
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	129 To execute a command in the context of the popup window and buffer use
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	130 `win_execute()`. Example: >
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	131 call win_execute(winid, 'syntax enable')
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	132
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	133 Options can be set on the window with `setwinvar()`, e.g.: >
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	134 call setwinvar(winid, '&wrap', 0)
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	135 And options can be set on the buffer with `setbufvar()`, e.g.: >
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	136 call setbufvar(winbufnr(winid), '&filetype', 'java')
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	137 Note that this does not trigger autocommands. Use `win_execute()` if you do
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	138 need them.
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	139
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	140
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	141
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	142 ==============================================================================
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	143 2. Functions popup-functions
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	144
17045 7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	145 Creating a popup window:
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	146 \|popup_create()\| centered in the screen
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	147 \|popup_atcursor()\| just above the cursor position, closes when
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	148 the cursor moves away
17292 8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	149 \|popup_beval()\| at the position indicated by v:beval_
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	150 variables, closes when the mouse moves away
17149 c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	151 \|popup_notification()\| show a notification for three seconds
17045 7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	152 \|popup_dialog()\| centered with padding and border
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	153 \|popup_menu()\| prompt for selecting an item from a list
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	154
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	155 Manipulating a popup window:
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	156 \|popup_hide()\| hide a popup temporarily
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	157 \|popup_show()\| show a previously hidden popup
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	158 \|popup_move()\| change the position and size of a popup
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	159 \|popup_setoptions()\| override options of a popup
17107 0001d10a7661 patch 8.1.1553: not easy to change the text in a popup window Bram Moolenaar <Bram@vim.org> parents: 17097 diff changeset	160 \|popup_settext()\| replace the popup buffer contents
17045 7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	161
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	162 Closing popup windows:
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	163 \|popup_close()\| close one popup
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	164 \|popup_clear()\| close all popups
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	165
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	166 Filter functions:
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	167 \|popup_filter_menu()\| select from a list of items
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	168 \|popup_filter_yesno()\| blocks until 'y' or 'n' is pressed
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	169
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	170 Other:
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	171 \|popup_getoptions()\| get current options for a popup
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	172 \|popup_getpos()\| get actual position and size of a popup
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	173
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	174
17257 cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	175 DETAILS popup-function-details
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	176
17257 cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	177 popup_atcursor({what}, {options}) popup_atcursor()
17225 09fa437d33d8 patch 8.1.1612: cannot show an existing buffer in a popup window Bram Moolenaar <Bram@vim.org> parents: 17219 diff changeset	178 Show the {what} above the cursor, and close it when the cursor
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	179 moves. This works like: >
17225 09fa437d33d8 patch 8.1.1612: cannot show an existing buffer in a popup window Bram Moolenaar <Bram@vim.org> parents: 17219 diff changeset	180 call popup_create({what}, {
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	181 \ 'pos': 'botleft',
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	182 \ 'line': 'cursor-1',
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	183 \ 'col': 'cursor',
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	184 \ 'moved': 'WORD',
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	185 \ })
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	186 < Use {options} to change the properties.
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	187
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	188
17292 8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	189 popup_beval({what}, {options}) popup_beval()
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	190 Show the {what} above the position from 'ballooneval' and
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	191 close it when the mouse moves. This works like: >
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	192 let pos = screenpos(v:beval_winnr, v:beval_lnum, v:beval_col)
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	193 call popup_create({what}, {
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	194 \ 'pos': 'botleft',
17320 33dccaafb214 patch 8.1.1659: popup window "mousemoved" values not correct Bram Moolenaar <Bram@vim.org> parents: 17292 diff changeset	195 \ 'line': pos.row - 1,
17292 8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	196 \ 'col': pos.col,
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	197 \ 'mousemoved': 'WORD',
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	198 \ })
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	199 < Use {options} to change the properties.
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	200 See \|popup_beval_example\| for an example use.
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	201
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	202
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	203 popup_clear()
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	204 popup_clear() Emergency solution to a misbehaving plugin: close all popup
17149 c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	205 windows for the current tab and global popups.
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	206
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	207
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	208 popup_close({id} [, {result}]) popup_close()
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	209 Close popup {id}. The window and the associated buffer will
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	210 be deleted.
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	211
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	212 If the popup has a callback it will be called just before the
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	213 popup window is deleted. If the optional {result} is present
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	214 it will be passed as the second argument of the callback.
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	215 Otherwise zero is passed to the callback.
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	216
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	217
17225 09fa437d33d8 patch 8.1.1612: cannot show an existing buffer in a popup window Bram Moolenaar <Bram@vim.org> parents: 17219 diff changeset	218 popup_create({what}, {options}) popup_create()
09fa437d33d8 patch 8.1.1612: cannot show an existing buffer in a popup window Bram Moolenaar <Bram@vim.org> parents: 17219 diff changeset	219 Open a popup window showing {what}, which is either:
09fa437d33d8 patch 8.1.1612: cannot show an existing buffer in a popup window Bram Moolenaar <Bram@vim.org> parents: 17219 diff changeset	220 - a buffer number
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	221 - a string
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	222 - a list of strings
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	223 - a list of text lines with text properties
17225 09fa437d33d8 patch 8.1.1612: cannot show an existing buffer in a popup window Bram Moolenaar <Bram@vim.org> parents: 17219 diff changeset	224 When {what} is not a buffer number, a buffer is created with
09fa437d33d8 patch 8.1.1612: cannot show an existing buffer in a popup window Bram Moolenaar <Bram@vim.org> parents: 17219 diff changeset	225 'buftype' set to "popup". That buffer will be wiped out once
09fa437d33d8 patch 8.1.1612: cannot show an existing buffer in a popup window Bram Moolenaar <Bram@vim.org> parents: 17219 diff changeset	226 the popup closes.
16871 e5dab34ded73 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16859 diff changeset	227
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	228 {options} is a dictionary with many possible entries.
17257 cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	229 See \|popup_create-arguments\| for details.
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	230
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	231 Returns a window-ID, which can be used with other popup
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	232 functions. Use `winbufnr()` to get the number of the buffer
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	233 in the window: >
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	234 let winid = popup_create('hello', {})
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	235 let bufnr = winbufnr(winid)
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	236 call setbufline(bufnr, 2, 'second line')
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	237 < In case of failure zero is returned.
eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	238
eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	239
17225 09fa437d33d8 patch 8.1.1612: cannot show an existing buffer in a popup window Bram Moolenaar <Bram@vim.org> parents: 17219 diff changeset	240 popup_dialog({what}, {options}) popup_dialog()
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	241 Just like \|popup_create()\| but with these default options: >
17225 09fa437d33d8 patch 8.1.1612: cannot show an existing buffer in a popup window Bram Moolenaar <Bram@vim.org> parents: 17219 diff changeset	242 call popup_create({what}, {
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	243 \ 'pos': 'center',
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	244 \ 'zindex': 200,
17097 94007c802045 patch 8.1.1548: popup_dialog() is not implemented Bram Moolenaar <Bram@vim.org> parents: 17077 diff changeset	245 \ 'drag': 1,
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	246 \ 'border': [],
16890 5131023c5728 patch 8.1.1446: popup window callback not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16888 diff changeset	247 \ 'padding': [],
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	248 \})
17045 7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	249 < Use {options} to change the properties. E.g. add a 'filter'
17097 94007c802045 patch 8.1.1548: popup_dialog() is not implemented Bram Moolenaar <Bram@vim.org> parents: 17077 diff changeset	250 option with value 'popup_filter_yesno'. Example: >
94007c802045 patch 8.1.1548: popup_dialog() is not implemented Bram Moolenaar <Bram@vim.org> parents: 17077 diff changeset	251 call popup_create('do you want to quit (Yes/no)?', {
94007c802045 patch 8.1.1548: popup_dialog() is not implemented Bram Moolenaar <Bram@vim.org> parents: 17077 diff changeset	252 \ 'filter': 'popup_filter_yesno',
94007c802045 patch 8.1.1548: popup_dialog() is not implemented Bram Moolenaar <Bram@vim.org> parents: 17077 diff changeset	253 \ 'callback': 'QuitCallback',
94007c802045 patch 8.1.1548: popup_dialog() is not implemented Bram Moolenaar <Bram@vim.org> parents: 17077 diff changeset	254 \ })
94007c802045 patch 8.1.1548: popup_dialog() is not implemented Bram Moolenaar <Bram@vim.org> parents: 17077 diff changeset	255
94007c802045 patch 8.1.1548: popup_dialog() is not implemented Bram Moolenaar <Bram@vim.org> parents: 17077 diff changeset	256 < By default the dialog can be dragged, so that text below it
94007c802045 patch 8.1.1548: popup_dialog() is not implemented Bram Moolenaar <Bram@vim.org> parents: 17077 diff changeset	257 can be read if needed.
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	258
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	259
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	260 popup_filter_menu({id}, {key}) popup_filter_menu()
17117 7ef5283ace3c patch 8.1.1558: popup_menu() and popup_filter_menu() are not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17107 diff changeset	261 Filter that can be used for a popup. These keys can be used:
17149 c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	262 j <Down> select item below
17117 7ef5283ace3c patch 8.1.1558: popup_menu() and popup_filter_menu() are not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17107 diff changeset	263 k <Up> select item above
7ef5283ace3c patch 8.1.1558: popup_menu() and popup_filter_menu() are not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17107 diff changeset	264 <Space> <Enter> accept current selection
7ef5283ace3c patch 8.1.1558: popup_menu() and popup_filter_menu() are not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17107 diff changeset	265 x Esc CTRL-C cancel the menu
7ef5283ace3c patch 8.1.1558: popup_menu() and popup_filter_menu() are not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17107 diff changeset	266 Other keys are ignored.
7ef5283ace3c patch 8.1.1558: popup_menu() and popup_filter_menu() are not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17107 diff changeset	267
7ef5283ace3c patch 8.1.1558: popup_menu() and popup_filter_menu() are not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17107 diff changeset	268 A match is set on that line to highlight it, see
7ef5283ace3c patch 8.1.1558: popup_menu() and popup_filter_menu() are not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17107 diff changeset	269 \|popup_menu()\|.
7ef5283ace3c patch 8.1.1558: popup_menu() and popup_filter_menu() are not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17107 diff changeset	270
7ef5283ace3c patch 8.1.1558: popup_menu() and popup_filter_menu() are not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17107 diff changeset	271 When the current selection is accepted the "callback" of the
7ef5283ace3c patch 8.1.1558: popup_menu() and popup_filter_menu() are not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17107 diff changeset	272 popup menu is invoked with the index of the selected line as
7ef5283ace3c patch 8.1.1558: popup_menu() and popup_filter_menu() are not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17107 diff changeset	273 the second argument. The first entry has index one.
7ef5283ace3c patch 8.1.1558: popup_menu() and popup_filter_menu() are not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17107 diff changeset	274 Cancelling the menu invokes the callback with -1.
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	275
17149 c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	276 To add shortcut keys, see the example here:
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	277 \|popup_menu-shortcut-example\|
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	278
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	279
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	280 popup_filter_yesno({id}, {key}) popup_filter_yesno()
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	281 Filter that can be used for a popup. It handles only the keys
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	282 'y', 'Y' and 'n' or 'N'. Invokes the "callback" of the
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	283 popup menu with the 1 for 'y' or 'Y' and zero for 'n' or 'N'
17097 94007c802045 patch 8.1.1548: popup_dialog() is not implemented Bram Moolenaar <Bram@vim.org> parents: 17077 diff changeset	284 as the second argument. Pressing Esc and 'x' works like
94007c802045 patch 8.1.1548: popup_dialog() is not implemented Bram Moolenaar <Bram@vim.org> parents: 17077 diff changeset	285 pressing 'n'. CTRL-C invokes the callback with -1. Other
94007c802045 patch 8.1.1548: popup_dialog() is not implemented Bram Moolenaar <Bram@vim.org> parents: 17077 diff changeset	286 keys are ignored.
17149 c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	287 See the example here: \|popup_dialog-example\|
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	288
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	289
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	290 popup_getoptions({id}) popup_getoptions()
16841 cf630fab9fb6 patch 8.1.1422: popup_getoptions() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16833 diff changeset	291 Return the {options} for popup {id} in a Dict.
16855 19162ff4eacd patch 8.1.1429: "pos" option of popup window not supported yet Bram Moolenaar <Bram@vim.org> parents: 16853 diff changeset	292 A zero value means the option was not set. For "zindex" the
19162ff4eacd patch 8.1.1429: "pos" option of popup window not supported yet Bram Moolenaar <Bram@vim.org> parents: 16853 diff changeset	293 default value is returned, not zero.
16841 cf630fab9fb6 patch 8.1.1422: popup_getoptions() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16833 diff changeset	294
17292 8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	295 The "moved" entry is a list with line number, minimum and
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	296 maximum column, [0, 0, 0] when not set.
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	297
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	298 The "mousemoved" entry is a list with screen row, minimum and
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	299 maximum screen column, [0, 0, 0] when not set.
16841 cf630fab9fb6 patch 8.1.1422: popup_getoptions() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16833 diff changeset	300
17123 efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	301 "border" and "padding" are not included when all values are
efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	302 zero. When all values are one then an empty list is included.
efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	303
efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	304 "borderhighlight" is not included when all values are empty.
17216 11f3cf51d43b patch 8.1.1608: the evalfunc.c file is too big Bram Moolenaar <Bram@vim.org> parents: 17196 diff changeset	305 "scrollbarhighlight" and "thumbhighlight" are onlu included
11f3cf51d43b patch 8.1.1608: the evalfunc.c file is too big Bram Moolenaar <Bram@vim.org> parents: 17196 diff changeset	306 when set.
17123 efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	307
17149 c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	308 "tabpage" will be -1 for a global popup, zero for a popup on
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	309 the current tabpage and a positive number for a popup on
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	310 another tabpage.
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	311
17123 efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	312 If popup window {id} is not found an empty Dict is returned.
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	313
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	314
16855 19162ff4eacd patch 8.1.1429: "pos" option of popup window not supported yet Bram Moolenaar <Bram@vim.org> parents: 16853 diff changeset	315 popup_getpos({id}) popup_getpos()
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	316 Return the position and size of popup {id}. Returns a Dict
eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	317 with these entries:
16841 cf630fab9fb6 patch 8.1.1422: popup_getoptions() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16833 diff changeset	318 col screen column of the popup, one-based
cf630fab9fb6 patch 8.1.1422: popup_getoptions() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16833 diff changeset	319 line screen line of the popup, one-based
16884 59e4148c0c73 patch 8.1.1443: popup window padding and border not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16880 diff changeset	320 width width of the whole popup in screen cells
59e4148c0c73 patch 8.1.1443: popup window padding and border not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16880 diff changeset	321 height height of the whole popup in screen cells
59e4148c0c73 patch 8.1.1443: popup window padding and border not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16880 diff changeset	322 core_col screen column of the text box
59e4148c0c73 patch 8.1.1443: popup window padding and border not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16880 diff changeset	323 core_line screen line of the text box
59e4148c0c73 patch 8.1.1443: popup window padding and border not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16880 diff changeset	324 core_width width of the text box in screen cells
59e4148c0c73 patch 8.1.1443: popup window padding and border not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16880 diff changeset	325 core_height height of the text box in screen cells
17196 983950357c40 patch 8.1.1597: cannot scroll a popup window with the mouse Bram Moolenaar <Bram@vim.org> parents: 17180 diff changeset	326 firstline line of the buffer at top (1 unless scrolled)
983950357c40 patch 8.1.1597: cannot scroll a popup window with the mouse Bram Moolenaar <Bram@vim.org> parents: 17180 diff changeset	327 scrollbar non-zero if a scrollbar is displayed
17036 235cbf491430 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17026 diff changeset	328 visible one if the popup is displayed, zero if hidden
16829 5cebaecad422 patch 8.1.1416: popup_getposition() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16817 diff changeset	329 Note that these are the actual screen positions. They differ
5cebaecad422 patch 8.1.1416: popup_getposition() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16817 diff changeset	330 from the values in `popup_getoptions()` for the sizing and
5cebaecad422 patch 8.1.1416: popup_getposition() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16817 diff changeset	331 positioning mechanism applied.
16884 59e4148c0c73 patch 8.1.1443: popup window padding and border not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16880 diff changeset	332
59e4148c0c73 patch 8.1.1443: popup window padding and border not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16880 diff changeset	333 The "core_" values exclude the padding and border.
59e4148c0c73 patch 8.1.1443: popup window padding and border not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16880 diff changeset	334
16829 5cebaecad422 patch 8.1.1416: popup_getposition() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16817 diff changeset	335 If popup window {id} is not found an empty Dict is returned.
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	336
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	337
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	338 popup_hide({id}) popup_hide()
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	339 If {id} is a displayed popup, hide it now. If the popup has a
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	340 filter it will not be invoked for so long as the popup is
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	341 hidden.
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	342 If window {id} does not exist nothing happens. If window {id}
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	343 exists but is not a popup window an error is given. E993
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	344
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	345
17225 09fa437d33d8 patch 8.1.1612: cannot show an existing buffer in a popup window Bram Moolenaar <Bram@vim.org> parents: 17219 diff changeset	346 popup_menu({what}, {options}) popup_menu()
09fa437d33d8 patch 8.1.1612: cannot show an existing buffer in a popup window Bram Moolenaar <Bram@vim.org> parents: 17219 diff changeset	347 Show the {what} near the cursor, handle selecting one of the
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	348 items with cursorkeys, and close it an item is selected with
17225 09fa437d33d8 patch 8.1.1612: cannot show an existing buffer in a popup window Bram Moolenaar <Bram@vim.org> parents: 17219 diff changeset	349 Space or Enter. {what} should have multiple lines to make this
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	350 useful. This works like: >
17225 09fa437d33d8 patch 8.1.1612: cannot show an existing buffer in a popup window Bram Moolenaar <Bram@vim.org> parents: 17219 diff changeset	351 call popup_create({what}, {
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	352 \ 'pos': 'center',
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	353 \ 'zindex': 200,
17117 7ef5283ace3c patch 8.1.1558: popup_menu() and popup_filter_menu() are not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17107 diff changeset	354 \ 'drag': 1,
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	355 \ 'wrap': 0,
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	356 \ 'border': [],
17117 7ef5283ace3c patch 8.1.1558: popup_menu() and popup_filter_menu() are not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17107 diff changeset	357 \ 'padding': [],
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	358 \ 'filter': 'popup_filter_menu',
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	359 \ })
17117 7ef5283ace3c patch 8.1.1558: popup_menu() and popup_filter_menu() are not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17107 diff changeset	360 < The current line is highlighted with a match using
17161 9ccb1ea9b2fc Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17149 diff changeset	361 "PopupSelected", or "PmenuSel" if that is not defined.
17117 7ef5283ace3c patch 8.1.1558: popup_menu() and popup_filter_menu() are not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17107 diff changeset	362
7ef5283ace3c patch 8.1.1558: popup_menu() and popup_filter_menu() are not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17107 diff changeset	363 Use {options} to change the properties. Should at least set
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	364 "callback" to a function that handles the selected item.
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	365
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	366
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	367 popup_move({id}, {options}) popup_move()
17051 221d4b82bc0b patch 8.1.1525: cannot move a popup window with the mouse Bram Moolenaar <Bram@vim.org> parents: 17047 diff changeset	368 Move popup {id} to the position specified with {options}.
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	369 {options} may contain the items from \|popup_create()\| that
17123 efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	370 specify the popup position:
efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	371 line
efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	372 col
efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	373 pos
efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	374 maxheight
efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	375 minheight
efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	376 maxwidth
efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	377 minwidth
efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	378 fixed
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	379 For {id} see `popup_hide()`.
17123 efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	380 For other options see \|popup_setoptions()\|.
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	381
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	382
17225 09fa437d33d8 patch 8.1.1612: cannot show an existing buffer in a popup window Bram Moolenaar <Bram@vim.org> parents: 17219 diff changeset	383 popup_notification({what}, {options}) popup_notification()
09fa437d33d8 patch 8.1.1612: cannot show an existing buffer in a popup window Bram Moolenaar <Bram@vim.org> parents: 17219 diff changeset	384 Show the {what} for 3 seconds at the top of the Vim window.
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	385 This works like: >
17225 09fa437d33d8 patch 8.1.1612: cannot show an existing buffer in a popup window Bram Moolenaar <Bram@vim.org> parents: 17219 diff changeset	386 call popup_create({what}, {
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	387 \ 'line': 1,
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	388 \ 'col': 10,
17077 2546930657a9 patch 8.1.1538: cannot specify highlighting for notifications Bram Moolenaar <Bram@vim.org> parents: 17075 diff changeset	389 \ 'minwidth': 20,
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	390 \ 'time': 3000,
17075 dacd46fbaa90 patch 8.1.1537: using "tab" for popup window can be confusing Bram Moolenaar <Bram@vim.org> parents: 17051 diff changeset	391 \ 'tabpage': -1,
17097 94007c802045 patch 8.1.1548: popup_dialog() is not implemented Bram Moolenaar <Bram@vim.org> parents: 17077 diff changeset	392 \ 'zindex': 300,
17051 221d4b82bc0b patch 8.1.1525: cannot move a popup window with the mouse Bram Moolenaar <Bram@vim.org> parents: 17047 diff changeset	393 \ 'drag': 1,
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	394 \ 'highlight': 'WarningMsg',
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	395 \ 'border': [],
17219 5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	396 \ 'close': 'click',
17045 7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	397 \ 'padding': [0,1,0,1],
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	398 \ })
17077 2546930657a9 patch 8.1.1538: cannot specify highlighting for notifications Bram Moolenaar <Bram@vim.org> parents: 17075 diff changeset	399 < The PopupNotification highlight group is used instead of
2546930657a9 patch 8.1.1538: cannot specify highlighting for notifications Bram Moolenaar <Bram@vim.org> parents: 17075 diff changeset	400 WarningMsg if it is defined.
17117 7ef5283ace3c patch 8.1.1558: popup_menu() and popup_filter_menu() are not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17107 diff changeset	401
17219 5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	402 Without the \|+timers\| feature the poup will not disappear
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	403 automatically, the user has to click in it.
17180 8581779aa16f patch 8.1.1589: popup window does not indicate scroll position Bram Moolenaar <Bram@vim.org> parents: 17174 diff changeset	404
17117 7ef5283ace3c patch 8.1.1558: popup_menu() and popup_filter_menu() are not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17107 diff changeset	405 The position will be adjusted to avoid overlap with other
17045 7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	406 notifications.
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	407 Use {options} to change the properties.
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	408
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	409
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	410 popup_show({id}) popup_show()
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	411 If {id} is a hidden popup, show it now.
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	412 For {id} see `popup_hide()`.
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	413
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	414
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	415 popup_setoptions({id}, {options}) popup_setoptions()
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	416 Override options in popup {id} with entries in {options}.
17123 efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	417 These options can be set:
17219 5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	418 border
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	419 borderchars
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	420 borderhighlight
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	421 callback
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	422 close
17123 efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	423 drag
17219 5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	424 filter
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	425 firstline
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	426 flip
17123 efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	427 highlight
17219 5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	428 mask
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	429 moved
17123 efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	430 padding
17180 8581779aa16f patch 8.1.1589: popup window does not indicate scroll position Bram Moolenaar <Bram@vim.org> parents: 17174 diff changeset	431 scrollbar
17216 11f3cf51d43b patch 8.1.1608: the evalfunc.c file is too big Bram Moolenaar <Bram@vim.org> parents: 17196 diff changeset	432 scrollbarhighlight
11f3cf51d43b patch 8.1.1608: the evalfunc.c file is too big Bram Moolenaar <Bram@vim.org> parents: 17196 diff changeset	433 thumbhighlight
17219 5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	434 time
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	435 title
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	436 wrap
17123 efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	437 zindex
efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	438 The options from \|popup_move()\| can also be used.
efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	439 For "hidden" use \|popup_hide()\| and \|popup_show()\|.
efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	440 "tabpage" cannot be changed.
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	441
17107 0001d10a7661 patch 8.1.1553: not easy to change the text in a popup window Bram Moolenaar <Bram@vim.org> parents: 17097 diff changeset	442 popup_settext({id}, {text}) popup_settext()
0001d10a7661 patch 8.1.1553: not easy to change the text in a popup window Bram Moolenaar <Bram@vim.org> parents: 17097 diff changeset	443 Set the text of the buffer in poup win {id}. {text} is the
17225 09fa437d33d8 patch 8.1.1612: cannot show an existing buffer in a popup window Bram Moolenaar <Bram@vim.org> parents: 17219 diff changeset	444 same as supplied to \|popup_create()\|, except that a buffer
09fa437d33d8 patch 8.1.1612: cannot show an existing buffer in a popup window Bram Moolenaar <Bram@vim.org> parents: 17219 diff changeset	445 number is not allowed.
17107 0001d10a7661 patch 8.1.1553: not easy to change the text in a popup window Bram Moolenaar <Bram@vim.org> parents: 17097 diff changeset	446 Does not change the window size or position, other than caused
0001d10a7661 patch 8.1.1553: not easy to change the text in a popup window Bram Moolenaar <Bram@vim.org> parents: 17097 diff changeset	447 by the different text.
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	448
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	449
17257 cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	450 ==============================================================================
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	451 3. Usage popup-usage
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	452
17257 cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	453 POPUP_CREATE() ARGUMENTS popup_create-arguments
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	454
17107 0001d10a7661 patch 8.1.1553: not easy to change the text in a popup window Bram Moolenaar <Bram@vim.org> parents: 17097 diff changeset	455 The first argument of \|popup_create()\| (and the second argument to
17161 9ccb1ea9b2fc Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17149 diff changeset	456 \|popup_settext()\|) specifies the text to be displayed, and optionally text
17225 09fa437d33d8 patch 8.1.1612: cannot show an existing buffer in a popup window Bram Moolenaar <Bram@vim.org> parents: 17219 diff changeset	457 properties. It is in one of four forms:
09fa437d33d8 patch 8.1.1612: cannot show an existing buffer in a popup window Bram Moolenaar <Bram@vim.org> parents: 17219 diff changeset	458 - a buffer number
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	459 - a string
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	460 - a list of strings
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	461 - a list of dictionaries, where each dictionary has these entries:
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	462 text String with the text to display.
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	463 props A list of text properties. Optional.
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	464 Each entry is a dictionary, like the third argument of
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	465 \|prop_add()\|, but specifying the column in the
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	466 dictionary with a "col" entry, see below:
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	467 \|popup-props\|.
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	468
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	469 The second argument of \|popup_create()\| is a dictionary with options:
16896 52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	470 line Screen line where to position the popup. Can use a
16855 19162ff4eacd patch 8.1.1429: "pos" option of popup window not supported yet Bram Moolenaar <Bram@vim.org> parents: 16853 diff changeset	471 number or "cursor", "cursor+1" or "cursor-1" to use
19162ff4eacd patch 8.1.1429: "pos" option of popup window not supported yet Bram Moolenaar <Bram@vim.org> parents: 16853 diff changeset	472 the line of the cursor and add or subtract a number of
16896 52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	473 lines. If omitted the popup is vertically centered.
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	474 The first line is 1.
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	475 col Screen column where to position the popup. Can use a
16855 19162ff4eacd patch 8.1.1429: "pos" option of popup window not supported yet Bram Moolenaar <Bram@vim.org> parents: 16853 diff changeset	476 number or "cursor" to use the column of the cursor,
16896 52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	477 "cursor+9" or "cursor-9" to add or subtract a number
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	478 of columns. If omitted the popup is horizontally
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	479 centered. The first column is 1.
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	480 pos "topleft", "topright", "botleft" or "botright":
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	481 defines what corner of the popup "line" and "col" are
16841 cf630fab9fb6 patch 8.1.1422: popup_getoptions() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16833 diff changeset	482 used for. When not set "topleft" is used.
cf630fab9fb6 patch 8.1.1422: popup_getoptions() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16833 diff changeset	483 Alternatively "center" can be used to position the
16855 19162ff4eacd patch 8.1.1429: "pos" option of popup window not supported yet Bram Moolenaar <Bram@vim.org> parents: 16853 diff changeset	484 popup in the center of the Vim window, in which case
19162ff4eacd patch 8.1.1429: "pos" option of popup window not supported yet Bram Moolenaar <Bram@vim.org> parents: 16853 diff changeset	485 "line" and "col" are ignored.
16896 52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	486 fixed When FALSE (the default), and:
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	487 - "pos" is "botleft" or "topleft", and
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	488 - "wrap" is off, and
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	489 - the popup would be truncated at the right edge of
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	490 the screen, then
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	491 the popup is moved to the left so as to fit the
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	492 contents on the screen. Set to TRUE to disable this.
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	493 flip When TRUE (the default) and the position is relative
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	494 to the cursor, flip to below or above the cursor to
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	495 avoid overlap with the \|popupmenu-completion\| or
17107 0001d10a7661 patch 8.1.1553: not easy to change the text in a popup window Bram Moolenaar <Bram@vim.org> parents: 17097 diff changeset	496 another popup with a higher "zindex". When there is
0001d10a7661 patch 8.1.1553: not easy to change the text in a popup window Bram Moolenaar <Bram@vim.org> parents: 17097 diff changeset	497 no space above/below the cursor then show the popup to
0001d10a7661 patch 8.1.1553: not easy to change the text in a popup window Bram Moolenaar <Bram@vim.org> parents: 17097 diff changeset	498 the side of the popup or popup menu.
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	499 {not implemented yet}
16896 52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	500 maxheight Maximum height of the contents, excluding border and
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	501 padding.
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	502 minheight Minimum height of the contents, excluding border and
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	503 padding.
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	504 maxwidth Maximum width of the contents, excluding border and
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	505 padding.
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	506 minwidth Minimum width of the contents, excluding border and
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	507 padding.
17047 6400d1ad5e4b patch 8.1.1523: cannot show range of buffer lines in popup window Bram Moolenaar <Bram@vim.org> parents: 17045 diff changeset	508 firstline First buffer line to display. When larger than one it
6400d1ad5e4b patch 8.1.1523: cannot show range of buffer lines in popup window Bram Moolenaar <Bram@vim.org> parents: 17045 diff changeset	509 looks like the text scrolled up. When out of range
6400d1ad5e4b patch 8.1.1523: cannot show range of buffer lines in popup window Bram Moolenaar <Bram@vim.org> parents: 17045 diff changeset	510 the last buffer line will at the top of the window.
17180 8581779aa16f patch 8.1.1589: popup window does not indicate scroll position Bram Moolenaar <Bram@vim.org> parents: 17174 diff changeset	511 Also see "scrollbar".
16896 52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	512 hidden When TRUE the popup exists but is not displayed; use
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	513 `popup_show()` to unhide it.
17161 9ccb1ea9b2fc Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17149 diff changeset	514 tabpage When -1: display the popup on all tab pages.
16896 52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	515 When 0 (the default): display the popup on the current
17075 dacd46fbaa90 patch 8.1.1537: using "tab" for popup window can be confusing Bram Moolenaar <Bram@vim.org> parents: 17051 diff changeset	516 tab page.
16896 52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	517 Otherwise the number of the tab page the popup is
17149 c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	518 displayed on; when invalid the popup is not created
17174 23609a6d8cc7 patch 8.1.1586: error number used in two places Bram Moolenaar <Bram@vim.org> parents: 17162 diff changeset	519 and an error is given. E997
16896 52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	520 title Text to be displayed above the first item in the
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	521 popup, on top of any border. If there is no top
17051 221d4b82bc0b patch 8.1.1525: cannot move a popup window with the mouse Bram Moolenaar <Bram@vim.org> parents: 17047 diff changeset	522 border one line of padding is added to put the title
17119 b439e096a011 patch 8.1.1559: popup window title property not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17117 diff changeset	523 on. You might want to add one or more spaces at the
b439e096a011 patch 8.1.1559: popup window title property not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17117 diff changeset	524 start and end as padding.
16896 52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	525 wrap TRUE to make the lines wrap (default TRUE).
17051 221d4b82bc0b patch 8.1.1525: cannot move a popup window with the mouse Bram Moolenaar <Bram@vim.org> parents: 17047 diff changeset	526 drag TRUE to allow the popup to be dragged with the mouse
221d4b82bc0b patch 8.1.1525: cannot move a popup window with the mouse Bram Moolenaar <Bram@vim.org> parents: 17047 diff changeset	527 by grabbing at at the border. Has no effect if the
17107 0001d10a7661 patch 8.1.1553: not easy to change the text in a popup window Bram Moolenaar <Bram@vim.org> parents: 17097 diff changeset	528 popup does not have a border. As soon as dragging
0001d10a7661 patch 8.1.1553: not easy to change the text in a popup window Bram Moolenaar <Bram@vim.org> parents: 17097 diff changeset	529 starts and "pos" is "center" it is changed to
0001d10a7661 patch 8.1.1553: not easy to change the text in a popup window Bram Moolenaar <Bram@vim.org> parents: 17097 diff changeset	530 "topleft".
17219 5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	531 close When "button" an X is displayed in the top-right, on
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	532 top of any border, padding or text. When clicked on
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	533 the X the popup will close. Any callback is invoked
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	534 with the value -2.
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	535 When "click" any mouse click in the popup will close
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	536 it.
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	537 When "none" (the default) mouse clicks do not close
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	538 the popup window.
16896 52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	539 highlight Highlight group name to use for the text, stored in
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	540 the 'wincolor' option.
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	541 padding List with numbers, defining the padding
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	542 above/right/below/left of the popup (similar to CSS).
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	543 An empty list uses a padding of 1 all around. The
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	544 padding goes around the text, inside any border.
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	545 Padding uses the 'wincolor' highlight.
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	546 Example: [1, 2, 1, 3] has 1 line of padding above, 2
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	547 columns on the right, 1 line below and 3 columns on
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	548 the left.
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	549 border List with numbers, defining the border thickness
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	550 above/right/below/left of the popup (similar to CSS).
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	551 Only values of zero and non-zero are recognized.
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	552 An empty list uses a border all around.
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	553 borderhighlight List of highlight group names to use for the border.
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	554 When one entry it is used for all borders, otherwise
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	555 the highlight for the top/right/bottom/left border.
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	556 Example: ['TopColor', 'RightColor', 'BottomColor,
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	557 'LeftColor']
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	558 borderchars List with characters, defining the character to use
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	559 for the top/right/bottom/left border. Optionally
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	560 followed by the character to use for the
16896 52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	561 topleft/topright/botright/botleft corner.
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	562 Example: ['-', '\|', '-', '\|', '┌', '┐', '┘', '└']
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	563 When the list has one character it is used for all.
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	564 When the list has two characters the first is used for
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	565 the border lines, the second for the corners.
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	566 By default a double line is used all around when
17161 9ccb1ea9b2fc Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17149 diff changeset	567 'encoding' is "utf-8" and 'ambiwidth' is "single",
17149 c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	568 otherwise ASCII characters are used.
17180 8581779aa16f patch 8.1.1589: popup window does not indicate scroll position Bram Moolenaar <Bram@vim.org> parents: 17174 diff changeset	569 scrollbar non-zero: show a scrollbar when the text doesn't fit.
8581779aa16f patch 8.1.1589: popup window does not indicate scroll position Bram Moolenaar <Bram@vim.org> parents: 17174 diff changeset	570 zero: do not show a scrollbar. Default is non-zero.
17216 11f3cf51d43b patch 8.1.1608: the evalfunc.c file is too big Bram Moolenaar <Bram@vim.org> parents: 17196 diff changeset	571 Also see \|popup-scrollbar\|.
11f3cf51d43b patch 8.1.1608: the evalfunc.c file is too big Bram Moolenaar <Bram@vim.org> parents: 17196 diff changeset	572 scrollbarhighlight Highlight group name for the scrollbar. The
11f3cf51d43b patch 8.1.1608: the evalfunc.c file is too big Bram Moolenaar <Bram@vim.org> parents: 17196 diff changeset	573 background color is what matters. When not given then
11f3cf51d43b patch 8.1.1608: the evalfunc.c file is too big Bram Moolenaar <Bram@vim.org> parents: 17196 diff changeset	574 PmenuSbar is used.
11f3cf51d43b patch 8.1.1608: the evalfunc.c file is too big Bram Moolenaar <Bram@vim.org> parents: 17196 diff changeset	575 thumbhighlight Highlight group name for the scrollbar thumb. The
11f3cf51d43b patch 8.1.1608: the evalfunc.c file is too big Bram Moolenaar <Bram@vim.org> parents: 17196 diff changeset	576 background color is what matters. When not given then
11f3cf51d43b patch 8.1.1608: the evalfunc.c file is too big Bram Moolenaar <Bram@vim.org> parents: 17196 diff changeset	577 PmenuThumb is used.
17051 221d4b82bc0b patch 8.1.1525: cannot move a popup window with the mouse Bram Moolenaar <Bram@vim.org> parents: 17047 diff changeset	578 zindex Priority for the popup, default 50. Minimum value is
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	579 1, maximum value is 32000.
17162 f16cee6adf29 patch 8.1.1580: cannot make part of a popup transparent Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	580 mask A list of lists with coordinates, defining parts of
f16cee6adf29 patch 8.1.1580: cannot make part of a popup transparent Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	581 the popup that are transparent. See \|popup-mask\|.
16896 52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	582 time Time in milliseconds after which the popup will close.
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	583 When omitted \|popup_close()\| must be used.
16904 9138e2c60bf1 patch 8.1.1453: popup window "moved" property not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16896 diff changeset	584 moved Specifies to close the popup if the cursor moved:
9138e2c60bf1 patch 8.1.1453: popup window "moved" property not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16896 diff changeset	585 - "any": if the cursor moved at all
9138e2c60bf1 patch 8.1.1453: popup window "moved" property not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16896 diff changeset	586 - "word": if the cursor moved outside \|<cword>\|
9138e2c60bf1 patch 8.1.1453: popup window "moved" property not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16896 diff changeset	587 - "WORD": if the cursor moved outside \|<cWORD>\|
17292 8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	588 - "expr": if the cursor moved outside \|<cexpr>\|
16904 9138e2c60bf1 patch 8.1.1453: popup window "moved" property not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16896 diff changeset	589 - [{start}, {end}]: if the cursor moved before column
9138e2c60bf1 patch 8.1.1453: popup window "moved" property not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16896 diff changeset	590 {start} or after {end}
9138e2c60bf1 patch 8.1.1453: popup window "moved" property not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16896 diff changeset	591 The popup also closes if the cursor moves to another
9138e2c60bf1 patch 8.1.1453: popup window "moved" property not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16896 diff changeset	592 line or to another window.
17036 235cbf491430 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17026 diff changeset	593 filter A callback that can filter typed characters, see
16896 52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	594 \|popup-filter\|.
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	595 callback A callback that is called when the popup closes, e.g.
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	596 when using \|popup_filter_menu()\|, see \|popup-callback\|.
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	597
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	598 Depending on the "zindex" the popup goes under or above other popups. The
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	599 completion menu (\|popup-menu\|) has zindex 100. For messages that occur for a
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	600 short time the suggestion is to use zindex 1000.
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	601
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	602 By default text wraps, which causes a line in {lines} to occupy more than one
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	603 screen line. When "wrap" is FALSE then the text outside of the popup or
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	604 outside of the Vim window will not be displayed, thus truncated.
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	605
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	606
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	607 POPUP TEXT PROPERTIES popup-props
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	608
16811 0457d49eb2d9 patch 8.1.1407: popup_create() does not support text properties Bram Moolenaar <Bram@vim.org> parents: 16809 diff changeset	609 These are similar to the third argument of \|prop_add()\| except:
0457d49eb2d9 patch 8.1.1407: popup_create() does not support text properties Bram Moolenaar <Bram@vim.org> parents: 16809 diff changeset	610 - "lnum" is always the current line in the list
0457d49eb2d9 patch 8.1.1407: popup_create() does not support text properties Bram Moolenaar <Bram@vim.org> parents: 16809 diff changeset	611 - "bufnr" is always the buffer of the popup
0457d49eb2d9 patch 8.1.1407: popup_create() does not support text properties Bram Moolenaar <Bram@vim.org> parents: 16809 diff changeset	612 - "col" is in the Dict instead of a separate argument
0457d49eb2d9 patch 8.1.1407: popup_create() does not support text properties Bram Moolenaar <Bram@vim.org> parents: 16809 diff changeset	613 So we get:
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	614 col starting column, counted in bytes, use one for the
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	615 first column.
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	616 length length of text in bytes; can be zero
16811 0457d49eb2d9 patch 8.1.1407: popup_create() does not support text properties Bram Moolenaar <Bram@vim.org> parents: 16809 diff changeset	617 end_lnum line number for the end of the text
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	618 end_col column just after the text; not used when "length" is
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	619 present; when {col} and "end_col" are equal, this is a
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	620 zero-width text property
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	621 id user defined ID for the property; when omitted zero is
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	622 used
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	623 type name of the text property type, as added with
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	624 \|prop_type_add()\|
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	625
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	626
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	627 POPUP FILTER popup-filter
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	628
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	629 A callback that gets any typed keys while a popup is displayed. The filter is
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	630 not invoked when the popup is hidden.
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	631
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	632 The filter can return TRUE to indicate the key has been handled and is to be
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	633 discarded, or FALSE to let Vim handle the key as usual in the current state.
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	634 In case it returns FALSE and there is another popup window visible, that
eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	635 filter is also called. The filter of the popup window with the highest zindex
eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	636 is called first.
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	637
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	638 The filter function is called with two arguments: the ID of the popup and the
17097 94007c802045 patch 8.1.1548: popup_dialog() is not implemented Bram Moolenaar <Bram@vim.org> parents: 17077 diff changeset	639 key as a string, e.g.: >
16880 998603a243d7 patch 8.1.1441: popup window filter not yet implemented Bram Moolenaar <Bram@vim.org> parents: 16871 diff changeset	640 func MyFilter(winid, key)
998603a243d7 patch 8.1.1441: popup window filter not yet implemented Bram Moolenaar <Bram@vim.org> parents: 16871 diff changeset	641 if a:key == "\<F2>"
998603a243d7 patch 8.1.1441: popup window filter not yet implemented Bram Moolenaar <Bram@vim.org> parents: 16871 diff changeset	642 " do something
998603a243d7 patch 8.1.1441: popup window filter not yet implemented Bram Moolenaar <Bram@vim.org> parents: 16871 diff changeset	643 return 1
998603a243d7 patch 8.1.1441: popup window filter not yet implemented Bram Moolenaar <Bram@vim.org> parents: 16871 diff changeset	644 endif
998603a243d7 patch 8.1.1441: popup window filter not yet implemented Bram Moolenaar <Bram@vim.org> parents: 16871 diff changeset	645 if a:key == 'x'
998603a243d7 patch 8.1.1441: popup window filter not yet implemented Bram Moolenaar <Bram@vim.org> parents: 16871 diff changeset	646 call popup_close(a:winid)
998603a243d7 patch 8.1.1441: popup window filter not yet implemented Bram Moolenaar <Bram@vim.org> parents: 16871 diff changeset	647 return 1
998603a243d7 patch 8.1.1441: popup window filter not yet implemented Bram Moolenaar <Bram@vim.org> parents: 16871 diff changeset	648 endif
998603a243d7 patch 8.1.1441: popup window filter not yet implemented Bram Moolenaar <Bram@vim.org> parents: 16871 diff changeset	649 return 0
17036 235cbf491430 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17026 diff changeset	650 endfunc
16880 998603a243d7 patch 8.1.1441: popup window filter not yet implemented Bram Moolenaar <Bram@vim.org> parents: 16871 diff changeset	651
998603a243d7 patch 8.1.1441: popup window filter not yet implemented Bram Moolenaar <Bram@vim.org> parents: 16871 diff changeset	652 Currently the key is what results after any mapping. This may change...
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	653
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	654 Some common key actions:
16880 998603a243d7 patch 8.1.1441: popup window filter not yet implemented Bram Moolenaar <Bram@vim.org> parents: 16871 diff changeset	655 x close the popup (see note below)
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	656 cursor keys select another entry
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	657 Tab accept current suggestion
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	658
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	659 A mouse click arrives as <LeftMouse>. The coordinates are in
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	660 v:mouse_popup_col and v:mouse_popup_row. The top-left screen cell of the
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	661 popup is col 1, row 1 (not counting the border).
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	662
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	663 Vim provides standard filters \|popup_filter_menu()\| and
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	664 \|popup_filter_yesno()\|.
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	665
16880 998603a243d7 patch 8.1.1441: popup window filter not yet implemented Bram Moolenaar <Bram@vim.org> parents: 16871 diff changeset	666 Note that "x" is the normal way to close a popup. You may want to use Esc,
998603a243d7 patch 8.1.1441: popup window filter not yet implemented Bram Moolenaar <Bram@vim.org> parents: 16871 diff changeset	667 but since many keys start with an Esc character, there may be a delay before
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	668 Vim recognizes the Esc key. If you do use Esc, it is recommended to set the
16880 998603a243d7 patch 8.1.1441: popup window filter not yet implemented Bram Moolenaar <Bram@vim.org> parents: 16871 diff changeset	669 'ttimeoutlen' option to 100 and set 'timeout' and/or 'ttimeout'.
998603a243d7 patch 8.1.1441: popup window filter not yet implemented Bram Moolenaar <Bram@vim.org> parents: 16871 diff changeset	670
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	671
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	672 POPUP CALLBACK popup-callback
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	673
17097 94007c802045 patch 8.1.1548: popup_dialog() is not implemented Bram Moolenaar <Bram@vim.org> parents: 17077 diff changeset	674 A callback that is invoked when the popup closes.
16890 5131023c5728 patch 8.1.1446: popup window callback not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16888 diff changeset	675
5131023c5728 patch 8.1.1446: popup window callback not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16888 diff changeset	676 The callback is invoked with two arguments: the ID of the popup window and the
5131023c5728 patch 8.1.1446: popup window callback not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16888 diff changeset	677 result, which could be an index in the popup lines, or whatever was passed as
5131023c5728 patch 8.1.1446: popup window callback not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16888 diff changeset	678 the second argument of `popup_close()`.
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	679
17097 94007c802045 patch 8.1.1548: popup_dialog() is not implemented Bram Moolenaar <Bram@vim.org> parents: 17077 diff changeset	680 If the popup is force-closed, e.g. because the cursor moved or CTRL-C was
94007c802045 patch 8.1.1548: popup_dialog() is not implemented Bram Moolenaar <Bram@vim.org> parents: 17077 diff changeset	681 pressed, the number -1 is passed to the callback.
16904 9138e2c60bf1 patch 8.1.1453: popup window "moved" property not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16896 diff changeset	682
17162 f16cee6adf29 patch 8.1.1580: cannot make part of a popup transparent Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	683
17216 11f3cf51d43b patch 8.1.1608: the evalfunc.c file is too big Bram Moolenaar <Bram@vim.org> parents: 17196 diff changeset	684 POPUP SCROLLBAR popup-scrollbar
11f3cf51d43b patch 8.1.1608: the evalfunc.c file is too big Bram Moolenaar <Bram@vim.org> parents: 17196 diff changeset	685
11f3cf51d43b patch 8.1.1608: the evalfunc.c file is too big Bram Moolenaar <Bram@vim.org> parents: 17196 diff changeset	686 If the text does not fit in the popup a scrollbar is displayed on the right of
11f3cf51d43b patch 8.1.1608: the evalfunc.c file is too big Bram Moolenaar <Bram@vim.org> parents: 17196 diff changeset	687 the window. This can be disabled by setting the "scrollbar" option to zero.
11f3cf51d43b patch 8.1.1608: the evalfunc.c file is too big Bram Moolenaar <Bram@vim.org> parents: 17196 diff changeset	688 When the scrollbar is displayed mouse scroll events, while the mouse pointer
11f3cf51d43b patch 8.1.1608: the evalfunc.c file is too big Bram Moolenaar <Bram@vim.org> parents: 17196 diff changeset	689 is on the popup, will cause the text to scroll up or down as you would expect.
11f3cf51d43b patch 8.1.1608: the evalfunc.c file is too big Bram Moolenaar <Bram@vim.org> parents: 17196 diff changeset	690 A click in the upper halve of the scrollbar will scroll the text one line
11f3cf51d43b patch 8.1.1608: the evalfunc.c file is too big Bram Moolenaar <Bram@vim.org> parents: 17196 diff changeset	691 down. A click in the lower halve wil scroll the text one line up. However,
11f3cf51d43b patch 8.1.1608: the evalfunc.c file is too big Bram Moolenaar <Bram@vim.org> parents: 17196 diff changeset	692 this is limited so that the popup does not get smaller.
11f3cf51d43b patch 8.1.1608: the evalfunc.c file is too big Bram Moolenaar <Bram@vim.org> parents: 17196 diff changeset	693
11f3cf51d43b patch 8.1.1608: the evalfunc.c file is too big Bram Moolenaar <Bram@vim.org> parents: 17196 diff changeset	694
17162 f16cee6adf29 patch 8.1.1580: cannot make part of a popup transparent Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	695 POPUP MASK popup-mask
f16cee6adf29 patch 8.1.1580: cannot make part of a popup transparent Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	696
f16cee6adf29 patch 8.1.1580: cannot make part of a popup transparent Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	697 To minimize the text that the popup covers, parts of it can be made
f16cee6adf29 patch 8.1.1580: cannot make part of a popup transparent Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	698 transparent. This is defined by a "mask" which is a list of lists, where each
f16cee6adf29 patch 8.1.1580: cannot make part of a popup transparent Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	699 list has four numbers:
f16cee6adf29 patch 8.1.1580: cannot make part of a popup transparent Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	700 col start column, positive for counting from the left, 1 for
f16cee6adf29 patch 8.1.1580: cannot make part of a popup transparent Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	701 leftmost, negative for counting from the right, -1 for
f16cee6adf29 patch 8.1.1580: cannot make part of a popup transparent Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	702 rightmost
f16cee6adf29 patch 8.1.1580: cannot make part of a popup transparent Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	703 endcol last column, like "col"
f16cee6adf29 patch 8.1.1580: cannot make part of a popup transparent Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	704 line start line, positive for conting from the top, 1 for top,
f16cee6adf29 patch 8.1.1580: cannot make part of a popup transparent Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	705 negative for counting from the bottom, -1 for bottom
f16cee6adf29 patch 8.1.1580: cannot make part of a popup transparent Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	706 endline end line, like "line"
f16cee6adf29 patch 8.1.1580: cannot make part of a popup transparent Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	707
f16cee6adf29 patch 8.1.1580: cannot make part of a popup transparent Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	708 For example, to make the last 10 columns of the last line transparent:
f16cee6adf29 patch 8.1.1580: cannot make part of a popup transparent Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	709 [[-10, -1, -1, -1]]
f16cee6adf29 patch 8.1.1580: cannot make part of a popup transparent Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	710
f16cee6adf29 patch 8.1.1580: cannot make part of a popup transparent Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	711 To make the four corners transparent:
f16cee6adf29 patch 8.1.1580: cannot make part of a popup transparent Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	712 [[1, 1, 1, 1], [-1, -1, 1, 1], [1, 1, -1, -1], [-1, -1, -1, -1]]
f16cee6adf29 patch 8.1.1580: cannot make part of a popup transparent Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	713
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	714 ==============================================================================
17257 cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	715 4. Examples popup-examples
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	716
17257 cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	717 TODO: more interesting examples
17149 c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	718 popup_dialog-example
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	719 Prompt the user to press y/Y or n/N: >
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	720
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	721 func MyDialogHandler(id, result)
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	722 if a:result
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	723 " ... 'y' or 'Y' was pressed
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	724 endif
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	725 endfunc
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	726
17149 c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	727 call popup_dialog('Continue? y/n', {
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	728 \ 'filter': 'popup_filter_yesno',
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	729 \ 'callback': 'MyDialogHandler',
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	730 \ })
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	731 <
17149 c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	732 popup_menu-shortcut-example
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	733 Extend popup_filter_menu() with shortcut keys: >
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	734
17161 9ccb1ea9b2fc Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17149 diff changeset	735 call popup_menu(['Save', 'Cancel', 'Discard'], {
17149 c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	736 \ 'filter': 'MyMenuFilter',
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	737 \ 'callback': 'MyMenuHandler',
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	738 \ })
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	739
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	740 func MyMenuFilter(id, key)
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	741 " Handle shortcuts
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	742 if a:key == 'S'
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	743 call popup_close(a:id, 1)
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	744 return 1
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	745 endif
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	746 if a:key == 'C'
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	747 call popup_close(a:id, 2)
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	748 return 1
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	749 endif
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	750 if a:key == 'D'
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	751 call popup_close(a:id, 3)
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	752 return 1
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	753 endif
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	754
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	755 " No shortcut, pass to generic filter
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	756 return popup_filter_menu(a:id, a:key)
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	757 endfunc
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	758 <
17292 8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	759 popup_beval_example
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	760 Example for using a popup window for 'ballooneval': >
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	761
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	762 set ballooneval balloonevalterm
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	763 set balloonexpr=BalloonExpr()
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	764 let s:winid = 0
17320 33dccaafb214 patch 8.1.1659: popup window "mousemoved" values not correct Bram Moolenaar <Bram@vim.org> parents: 17292 diff changeset	765 let s:last_text = ''
17292 8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	766
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	767 func BalloonExpr()
17320 33dccaafb214 patch 8.1.1659: popup window "mousemoved" values not correct Bram Moolenaar <Bram@vim.org> parents: 17292 diff changeset	768 if s:winid && popup_getpos(s:winid) != {}
33dccaafb214 patch 8.1.1659: popup window "mousemoved" values not correct Bram Moolenaar <Bram@vim.org> parents: 17292 diff changeset	769 " previous popup window still shows
33dccaafb214 patch 8.1.1659: popup window "mousemoved" values not correct Bram Moolenaar <Bram@vim.org> parents: 17292 diff changeset	770 if v:beval_text == s:last_text
33dccaafb214 patch 8.1.1659: popup window "mousemoved" values not correct Bram Moolenaar <Bram@vim.org> parents: 17292 diff changeset	771 " Still the same text, keep the existing popup
33dccaafb214 patch 8.1.1659: popup window "mousemoved" values not correct Bram Moolenaar <Bram@vim.org> parents: 17292 diff changeset	772 return ''
33dccaafb214 patch 8.1.1659: popup window "mousemoved" values not correct Bram Moolenaar <Bram@vim.org> parents: 17292 diff changeset	773 endif
17292 8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	774 call popup_close(s:winid)
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	775 endif
17320 33dccaafb214 patch 8.1.1659: popup window "mousemoved" values not correct Bram Moolenaar <Bram@vim.org> parents: 17292 diff changeset	776 let s:winid = popup_beval(v:beval_text, {'mousemoved': 'word'})
33dccaafb214 patch 8.1.1659: popup window "mousemoved" values not correct Bram Moolenaar <Bram@vim.org> parents: 17292 diff changeset	777 let s:last_text = v:beval_text
17292 8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	778 return ''
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	779 endfunc
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	780 <
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	781 If the text has to be obtained asynchronously return an empty string from the
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	782 expression function and call popup_beval() once the text is available. In
17320 33dccaafb214 patch 8.1.1659: popup window "mousemoved" values not correct Bram Moolenaar <Bram@vim.org> parents: 17292 diff changeset	783 this example simulated with a timer callback: >
17292 8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	784
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	785 set ballooneval balloonevalterm
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	786 set balloonexpr=BalloonExpr()
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	787 let s:winid = 0
17320 33dccaafb214 patch 8.1.1659: popup window "mousemoved" values not correct Bram Moolenaar <Bram@vim.org> parents: 17292 diff changeset	788 let s:balloonText = ''
17292 8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	789
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	790 func BalloonExpr()
17320 33dccaafb214 patch 8.1.1659: popup window "mousemoved" values not correct Bram Moolenaar <Bram@vim.org> parents: 17292 diff changeset	791 if s:winid && popup_getpos(s:winid) != {}
33dccaafb214 patch 8.1.1659: popup window "mousemoved" values not correct Bram Moolenaar <Bram@vim.org> parents: 17292 diff changeset	792 " previous popup window still shows
33dccaafb214 patch 8.1.1659: popup window "mousemoved" values not correct Bram Moolenaar <Bram@vim.org> parents: 17292 diff changeset	793 if v:beval_text == s:balloonText
33dccaafb214 patch 8.1.1659: popup window "mousemoved" values not correct Bram Moolenaar <Bram@vim.org> parents: 17292 diff changeset	794 " Still the same text, keep the existing popup
33dccaafb214 patch 8.1.1659: popup window "mousemoved" values not correct Bram Moolenaar <Bram@vim.org> parents: 17292 diff changeset	795 return ''
33dccaafb214 patch 8.1.1659: popup window "mousemoved" values not correct Bram Moolenaar <Bram@vim.org> parents: 17292 diff changeset	796 endif
17292 8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	797 call popup_close(s:winid)
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	798 let s:winid = 0
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	799 endif
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	800 " simulate an asynchronous loopup for the text to display
17320 33dccaafb214 patch 8.1.1659: popup window "mousemoved" values not correct Bram Moolenaar <Bram@vim.org> parents: 17292 diff changeset	801 let s:balloonText = v:beval_text
17292 8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	802 call timer_start(100, 'ShowPopup')
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	803 return ''
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	804 endfunc
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	805
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	806 func ShowPopup(id)
17320 33dccaafb214 patch 8.1.1659: popup window "mousemoved" values not correct Bram Moolenaar <Bram@vim.org> parents: 17292 diff changeset	807 let s:winid = popup_beval(s:balloonText, {'mousemoved': 'word'})
17292 8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	808 endfunc
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	809 <
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	810
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	811 vim:tw=78:ts=8:noet:ft=help:norl:

Mercurial > vim

annotate runtime/doc/popup.txt @ 17320:33dccaafb214 v8.1.1659