vim: runtime/doc/popup.txt annotate

annotate runtime/doc/popup.txt @ 18750:82a28df1e2d5

Update runtime files. Commit: https://github.com/vim/vim/commit/91359014b359cf816bf943fe2c7d492996263def Author: Bram Moolenaar <Bram@vim.org> Date: Sat Nov 30 17:57:03 2019 +0100 Update runtime files.

author	Bram Moolenaar <Bram@vim.org>
date	Sat, 30 Nov 2019 18:00:05 +0100
parents	cb3163d590a1
children	8dde7ced3344

rev	line source
18750 82a28df1e2d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18639 diff changeset	1 popup.txt For Vim version 8.1. Last change: 2019 Nov 30
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
18750 82a28df1e2d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18639 diff changeset	7 Displaying text in a floating window. popup popup-window popupwin
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\|
17863 08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	19 Position popup with textprop \|popup-textprop-pos\|
17257 cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	20 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	21 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	22 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	23 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	24 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	25
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	26
16871 e5dab34ded73 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16859 diff changeset	27 {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	28
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	29 ==============================================================================
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	30 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	31
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	32 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	33 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	34 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	35
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	36 A popup window can be used for such things as:
16808 c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16806 diff changeset	37 - 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	38 - 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	39 - 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	40 - 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	41
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	42 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	43 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	44
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	45 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	46 "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	47 hi MyPopupColor ctermbg=lightblue guibg=lightblue
eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	48 call setwinvar(winid, '&wincolor', 'MyPopupColor')
eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	49
17045 7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	50 '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	51
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	52 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	53 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	54 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	55 what goes on top of what.
16808 c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16806 diff changeset	56
c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16806 diff changeset	57 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	58 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	59 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	60 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	61 window and buffer behave compared to regular windows and buffers, see
c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16806 diff changeset	62 \|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	63
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	64 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	65 - 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	66 - 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	67
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	68
17257 cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	69 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	70
16808 c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16806 diff changeset	71 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	72 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	73 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	74 property.
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	75
eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	76 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	77 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	78 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	79
16896 52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	80 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	81 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	82 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	83 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	84
16871 e5dab34ded73 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16859 diff changeset	85 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	86 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	87 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	88 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	89 window it will be placed below the cursor position.
e5dab34ded73 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16859 diff changeset	90
17036 235cbf491430 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17026 diff changeset	91 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	92 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	93
17045 7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	94 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	95 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	96 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	97
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	98
17257 cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	99 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	100
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	101 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	102 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	103 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	104 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	105 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	106 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	107 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	108 "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	109
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	110
17257 cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	111 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	112
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	113 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	114 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	115 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	116 - 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	117 - '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	118 - '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	119 - '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	120 - '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	121 - '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	122 - 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	123 value.
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	124
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	125 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	126 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	127
17909 cc953757ed2a Runtime files update. Bram Moolenaar <Bram@vim.org> parents: 17863 diff changeset	128 The window does have a cursor position, but the cursor is not displayed. In
cc953757ed2a Runtime files update. Bram Moolenaar <Bram@vim.org> parents: 17863 diff changeset	129 fact, the cursor in the underlying window is displayed, as if it peeks through
cc953757ed2a Runtime files update. Bram Moolenaar <Bram@vim.org> parents: 17863 diff changeset	130 the popup, so you can see where it is.
17257 cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	131
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	132 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	133 `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	134 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	135
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	136 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	137 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	138 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	139 call setbufvar(winbufnr(winid), '&filetype', 'java')
18162 9c3347b21b89 patch 8.1.2076: crash when trying to put a terminal in a popup window Bram Moolenaar <Bram@vim.org> parents: 18053 diff changeset	140 You can also use `win_execute()` with a ":setlocal" command.
17257 cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	141
16654 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 ==============================================================================
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	144 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	145
17045 7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	146 Creating a popup window:
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	147 \|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	148 \|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	149 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	150 \|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	151 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	152 \|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	153 \|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	154 \|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	155
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	156 Manipulating a popup window:
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	157 \|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	158 \|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	159 \|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	160 \|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	161 \|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	162
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	163 Closing popup windows:
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	164 \|popup_close()\| close one popup
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	165 \|popup_clear()\| close all popups
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	166
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	167 Filter functions:
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	168 \|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	169 \|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	170
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	171 Other:
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	172 \|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	173 \|popup_getpos()\| get actual position and size of a popup
17348 d82b0cfb1e82 patch 8.1.1673: cannot easily find the popup window at a certain position Bram Moolenaar <Bram@vim.org> parents: 17320 diff changeset	174 \|popup_locate()\| find popup window at a screen position
17045 7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	175
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 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 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	178
17257 cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	179 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	180 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	181 moves. This works like: >
17413 40417757dffd patch 8.1.1705: using ~{} for a literal dict is not nice Bram Moolenaar <Bram@vim.org> parents: 17387 diff changeset	182 call popup_create({what}, #{
17372 b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	183 \ pos: 'botleft',
b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	184 \ line: 'cursor-1',
b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	185 \ col: 'cursor',
b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	186 \ moved: 'WORD',
17026 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 < Use {options} to change the properties.
18558 e5ef5d820b5b patch 8.1.2273: wrong default when "pos" is changed with popup_atcursor() Bram Moolenaar <Bram@vim.org> parents: 18512 diff changeset	189 If "pos" is passed as "topleft" then the default for "line"
e5ef5d820b5b patch 8.1.2273: wrong default when "pos" is changed with popup_atcursor() Bram Moolenaar <Bram@vim.org> parents: 18512 diff changeset	190 becomes "cursor+1".
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	191
17972 a170c48e0f91 patch 8.1.1982: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17946 diff changeset	192 Can also be used as a \|method\|: >
a170c48e0f91 patch 8.1.1982: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17946 diff changeset	193 GetText()->popup_atcursor({})
a170c48e0f91 patch 8.1.1982: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17946 diff changeset	194
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	195
17292 8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	196 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	197 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	198 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	199 let pos = screenpos(v:beval_winnr, v:beval_lnum, v:beval_col)
17413 40417757dffd patch 8.1.1705: using ~{} for a literal dict is not nice Bram Moolenaar <Bram@vim.org> parents: 17387 diff changeset	200 call popup_create({what}, #{
17372 b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	201 \ pos: 'botleft',
b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	202 \ line: pos.row - 1,
b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	203 \ col: pos.col,
b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	204 \ 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	205 \ })
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	206 < Use {options} to change the properties.
18053 8ac85adee561 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 18016 diff changeset	207 See \|popup_beval_example\| for an example.
17292 8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	208
17972 a170c48e0f91 patch 8.1.1982: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17946 diff changeset	209 Can also be used as a \|method\|: >
a170c48e0f91 patch 8.1.1982: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17946 diff changeset	210 GetText()->popup_beval({})
a170c48e0f91 patch 8.1.1982: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17946 diff changeset	211 <
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	212 popup_clear()
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	213 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	214 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	215
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 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	218 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	219 be deleted.
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	220
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	221 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	222 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	223 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	224 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	225
17972 a170c48e0f91 patch 8.1.1982: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17946 diff changeset	226 Can also be used as a \|method\|: >
a170c48e0f91 patch 8.1.1982: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17946 diff changeset	227 GetPopup()->popup_close()
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	228
17225 09fa437d33d8 patch 8.1.1612: cannot show an existing buffer in a popup window Bram Moolenaar <Bram@vim.org> parents: 17219 diff changeset	229 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	230 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	231 - 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	232 - a string
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	233 - 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	234 - 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	235 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	236 '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	237 the popup closes.
16871 e5dab34ded73 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16859 diff changeset	238
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	239 {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	240 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	241
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	242 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	243 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	244 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	245 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	246 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	247 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	248 < 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	249
17972 a170c48e0f91 patch 8.1.1982: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17946 diff changeset	250 Can also be used as a \|method\|: >
a170c48e0f91 patch 8.1.1982: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17946 diff changeset	251 GetText()->popup_create({})
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	252
17225 09fa437d33d8 patch 8.1.1612: cannot show an existing buffer in a popup window Bram Moolenaar <Bram@vim.org> parents: 17219 diff changeset	253 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	254 Just like \|popup_create()\| but with these default options: >
17413 40417757dffd patch 8.1.1705: using ~{} for a literal dict is not nice Bram Moolenaar <Bram@vim.org> parents: 17387 diff changeset	255 call popup_create({what}, #{
17372 b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	256 \ pos: 'center',
b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	257 \ zindex: 200,
b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	258 \ drag: 1,
b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	259 \ border: [],
b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	260 \ padding: [],
17604 506dd2efcbb2 patch 8.1.1799: cannot avoid mapping for a popup window Bram Moolenaar <Bram@vim.org> parents: 17580 diff changeset	261 \ mapping: 0,
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	262 \})
17045 7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	263 < 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	264 option with value 'popup_filter_yesno'. Example: >
17413 40417757dffd patch 8.1.1705: using ~{} for a literal dict is not nice Bram Moolenaar <Bram@vim.org> parents: 17387 diff changeset	265 call popup_create('do you want to quit (Yes/no)?', #{
17372 b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	266 \ filter: 'popup_filter_yesno',
b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	267 \ callback: 'QuitCallback',
17097 94007c802045 patch 8.1.1548: popup_dialog() is not implemented Bram Moolenaar <Bram@vim.org> parents: 17077 diff changeset	268 \ })
94007c802045 patch 8.1.1548: popup_dialog() is not implemented Bram Moolenaar <Bram@vim.org> parents: 17077 diff changeset	269
94007c802045 patch 8.1.1548: popup_dialog() is not implemented Bram Moolenaar <Bram@vim.org> parents: 17077 diff changeset	270 < 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	271 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	272
17972 a170c48e0f91 patch 8.1.1982: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17946 diff changeset	273 Can also be used as a \|method\|: >
a170c48e0f91 patch 8.1.1982: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17946 diff changeset	274 GetText()->popup_dialog({})
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	275
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	276 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	277 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	278 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	279 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	280 <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	281 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	282 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	283
7ef5283ace3c patch 8.1.1558: popup_menu() and popup_filter_menu() are not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17107 diff changeset	284 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	285 \|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	286
7ef5283ace3c patch 8.1.1558: popup_menu() and popup_filter_menu() are not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17107 diff changeset	287 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	288 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	289 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	290 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	291
17149 c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	292 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	293 \|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	294
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	295
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	296 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	297 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	298 '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	299 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	300 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	301 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	302 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	303 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	304
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	305
17817 e8a7029efa40 patch 8.1.1905: cannot set all properties of the info popup Bram Moolenaar <Bram@vim.org> parents: 17667 diff changeset	306 popup_findinfo() popup_findinfo()
e8a7029efa40 patch 8.1.1905: cannot set all properties of the info popup Bram Moolenaar <Bram@vim.org> parents: 17667 diff changeset	307 Get the \|window-ID\| for the popup info window, as it used by
e8a7029efa40 patch 8.1.1905: cannot set all properties of the info popup Bram Moolenaar <Bram@vim.org> parents: 17667 diff changeset	308 the popup menu. See \|complete-popup\|. The info popup is
e8a7029efa40 patch 8.1.1905: cannot set all properties of the info popup Bram Moolenaar <Bram@vim.org> parents: 17667 diff changeset	309 hidden when not used, it can be deleted with \|popup_clear()\|
18456 6d11fc4aa683 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 18398 diff changeset	310 and \|popup_close()\|. Use \|popup_show()\| to reposition it to
6d11fc4aa683 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 18398 diff changeset	311 the item in the popup menu.
6d11fc4aa683 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 18398 diff changeset	312 Returns zero if there is none.
17817 e8a7029efa40 patch 8.1.1905: cannot set all properties of the info popup Bram Moolenaar <Bram@vim.org> parents: 17667 diff changeset	313
e8a7029efa40 patch 8.1.1905: cannot set all properties of the info popup Bram Moolenaar <Bram@vim.org> parents: 17667 diff changeset	314
e8a7029efa40 patch 8.1.1905: cannot set all properties of the info popup Bram Moolenaar <Bram@vim.org> parents: 17667 diff changeset	315 popup_findpreview() popup_findpreview()
e8a7029efa40 patch 8.1.1905: cannot set all properties of the info popup Bram Moolenaar <Bram@vim.org> parents: 17667 diff changeset	316 Get the \|window-ID\| for the popup preview window.
e8a7029efa40 patch 8.1.1905: cannot set all properties of the info popup Bram Moolenaar <Bram@vim.org> parents: 17667 diff changeset	317 Return zero if there is none.
e8a7029efa40 patch 8.1.1905: cannot set all properties of the info popup Bram Moolenaar <Bram@vim.org> parents: 17667 diff changeset	318
e8a7029efa40 patch 8.1.1905: cannot set all properties of the info popup Bram Moolenaar <Bram@vim.org> parents: 17667 diff changeset	319
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	320 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	321 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	322 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	323 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	324
17292 8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	325 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	326 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	327
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	328 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	329 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	330
17909 cc953757ed2a Runtime files update. Bram Moolenaar <Bram@vim.org> parents: 17863 diff changeset	331 "firstline" is the property set on the popup, unlike the
cc953757ed2a Runtime files update. Bram Moolenaar <Bram@vim.org> parents: 17863 diff changeset	332 "firstline" obtained with \|popup_getpos()\| which is the actual
cc953757ed2a Runtime files update. Bram Moolenaar <Bram@vim.org> parents: 17863 diff changeset	333 buffer line at the top of the popup window.
cc953757ed2a Runtime files update. Bram Moolenaar <Bram@vim.org> parents: 17863 diff changeset	334
17123 efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	335 "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	336 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	337
efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	338 "borderhighlight" is not included when all values are empty.
17429 6e756ad5ef1a patch 8.1.1713: highlighting cursor line only works with popup_menu() Bram Moolenaar <Bram@vim.org> parents: 17413 diff changeset	339 "scrollbarhighlight" and "thumbhighlight" are only included
17216 11f3cf51d43b patch 8.1.1608: the evalfunc.c file is too big Bram Moolenaar <Bram@vim.org> parents: 17196 diff changeset	340 when set.
17123 efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	341
17149 c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	342 "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	343 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	344 another tabpage.
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	345
17863 08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	346 "textprop", "textpropid" and "textpropwin" are only present
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	347 when "textprop" was set.
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	348
17123 efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	349 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	350
17972 a170c48e0f91 patch 8.1.1982: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17946 diff changeset	351 Can also be used as a \|method\|: >
a170c48e0f91 patch 8.1.1982: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17946 diff changeset	352 GetPopup()->popup_getoptions()
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	353
16855 19162ff4eacd patch 8.1.1429: "pos" option of popup window not supported yet Bram Moolenaar <Bram@vim.org> parents: 16853 diff changeset	354 popup_getpos({id}) popup_getpos()
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	355 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	356 with these entries:
16841 cf630fab9fb6 patch 8.1.1422: popup_getoptions() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16833 diff changeset	357 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	358 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	359 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	360 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	361 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	362 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	363 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	364 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	365 firstline line of the buffer at top (1 unless scrolled)
18343 375a7ecdb351 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18162 diff changeset	366 (not the value of the "firstline" property)
18558 e5ef5d820b5b patch 8.1.2273: wrong default when "pos" is changed with popup_atcursor() Bram Moolenaar <Bram@vim.org> parents: 18512 diff changeset	367 lastline line of the buffer at the bottom (updated when
e5ef5d820b5b patch 8.1.2273: wrong default when "pos" is changed with popup_atcursor() Bram Moolenaar <Bram@vim.org> parents: 18512 diff changeset	368 the popup is redrawn)
17196 983950357c40 patch 8.1.1597: cannot scroll a popup window with the mouse Bram Moolenaar <Bram@vim.org> parents: 17180 diff changeset	369 scrollbar non-zero if a scrollbar is displayed
17036 235cbf491430 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17026 diff changeset	370 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	371 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	372 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	373 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	374
59e4148c0c73 patch 8.1.1443: popup window padding and border not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16880 diff changeset	375 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	376
16829 5cebaecad422 patch 8.1.1416: popup_getposition() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16817 diff changeset	377 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	378
17972 a170c48e0f91 patch 8.1.1982: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17946 diff changeset	379 Can also be used as a \|method\|: >
a170c48e0f91 patch 8.1.1982: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17946 diff changeset	380 GetPopup()->popup_getpos()
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	381
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	382 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	383 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	384 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	385 hidden.
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	386 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	387 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	388
17972 a170c48e0f91 patch 8.1.1982: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17946 diff changeset	389 Can also be used as a \|method\|: >
a170c48e0f91 patch 8.1.1982: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17946 diff changeset	390 GetPopup()->popup_hide()
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	391
17348 d82b0cfb1e82 patch 8.1.1673: cannot easily find the popup window at a certain position Bram Moolenaar <Bram@vim.org> parents: 17320 diff changeset	392 popup_locate({row}, {col}) popup_locate()
17429 6e756ad5ef1a patch 8.1.1713: highlighting cursor line only works with popup_menu() Bram Moolenaar <Bram@vim.org> parents: 17413 diff changeset	393 Return the \|window-ID\| of the popup at screen position {row}
17348 d82b0cfb1e82 patch 8.1.1673: cannot easily find the popup window at a certain position Bram Moolenaar <Bram@vim.org> parents: 17320 diff changeset	394 and {col}. If there are multiple popups the one with the
d82b0cfb1e82 patch 8.1.1673: cannot easily find the popup window at a certain position Bram Moolenaar <Bram@vim.org> parents: 17320 diff changeset	395 highest zindex is returned. If there are no popups at this
d82b0cfb1e82 patch 8.1.1673: cannot easily find the popup window at a certain position Bram Moolenaar <Bram@vim.org> parents: 17320 diff changeset	396 position then zero is returned.
d82b0cfb1e82 patch 8.1.1673: cannot easily find the popup window at a certain position Bram Moolenaar <Bram@vim.org> parents: 17320 diff changeset	397
d82b0cfb1e82 patch 8.1.1673: cannot easily find the popup window at a certain position Bram Moolenaar <Bram@vim.org> parents: 17320 diff changeset	398
17225 09fa437d33d8 patch 8.1.1612: cannot show an existing buffer in a popup window Bram Moolenaar <Bram@vim.org> parents: 17219 diff changeset	399 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	400 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	401 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	402 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	403 useful. This works like: >
17413 40417757dffd patch 8.1.1705: using ~{} for a literal dict is not nice Bram Moolenaar <Bram@vim.org> parents: 17387 diff changeset	404 call popup_create({what}, #{
17372 b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	405 \ pos: 'center',
b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	406 \ zindex: 200,
b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	407 \ drag: 1,
b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	408 \ wrap: 0,
b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	409 \ border: [],
17429 6e756ad5ef1a patch 8.1.1713: highlighting cursor line only works with popup_menu() Bram Moolenaar <Bram@vim.org> parents: 17413 diff changeset	410 \ cursorline: 1,
17383 b18fd36fdf46 patch 8.1.1690: default padding for popup window menu is too much Bram Moolenaar <Bram@vim.org> parents: 17372 diff changeset	411 \ padding: [0,1,0,1],
17372 b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	412 \ filter: 'popup_filter_menu',
17604 506dd2efcbb2 patch 8.1.1799: cannot avoid mapping for a popup window Bram Moolenaar <Bram@vim.org> parents: 17580 diff changeset	413 \ mapping: 0,
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	414 \ })
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	415 < The current line is highlighted with a match using
17161 9ccb1ea9b2fc Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17149 diff changeset	416 "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	417
7ef5283ace3c patch 8.1.1558: popup_menu() and popup_filter_menu() are not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17107 diff changeset	418 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	419 "callback" to a function that handles the selected item.
17604 506dd2efcbb2 patch 8.1.1799: cannot avoid mapping for a popup window Bram Moolenaar <Bram@vim.org> parents: 17580 diff changeset	420 Example: >
506dd2efcbb2 patch 8.1.1799: cannot avoid mapping for a popup window Bram Moolenaar <Bram@vim.org> parents: 17580 diff changeset	421 func ColorSelected(id, result)
506dd2efcbb2 patch 8.1.1799: cannot avoid mapping for a popup window Bram Moolenaar <Bram@vim.org> parents: 17580 diff changeset	422 " use a:result
506dd2efcbb2 patch 8.1.1799: cannot avoid mapping for a popup window Bram Moolenaar <Bram@vim.org> parents: 17580 diff changeset	423 endfunc
506dd2efcbb2 patch 8.1.1799: cannot avoid mapping for a popup window Bram Moolenaar <Bram@vim.org> parents: 17580 diff changeset	424 call popup_menu(['red', 'green', 'blue'], #{
506dd2efcbb2 patch 8.1.1799: cannot avoid mapping for a popup window Bram Moolenaar <Bram@vim.org> parents: 17580 diff changeset	425 \ callback: 'ColorSelected',
506dd2efcbb2 patch 8.1.1799: cannot avoid mapping for a popup window Bram Moolenaar <Bram@vim.org> parents: 17580 diff changeset	426 \ })
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	427
17972 a170c48e0f91 patch 8.1.1982: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17946 diff changeset	428 < Can also be used as a \|method\|: >
a170c48e0f91 patch 8.1.1982: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17946 diff changeset	429 GetChoices()->popup_menu({})
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	430
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	431 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	432 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	433 {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	434 specify the popup position:
efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	435 line
efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	436 col
efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	437 pos
efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	438 maxheight
efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	439 minheight
efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	440 maxwidth
efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	441 minwidth
efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	442 fixed
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	443 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	444 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	445
17972 a170c48e0f91 patch 8.1.1982: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17946 diff changeset	446 Can also be used as a \|method\|: >
a170c48e0f91 patch 8.1.1982: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17946 diff changeset	447 GetPopup()->popup_move(options)
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	448
17225 09fa437d33d8 patch 8.1.1612: cannot show an existing buffer in a popup window Bram Moolenaar <Bram@vim.org> parents: 17219 diff changeset	449 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	450 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	451 This works like: >
17413 40417757dffd patch 8.1.1705: using ~{} for a literal dict is not nice Bram Moolenaar <Bram@vim.org> parents: 17387 diff changeset	452 call popup_create({what}, #{
17372 b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	453 \ line: 1,
b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	454 \ col: 10,
b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	455 \ minwidth: 20,
b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	456 \ time: 3000,
b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	457 \ tabpage: -1,
b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	458 \ zindex: 300,
b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	459 \ drag: 1,
b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	460 \ highlight: 'WarningMsg',
b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	461 \ border: [],
b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	462 \ close: 'click',
b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	463 \ 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	464 \ })
17077 2546930657a9 patch 8.1.1538: cannot specify highlighting for notifications Bram Moolenaar <Bram@vim.org> parents: 17075 diff changeset	465 < 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	466 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	467
17946 ec4248c4b92c patch 8.1.1969: popup window filter is used in all modes Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	468 Without the \|+timers\| feature the popup will not disappear
17219 5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	469 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	470
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	471 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	472 notifications.
7fe328ad5573 patch 8.1.1522: poup_notification() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	473 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	474
17972 a170c48e0f91 patch 8.1.1982: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17946 diff changeset	475 Can also be used as a \|method\|: >
a170c48e0f91 patch 8.1.1982: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17946 diff changeset	476 GetText()->popup_notification({})
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	477
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	478 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	479 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	480 For {id} see `popup_hide()`.
18398 21c25bee9df8 patch 8.1.2193: popup_setoptions(popup_getoptions()) does not work Bram Moolenaar <Bram@vim.org> parents: 18343 diff changeset	481 If {id} is the info popup it will be positioned next to the
21c25bee9df8 patch 8.1.2193: popup_setoptions(popup_getoptions()) does not work Bram Moolenaar <Bram@vim.org> parents: 18343 diff changeset	482 current popup menu item.
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	483
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	484
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	485 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	486 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	487 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	488 border
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	489 borderchars
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	490 borderhighlight
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	491 callback
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	492 close
17604 506dd2efcbb2 patch 8.1.1799: cannot avoid mapping for a popup window Bram Moolenaar <Bram@vim.org> parents: 17580 diff changeset	493 cursorline
17123 efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	494 drag
17219 5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	495 filter
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	496 firstline
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	497 flip
17123 efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	498 highlight
17604 506dd2efcbb2 patch 8.1.1799: cannot avoid mapping for a popup window Bram Moolenaar <Bram@vim.org> parents: 17580 diff changeset	499 mapping
17219 5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	500 mask
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	501 moved
17123 efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	502 padding
17604 506dd2efcbb2 patch 8.1.1799: cannot avoid mapping for a popup window Bram Moolenaar <Bram@vim.org> parents: 17580 diff changeset	503 resize
17180 8581779aa16f patch 8.1.1589: popup window does not indicate scroll position Bram Moolenaar <Bram@vim.org> parents: 17174 diff changeset	504 scrollbar
17216 11f3cf51d43b patch 8.1.1608: the evalfunc.c file is too big Bram Moolenaar <Bram@vim.org> parents: 17196 diff changeset	505 scrollbarhighlight
11f3cf51d43b patch 8.1.1608: the evalfunc.c file is too big Bram Moolenaar <Bram@vim.org> parents: 17196 diff changeset	506 thumbhighlight
17219 5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	507 time
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	508 title
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	509 wrap
17123 efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	510 zindex
efc6f5e3b543 patch 8.1.1561: popup_setoptions() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 17119 diff changeset	511 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	512 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	513 "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	514
17972 a170c48e0f91 patch 8.1.1982: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17946 diff changeset	515 Can also be used as a \|method\|: >
a170c48e0f91 patch 8.1.1982: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17946 diff changeset	516 GetPopup()->popup_setoptions(options)
a170c48e0f91 patch 8.1.1982: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17946 diff changeset	517
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	518 popup_settext({id}, {text}) popup_settext()
17946 ec4248c4b92c patch 8.1.1969: popup window filter is used in all modes Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	519 Set the text of the buffer in popup 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	520 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	521 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	522 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	523 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	524
17972 a170c48e0f91 patch 8.1.1982: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17946 diff changeset	525 Can also be used as a \|method\|: >
a170c48e0f91 patch 8.1.1982: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17946 diff changeset	526 GetPopup()->popup_settext('hello')
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	527
17257 cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	528 ==============================================================================
cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	529 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	530
17257 cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	531 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	532
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	533 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	534 \|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	535 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	536 - 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	537 - a string
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	538 - 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	539 - 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	540 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	541 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	542 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	543 \|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	544 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	545 \|popup-props\|.
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	546
18162 9c3347b21b89 patch 8.1.2076: crash when trying to put a terminal in a popup window Bram Moolenaar <Bram@vim.org> parents: 18053 diff changeset	547 If you want to create a new buffer yourself use \|bufadd()\| and pass the buffer
9c3347b21b89 patch 8.1.2076: crash when trying to put a terminal in a popup window Bram Moolenaar <Bram@vim.org> parents: 18053 diff changeset	548 number to popup_create().
9c3347b21b89 patch 8.1.2076: crash when trying to put a terminal in a popup window Bram Moolenaar <Bram@vim.org> parents: 18053 diff changeset	549 It is not possible to use the buffer of a terminal window. E278
9c3347b21b89 patch 8.1.2076: crash when trying to put a terminal in a popup window Bram Moolenaar <Bram@vim.org> parents: 18053 diff changeset	550
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	551 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	552 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	553 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	554 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	555 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	556 The first line is 1.
17863 08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	557 When using "textprop" the number is relative to the
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	558 text property and can be negative.
16896 52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	559 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	560 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	561 "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	562 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	563 centered. The first column is 1.
17863 08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	564 When using "textprop" the number is relative to the
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	565 text property and can be negative.
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	566 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	567 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	568 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	569 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	570 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	571 "line" and "col" are ignored.
18558 e5ef5d820b5b patch 8.1.2273: wrong default when "pos" is changed with popup_atcursor() Bram Moolenaar <Bram@vim.org> parents: 18512 diff changeset	572 posinvert When FALSE the value of "pos" is always used. When
e5ef5d820b5b patch 8.1.2273: wrong default when "pos" is changed with popup_atcursor() Bram Moolenaar <Bram@vim.org> parents: 18512 diff changeset	573 TRUE (the default) and the popup does not fit
e5ef5d820b5b patch 8.1.2273: wrong default when "pos" is changed with popup_atcursor() Bram Moolenaar <Bram@vim.org> parents: 18512 diff changeset	574 vertically and there is more space on the other side
e5ef5d820b5b patch 8.1.2273: wrong default when "pos" is changed with popup_atcursor() Bram Moolenaar <Bram@vim.org> parents: 18512 diff changeset	575 then the popup is placed on the other side of the
e5ef5d820b5b patch 8.1.2273: wrong default when "pos" is changed with popup_atcursor() Bram Moolenaar <Bram@vim.org> parents: 18512 diff changeset	576 position indicated by "line".
17863 08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	577 textprop When present the popup is positioned next to a text
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	578 property with this name and will move when the text
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	579 property moves. Use an empty string to remove. See
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	580 \|popup-textprop-pos\|.
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	581 textpropwin What window to search for the text property. When
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	582 omitted or invalid the current window is used.
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	583 textpropid Used to identify the text property when "textprop" is
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	584 present. Use zero to reset.
16896 52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	585 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	586 - "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	587 - "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	588 - 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	589 the screen, then
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	590 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	591 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	592 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	593 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	594 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	595 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	596 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	597 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	598 {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	599 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	600 padding.
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	601 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	602 padding.
17571 2704c4e3e20a Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 17545 diff changeset	603 maxwidth Maximum width of the contents, excluding border,
2704c4e3e20a Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 17545 diff changeset	604 padding and scrollbar.
2704c4e3e20a Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 17545 diff changeset	605 minwidth Minimum width of the contents, excluding border,
2704c4e3e20a Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 17545 diff changeset	606 padding and scrollbar.
17047 6400d1ad5e4b patch 8.1.1523: cannot show range of buffer lines in popup window Bram Moolenaar <Bram@vim.org> parents: 17045 diff changeset	607 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	608 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	609 the last buffer line will at the top of the window.
17909 cc953757ed2a Runtime files update. Bram Moolenaar <Bram@vim.org> parents: 17863 diff changeset	610 Set to zero to leave the position as set by commands.
17180 8581779aa16f patch 8.1.1589: popup window does not indicate scroll position Bram Moolenaar <Bram@vim.org> parents: 17174 diff changeset	611 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	612 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	613 `popup_show()` to unhide it.
17161 9ccb1ea9b2fc Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17149 diff changeset	614 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	615 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	616 tab page.
16896 52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	617 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	618 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	619 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	620 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	621 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	622 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	623 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	624 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	625 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	626 drag TRUE to allow the popup to be dragged with the mouse
17946 ec4248c4b92c patch 8.1.1969: popup window filter is used in all modes Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	627 by grabbing 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	628 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	629 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	630 "topleft".
17580 d5e5d0fc3fa8 patch 8.1.1787: cannot resize a popup window Bram Moolenaar <Bram@vim.org> parents: 17571 diff changeset	631 resize TRUE to allow the popup to be resized with the mouse
17946 ec4248c4b92c patch 8.1.1969: popup window filter is used in all modes Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	632 by grabbing at the bottom right corner. Has no effect
ec4248c4b92c patch 8.1.1969: popup window filter is used in all modes Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	633 if the popup does not have a border.
17219 5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	634 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	635 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	636 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	637 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	638 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	639 it.
5169811b3044 patch 8.1.1609: the user cannot easily close a popup window Bram Moolenaar <Bram@vim.org> parents: 17216 diff changeset	640 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	641 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	642 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	643 the 'wincolor' option.
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	644 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	645 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	646 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	647 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	648 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	649 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	650 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	651 the left.
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	652 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	653 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	654 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	655 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	656 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	657 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	658 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	659 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	660 'LeftColor']
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	661 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	662 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	663 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	664 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	665 Example: ['-', '\|', '-', '\|', '┌', '┐', '┘', '└']
52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	666 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	667 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	668 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	669 By default a double line is used all around when
17161 9ccb1ea9b2fc Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17149 diff changeset	670 '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	671 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	672 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	673 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	674 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	675 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	676 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	677 PmenuSbar is used.
11f3cf51d43b patch 8.1.1608: the evalfunc.c file is too big Bram Moolenaar <Bram@vim.org> parents: 17196 diff changeset	678 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	679 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	680 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	681 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	682 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	683 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	684 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	685 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	686 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	687 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	688 - "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	689 - "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	690 - "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	691 - "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	692 - [{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	693 {start} or after {end}
18398 21c25bee9df8 patch 8.1.2193: popup_setoptions(popup_getoptions()) does not work Bram Moolenaar <Bram@vim.org> parents: 18343 diff changeset	694 - [{lnum}, {start}, {end}]: if the cursor moved away
21c25bee9df8 patch 8.1.2193: popup_setoptions(popup_getoptions()) does not work Bram Moolenaar <Bram@vim.org> parents: 18343 diff changeset	695 from line {lnum}, before column {start} or after
21c25bee9df8 patch 8.1.2193: popup_setoptions(popup_getoptions()) does not work Bram Moolenaar <Bram@vim.org> parents: 18343 diff changeset	696 {end}
18558 e5ef5d820b5b patch 8.1.2273: wrong default when "pos" is changed with popup_atcursor() Bram Moolenaar <Bram@vim.org> parents: 18512 diff changeset	697 - [0, 0, 0] do not close the popup when the cursor
e5ef5d820b5b patch 8.1.2273: wrong default when "pos" is changed with popup_atcursor() Bram Moolenaar <Bram@vim.org> parents: 18512 diff changeset	698 moves
16904 9138e2c60bf1 patch 8.1.1453: popup window "moved" property not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16896 diff changeset	699 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	700 line or to another window.
18398 21c25bee9df8 patch 8.1.2193: popup_setoptions(popup_getoptions()) does not work Bram Moolenaar <Bram@vim.org> parents: 18343 diff changeset	701 mousemoved Like "moved" but referring to the mouse pointer
21c25bee9df8 patch 8.1.2193: popup_setoptions(popup_getoptions()) does not work Bram Moolenaar <Bram@vim.org> parents: 18343 diff changeset	702 position
17429 6e756ad5ef1a patch 8.1.1713: highlighting cursor line only works with popup_menu() Bram Moolenaar <Bram@vim.org> parents: 17413 diff changeset	703 cursorline non-zero: Highlight the cursor line. Also scrolls the
6e756ad5ef1a patch 8.1.1713: highlighting cursor line only works with popup_menu() Bram Moolenaar <Bram@vim.org> parents: 17413 diff changeset	704 text to show this line (only works properly
6e756ad5ef1a patch 8.1.1713: highlighting cursor line only works with popup_menu() Bram Moolenaar <Bram@vim.org> parents: 17413 diff changeset	705 when 'wrap' is off).
6e756ad5ef1a patch 8.1.1713: highlighting cursor line only works with popup_menu() Bram Moolenaar <Bram@vim.org> parents: 17413 diff changeset	706 zero: Do not highlight the cursor line.
6e756ad5ef1a patch 8.1.1713: highlighting cursor line only works with popup_menu() Bram Moolenaar <Bram@vim.org> parents: 17413 diff changeset	707 Default is zero, except for \|popup_menu()\|.
17036 235cbf491430 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17026 diff changeset	708 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	709 \|popup-filter\|.
17604 506dd2efcbb2 patch 8.1.1799: cannot avoid mapping for a popup window Bram Moolenaar <Bram@vim.org> parents: 17580 diff changeset	710 mapping Allow for key mapping. When FALSE and the popup is
506dd2efcbb2 patch 8.1.1799: cannot avoid mapping for a popup window Bram Moolenaar <Bram@vim.org> parents: 17580 diff changeset	711 visible and has a filter callback key mapping is
506dd2efcbb2 patch 8.1.1799: cannot avoid mapping for a popup window Bram Moolenaar <Bram@vim.org> parents: 17580 diff changeset	712 disabled. Default value is TRUE.
17946 ec4248c4b92c patch 8.1.1969: popup window filter is used in all modes Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	713 filtermode In which modes the filter is used (same flags as with
ec4248c4b92c patch 8.1.1969: popup window filter is used in all modes Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	714 \|hasmapto()\| plus "a"):
ec4248c4b92c patch 8.1.1969: popup window filter is used in all modes Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	715 n Normal mode
ec4248c4b92c patch 8.1.1969: popup window filter is used in all modes Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	716 v Visual and Select mode
ec4248c4b92c patch 8.1.1969: popup window filter is used in all modes Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	717 x Visual mode
ec4248c4b92c patch 8.1.1969: popup window filter is used in all modes Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	718 s Select mode
ec4248c4b92c patch 8.1.1969: popup window filter is used in all modes Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	719 o Operator-pending mode
ec4248c4b92c patch 8.1.1969: popup window filter is used in all modes Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	720 i Insert mode
ec4248c4b92c patch 8.1.1969: popup window filter is used in all modes Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	721 l Language-Argument ("r", "f", "t", etc.)
ec4248c4b92c patch 8.1.1969: popup window filter is used in all modes Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	722 c Command-line mode
ec4248c4b92c patch 8.1.1969: popup window filter is used in all modes Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	723 a all modes
ec4248c4b92c patch 8.1.1969: popup window filter is used in all modes Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	724 The default value is "a".
16896 52fc577a087d patch 8.1.1449: popup text truncated at end of screen Bram Moolenaar <Bram@vim.org> parents: 16890 diff changeset	725 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	726 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	727
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	728 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	729 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	730 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	731
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	732 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	733 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	734 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	735
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	736
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	737 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	738
16811 0457d49eb2d9 patch 8.1.1407: popup_create() does not support text properties Bram Moolenaar <Bram@vim.org> parents: 16809 diff changeset	739 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	740 - "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	741 - "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	742 - "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	743 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	744 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	745 first column.
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	746 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	747 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	748 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	749 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	750 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	751 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	752 used
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	753 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	754 \|prop_type_add()\|
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	755
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	756
17863 08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	757 POSITION POPUP WITH TEXTPROP popup-textprop-pos
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	758
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	759 Positioning a popup next to a text property causes the popup to move when text
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	760 is inserted or deleted. The popup functions like a tooltip.
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	761
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	762 These steps are needed to make this work:
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	763
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	764 - Define a text property type, it defines the name. >
18343 375a7ecdb351 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18162 diff changeset	765 call prop_type_add('popupMarker', {})
17863 08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	766
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	767 - Place a text property at the desired text: >
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	768 let lnum = {line of the text}
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	769 let col = {start column of the text}
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	770 let len = {length of the text}
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	771 let propId = {arbitrary but unique number}
18343 375a7ecdb351 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18162 diff changeset	772 call prop_add(lnum, col, #{
17863 08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	773 \ length: len,
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	774 \ type: 'popupMarker',
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	775 \ id: propId,
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	776 \ })
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	777
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	778 - Create a popup: >
18343 375a7ecdb351 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18162 diff changeset	779 let winid = popup_create('the text', #{
375a7ecdb351 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18162 diff changeset	780 \ pos: 'botleft',
17863 08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	781 \ textprop: 'popupMarker',
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	782 \ textpropid: propId,
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	783 \ border: [],
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	784 \ padding: [0,1,0,1],
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	785 \ close: 'click',
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	786 \ })
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	787
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	788 By default the popup is positioned at the corner of the text, opposite of the
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	789 "pos" specified for the popup. Thus when the popup uses "botleft", the
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	790 bottom-left corner of the popup is positioned next to the top-right corner of
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	791 the text property:
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	792 +----------+
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	793 \| the text \|
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	794 +----------+
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	795 just some PROPERTY as an example
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	796
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	797 Here the text property is on "PROPERTY". Move the popup to the left by
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	798 passing a negative "col" value to popup_create(). With "col: -5" you get:
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	799
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	800 +----------+
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	801 \| the text \|
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	802 +----------+
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	803 just some PROPERTY as an example
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	804
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	805 If the text property moves out of view then the popup will be hidden.
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	806 If the window for which the popup was defined is closed, the popup is closed.
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	807
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	808 If the popup cannot fit in the desired position, it may show at a nearby
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	809 position.
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	810
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	811 Some hints:
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	812 - To avoid collision with other plugins the text property type name has to be
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	813 unique. You can also use the "bufnr" item to make it local to a buffer.
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	814 - You can leave out the text property ID if there is only ever one text
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	815 property visible.
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	816 - The popup may be in the way of what the user is doing, making it close with
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	817 a click, as in the example above, helps for that.
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	818 - If the text property is removed the popup is closed. Use something like
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	819 this: >
18343 375a7ecdb351 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18162 diff changeset	820 call prop_remove(#{type: 'popupMarker', id: propId})
17863 08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	821
08f1dd29550e patch 8.1.1928: popup windows don't move with the text when making changes Bram Moolenaar <Bram@vim.org> parents: 17817 diff changeset	822
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	823 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	824
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	825 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	826 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	827
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	828 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	829 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	830 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	831 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	832 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	833
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	834 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	835 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	836 func MyFilter(winid, key)
998603a243d7 patch 8.1.1441: popup window filter not yet implemented Bram Moolenaar <Bram@vim.org> parents: 16871 diff changeset	837 if a:key == "\<F2>"
998603a243d7 patch 8.1.1441: popup window filter not yet implemented Bram Moolenaar <Bram@vim.org> parents: 16871 diff changeset	838 " do something
998603a243d7 patch 8.1.1441: popup window filter not yet implemented Bram Moolenaar <Bram@vim.org> parents: 16871 diff changeset	839 return 1
998603a243d7 patch 8.1.1441: popup window filter not yet implemented Bram Moolenaar <Bram@vim.org> parents: 16871 diff changeset	840 endif
998603a243d7 patch 8.1.1441: popup window filter not yet implemented Bram Moolenaar <Bram@vim.org> parents: 16871 diff changeset	841 if a:key == 'x'
998603a243d7 patch 8.1.1441: popup window filter not yet implemented Bram Moolenaar <Bram@vim.org> parents: 16871 diff changeset	842 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	843 return 1
998603a243d7 patch 8.1.1441: popup window filter not yet implemented Bram Moolenaar <Bram@vim.org> parents: 16871 diff changeset	844 endif
998603a243d7 patch 8.1.1441: popup window filter not yet implemented Bram Moolenaar <Bram@vim.org> parents: 16871 diff changeset	845 return 0
17036 235cbf491430 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17026 diff changeset	846 endfunc
17946 ec4248c4b92c patch 8.1.1969: popup window filter is used in all modes Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	847 < popup-filter-mode
ec4248c4b92c patch 8.1.1969: popup window filter is used in all modes Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	848 The "filtermode" property can be used to specify in what mode the filter is
ec4248c4b92c patch 8.1.1969: popup window filter is used in all modes Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	849 invoked. The default is "a": all modes. When using "nvi" Command-line mode
ec4248c4b92c patch 8.1.1969: popup window filter is used in all modes Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	850 is not included, so that any command typed on the command line is not
ec4248c4b92c patch 8.1.1969: popup window filter is used in all modes Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	851 filtered. However, to get to Command-line mode the filter must not consume
ec4248c4b92c patch 8.1.1969: popup window filter is used in all modes Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	852 ":". Just like it must not consume "v" to allow for entering Visual mode.
ec4248c4b92c patch 8.1.1969: popup window filter is used in all modes Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	853
ec4248c4b92c patch 8.1.1969: popup window filter is used in all modes Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	854 popup-mapping
17604 506dd2efcbb2 patch 8.1.1799: cannot avoid mapping for a popup window Bram Moolenaar <Bram@vim.org> parents: 17580 diff changeset	855 Normally the key is what results after any mapping, since the keys pass on as
506dd2efcbb2 patch 8.1.1799: cannot avoid mapping for a popup window Bram Moolenaar <Bram@vim.org> parents: 17580 diff changeset	856 normal input if the filter does not use it. If the filter consumes all the
506dd2efcbb2 patch 8.1.1799: cannot avoid mapping for a popup window Bram Moolenaar <Bram@vim.org> parents: 17580 diff changeset	857 keys, set the "mapping" property to zero so that mappings do not get in the
506dd2efcbb2 patch 8.1.1799: cannot avoid mapping for a popup window Bram Moolenaar <Bram@vim.org> parents: 17580 diff changeset	858 way. This is default for \|popup_menu()\| and \|popup_dialog()\|.
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	859
17946 ec4248c4b92c patch 8.1.1969: popup window filter is used in all modes Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	860 Some recommended key actions:
16880 998603a243d7 patch 8.1.1441: popup window filter not yet implemented Bram Moolenaar <Bram@vim.org> parents: 16871 diff changeset	861 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	862 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	863 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	864
18623 3089b422b9dc patch 8.1.2304: cannot get the mouse position when getting a mouse click Bram Moolenaar <Bram@vim.org> parents: 18615 diff changeset	865 A mouse click arrives as <LeftMouse>. The coordinates can be obtained with
18639 cb3163d590a1 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18623 diff changeset	866 \|getmousepos()\|.
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	867
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	868 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	869 \|popup_filter_yesno()\|.
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	870
16880 998603a243d7 patch 8.1.1441: popup window filter not yet implemented Bram Moolenaar <Bram@vim.org> parents: 16871 diff changeset	871 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	872 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	873 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	874 '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	875
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	876
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	877 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	878
17097 94007c802045 patch 8.1.1548: popup_dialog() is not implemented Bram Moolenaar <Bram@vim.org> parents: 17077 diff changeset	879 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	880
5131023c5728 patch 8.1.1446: popup window callback not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16888 diff changeset	881 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	882 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	883 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	884
17097 94007c802045 patch 8.1.1548: popup_dialog() is not implemented Bram Moolenaar <Bram@vim.org> parents: 17077 diff changeset	885 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	886 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	887
17604 506dd2efcbb2 patch 8.1.1799: cannot avoid mapping for a popup window Bram Moolenaar <Bram@vim.org> parents: 17580 diff changeset	888 Example: >
506dd2efcbb2 patch 8.1.1799: cannot avoid mapping for a popup window Bram Moolenaar <Bram@vim.org> parents: 17580 diff changeset	889 func SelectedColor(id, result)
506dd2efcbb2 patch 8.1.1799: cannot avoid mapping for a popup window Bram Moolenaar <Bram@vim.org> parents: 17580 diff changeset	890 echo 'choice made: ' .. a:result
506dd2efcbb2 patch 8.1.1799: cannot avoid mapping for a popup window Bram Moolenaar <Bram@vim.org> parents: 17580 diff changeset	891 endfunc
506dd2efcbb2 patch 8.1.1799: cannot avoid mapping for a popup window Bram Moolenaar <Bram@vim.org> parents: 17580 diff changeset	892
17162 f16cee6adf29 patch 8.1.1580: cannot make part of a popup transparent Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	893
17216 11f3cf51d43b patch 8.1.1608: the evalfunc.c file is too big Bram Moolenaar <Bram@vim.org> parents: 17196 diff changeset	894 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	895
11f3cf51d43b patch 8.1.1608: the evalfunc.c file is too big Bram Moolenaar <Bram@vim.org> parents: 17196 diff changeset	896 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	897 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	898 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	899 is on the popup, will cause the text to scroll up or down as you would expect.
17433 ca8e754bdd53 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17429 diff changeset	900 A click in the upper half of the scrollbar will scroll the text down one line.
ca8e754bdd53 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17429 diff changeset	901 A click in the lower half will scroll the text up one line. However, this is
ca8e754bdd53 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17429 diff changeset	902 limited so that the popup does not get smaller.
17216 11f3cf51d43b patch 8.1.1608: the evalfunc.c file is too big Bram Moolenaar <Bram@vim.org> parents: 17196 diff changeset	903
11f3cf51d43b patch 8.1.1608: the evalfunc.c file is too big Bram Moolenaar <Bram@vim.org> parents: 17196 diff changeset	904
17162 f16cee6adf29 patch 8.1.1580: cannot make part of a popup transparent Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	905 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	906
f16cee6adf29 patch 8.1.1580: cannot make part of a popup transparent Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	907 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	908 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	909 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	910 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	911 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	912 rightmost
f16cee6adf29 patch 8.1.1580: cannot make part of a popup transparent Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	913 endcol last column, like "col"
17429 6e756ad5ef1a patch 8.1.1713: highlighting cursor line only works with popup_menu() Bram Moolenaar <Bram@vim.org> parents: 17413 diff changeset	914 line start line, positive for counting from the top, 1 for top,
17162 f16cee6adf29 patch 8.1.1580: cannot make part of a popup transparent Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	915 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	916 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	917
f16cee6adf29 patch 8.1.1580: cannot make part of a popup transparent Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	918 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	919 [[-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	920
f16cee6adf29 patch 8.1.1580: cannot make part of a popup transparent Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	921 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	922 [[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	923
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	924 ==============================================================================
17257 cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	925 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	926
17257 cb0ca75f0c26 patch 8.1.1628: popup window functions not in list of functions Bram Moolenaar <Bram@vim.org> parents: 17225 diff changeset	927 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	928 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	929 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	930
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	931 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	932 if a:result
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	933 " ... '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	934 endif
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	935 endfunc
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	936
17413 40417757dffd patch 8.1.1705: using ~{} for a literal dict is not nice Bram Moolenaar <Bram@vim.org> parents: 17387 diff changeset	937 call popup_dialog('Continue? y/n', #{
17372 b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	938 \ filter: 'popup_filter_yesno',
b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	939 \ callback: 'MyDialogHandler',
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	940 \ })
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	941 <
17149 c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	942 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	943 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	944
17413 40417757dffd patch 8.1.1705: using ~{} for a literal dict is not nice Bram Moolenaar <Bram@vim.org> parents: 17387 diff changeset	945 call popup_menu(['Save', 'Cancel', 'Discard'], #{
17372 b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	946 \ filter: 'MyMenuFilter',
b9bc47742df6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17348 diff changeset	947 \ callback: 'MyMenuHandler',
17149 c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	948 \ })
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	949
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	950 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	951 " Handle shortcuts
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	952 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	953 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	954 return 1
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	955 endif
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	956 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	957 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	958 return 1
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	959 endif
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	960 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	961 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	962 return 1
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	963 endif
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	964
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	965 " 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	966 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	967 endfunc
c90fdb999393 patch 8.1.1574: tabpage option not yet implemented for popup window Bram Moolenaar <Bram@vim.org> parents: 17123 diff changeset	968 <
17292 8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	969 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	970 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	971
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	972 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	973 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	974 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	975 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	976
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	977 func BalloonExpr()
17320 33dccaafb214 patch 8.1.1659: popup window "mousemoved" values not correct Bram Moolenaar <Bram@vim.org> parents: 17292 diff changeset	978 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	979 " 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	980 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	981 " 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	982 return ''
33dccaafb214 patch 8.1.1659: popup window "mousemoved" values not correct Bram Moolenaar <Bram@vim.org> parents: 17292 diff changeset	983 endif
17292 8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	984 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	985 endif
17413 40417757dffd patch 8.1.1705: using ~{} for a literal dict is not nice Bram Moolenaar <Bram@vim.org> parents: 17387 diff changeset	986 let s:winid = popup_beval(v:beval_text, #{mousemoved: 'word'})
17320 33dccaafb214 patch 8.1.1659: popup window "mousemoved" values not correct Bram Moolenaar <Bram@vim.org> parents: 17292 diff changeset	987 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	988 return ''
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	989 endfunc
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	990 <
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	991 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	992 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	993 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	994
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	995 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	996 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	997 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	998 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	999
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	1000 func BalloonExpr()
17320 33dccaafb214 patch 8.1.1659: popup window "mousemoved" values not correct Bram Moolenaar <Bram@vim.org> parents: 17292 diff changeset	1001 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	1002 " 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	1003 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	1004 " 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	1005 return ''
33dccaafb214 patch 8.1.1659: popup window "mousemoved" values not correct Bram Moolenaar <Bram@vim.org> parents: 17292 diff changeset	1006 endif
17292 8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	1007 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	1008 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	1009 endif
17946 ec4248c4b92c patch 8.1.1969: popup window filter is used in all modes Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	1010 " simulate an asynchronous lookup 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	1011 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	1012 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	1013 return ''
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	1014 endfunc
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	1015
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	1016 func ShowPopup(id)
17413 40417757dffd patch 8.1.1705: using ~{} for a literal dict is not nice Bram Moolenaar <Bram@vim.org> parents: 17387 diff changeset	1017 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	1018 endfunc
8a095d343c59 patch 8.1.1645: cannot use a popup window for a balloon Bram Moolenaar <Bram@vim.org> parents: 17257 diff changeset	1019 <
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	1020
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	1021 vim:tw=78:ts=8:noet:ft=help:norl:

Mercurial > vim

annotate runtime/doc/popup.txt @ 18750:82a28df1e2d5