vim: runtime/doc/popup.txt annotate

annotate runtime/doc/popup.txt @ 16855:19162ff4eacd v8.1.1429

patch 8.1.1429: "pos" option of popup window not supported yet commit https://github.com/vim/vim/commit/ac1f1bc222b7de3cb2d3f1f2aa076f11c75e69de Author: Bram Moolenaar <Bram@vim.org> Date: Thu May 30 21:24:26 2019 +0200 patch 8.1.1429: "pos" option of popup window not supported yet Problem: "pos" option of popup window not supported yet. Solution: Implement the option. Rename popup_getposition() to popup_getpos().

author	Bram Moolenaar <Bram@vim.org>
date	Thu, 30 May 2019 21:30:04 +0200
parents	e6bcccccbf7b
children	0154363d3b98

rev	line source
16808 c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16806 diff changeset	1 popup.txt For Vim version 8.1. Last change: 2019 May 26
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
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	7 Displaying text in floating window. popup popup-window
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	8
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	9 THIS IS UNDER DESIGN - ANYTHING MAY STILL CHANGE
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	10
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	11 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	12 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	13 3. Examples \|popup-examples\|
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	14
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	15
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	16 {not available if the \|+eval\| feature was disabled at compile time}
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	17 {not able to use text properties if the \|+textprop\| feature was disabled at
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	18 compile time}
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	19
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	20 ==============================================================================
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	21 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	22
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	23 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	24 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	25 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	26
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	27 A popup window can be used for such things as:
16808 c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16806 diff changeset	28 - 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	29 - 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	30 - 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	31 - 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	32
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	33 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	34 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	35
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	36 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	37 "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	38 hi MyPopupColor ctermbg=lightblue guibg=lightblue
eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	39 call setwinvar(winid, '&wincolor', 'MyPopupColor')
eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	40
eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	41 'hlsearch' and match highlighting are not displayed in a popup window.
eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	42
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	43 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	44 The size can be up to the whole Vim window and it overlaps other windows.
16808 c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16806 diff changeset	45 Popup windows can also overlap each other.
c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16806 diff changeset	46
c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16806 diff changeset	47 The popup window contains a buffer, and that buffer is always associated with
c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16806 diff changeset	48 the popup window. The window cannot be used in Normal, Visual or Insert mode,
c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16806 diff changeset	49 it does not get keyboard focus. You can use functions like `setbufline()` to
c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16806 diff changeset	50 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	51 window and buffer behave compared to regular windows and buffers, see
c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16806 diff changeset	52 \|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	53
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	54 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	55 - 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	56 - 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	57
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	58
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	59 WINDOW POSITION AND SIZE popup-position
eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	60
16808 c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16806 diff changeset	61 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	62 wrapping, lines in the buffer. It can be limited with the "maxheight"
c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16806 diff changeset	63 property. You can use empty lines to increase the height.
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	64
eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	65 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	66 It can be limited with the "maxwidth" property. You can use spaces to
eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	67 increase the width.
eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	68
eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	69 By default the 'wrap' option is set, so that no text disappears. However, if
eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	70 there is not enough space, some text may be invisible.
eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	71
eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	72
16833 6699c03347d2 patch 8.1.1418: win_execute() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16829 diff changeset	73
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	74 TODO:
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	75
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	76 Example how to use syntax highlighting of a code snippet.
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	77
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	78 Scrolling: When the screen scrolls up for output of an Ex command, what
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	79 happens with popups?
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	80 1. Stay where they are. Problem: listed text may go behind and can't be read.
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	81 2. Scroll with the page. What if they get updated? Either postpone, or take
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	82 the scroll offset into account.
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	83 Probably 2. is the best choice.
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	84
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	85
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	86 IMPLEMENTATION:
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	87 - Code is in popupwin.c
16853 e6bcccccbf7b patch 8.1.1428: popup_atcursor() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16841 diff changeset	88 - Implement the "pos" option.
16808 c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16806 diff changeset	89 - Implement filter.
16829 5cebaecad422 patch 8.1.1416: popup_getposition() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16817 diff changeset	90 Check that popup_close() works in the filter.
16808 c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16806 diff changeset	91 - Handle screen resize in screenalloc().
16853 e6bcccccbf7b patch 8.1.1428: popup_atcursor() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16841 diff changeset	92 - show [Popup] instead of [Scratch] in ":ls!"
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	93 - Make redrawing more efficient and avoid flicker.
16841 cf630fab9fb6 patch 8.1.1422: popup_getoptions() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16833 diff changeset	94 Store popup info in a mask, use the mask in screen_line()
16829 5cebaecad422 patch 8.1.1416: popup_getposition() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16817 diff changeset	95 Fix redrawing problem with completion.
5cebaecad422 patch 8.1.1416: popup_getposition() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16817 diff changeset	96 Fix redrawing problem when scrolling non-current window
5cebaecad422 patch 8.1.1416: popup_getposition() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16817 diff changeset	97 Fix redrawing the statusline on top of a popup
16841 cf630fab9fb6 patch 8.1.1422: popup_getoptions() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16833 diff changeset	98 - Figure out the size and position better.
cf630fab9fb6 patch 8.1.1422: popup_getoptions() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16833 diff changeset	99 if wrapping splits a double-wide character
16853 e6bcccccbf7b patch 8.1.1428: popup_atcursor() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16841 diff changeset	100 if wrapping inserts indent
16829 5cebaecad422 patch 8.1.1416: popup_getposition() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16817 diff changeset	101 - Can the buffer be re-used, to avoid using up lots of buffer numbers?
16808 c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16806 diff changeset	102 - Implement all the unimplemented options and features.
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	103
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	104
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	105 ==============================================================================
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	106 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	107
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	108 THIS IS UNDER DESIGN - ANYTHING MAY STILL CHANGE
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	109
16808 c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16806 diff changeset	110 [functions to be moved to eval.txt later, keep overview of functions here]
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	111
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	112 popup_create({text}, {options}) popup_create()
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	113 Open a popup window showing {text}, which is either:
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	114 - a string
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	115 - 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	116 - a list of text lines with text properties
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	117 {not implemented yet}
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	118 {options} is a dictionary with many possible entries.
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	119 See \|popup_create-usage\| for details.
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	120
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	121 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	122 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	123 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	124 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	125 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	126 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	127 < 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	128
eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	129
eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	130 popup_close({id}) popup_close()
eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	131 Close popup {id}. The window and the associated buffer will
eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	132 be deleted.
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	133
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	134
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	135 popup_dialog({text}, {options}) popup_dialog()
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	136 {not implemented yet}
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	137 Just like \|popup_create()\| but with these default options: >
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	138 call popup_create({text}, {
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	139 \ 'pos': 'center',
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	140 \ 'zindex': 200,
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	141 \ 'border': [],
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	142 \})
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	143 < Use {options} to change the properties.
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	144
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	145
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	146 popup_notification({text}, {options}) popup_notification()
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	147 {not implemented yet}
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	148 Show the {text} for 3 seconds at the top of the Vim window.
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	149 This works like: >
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	150 call popup_create({text}, {
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	151 \ 'line': 1,
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	152 \ 'col': 10,
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	153 \ 'time': 3000,
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	154 \ 'tab': -1,
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	155 \ 'zindex': 200,
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	156 \ 'highlight': 'WarningMsg',
16800 12e3a3afdb6a patch 8.1.1402: "timer" option of popup windows not supported Bram Moolenaar <Bram@vim.org> parents: 16778 diff changeset	157 \ 'border': [],
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	158 \ })
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	159 < Use {options} to change the properties.
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	160
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	161
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	162 popup_atcursor({text}, {options}) popup_atcursor()
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	163 Show the {text} above the cursor, and close it when the cursor
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	164 moves. This works like: >
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	165 call popup_create({text}, {
16853 e6bcccccbf7b patch 8.1.1428: popup_atcursor() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16841 diff changeset	166 \ 'pos': 'botleft',
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	167 \ 'line': 'cursor-1',
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	168 \ 'col': 'cursor',
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	169 \ 'moved': 'WORD',
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	170 \ })
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	171 < Use {options} to change the properties.
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	172
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	173
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	174 popup_menu({text}, {options}) popup_menu()
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	175 {not implemented yet}
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	176 Show the {text} near the cursor, handle selecting one of the
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	177 items with cursorkeys, and close it an item is selected with
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	178 Space or Enter. {text} should have multiple lines to make this
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	179 useful. This works like: >
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	180 call popup_create({text}, {
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	181 \ 'pos': 'center',
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	182 \ 'zindex': 200,
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	183 \ 'wrap': 0,
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	184 \ 'border': [],
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	185 \ 'filter': 'popup_filter_menu',
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	186 \ })
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	187 < Use {options} to change the properties. Should at least set
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	188 "callback" to a function that handles the selected item.
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	189
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	190
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	191 popup_hide({id}) popup_hide()
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	192 If {id} is a displayed popup, hide it now. If the popup has a
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	193 filter it will not be invoked for so long as the popup is
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	194 hidden.
16809 5ff14f96f1c9 patch 8.1.1406: popup_hide() and popup_show() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16808 diff changeset	195 If window {id} does not exist nothing happens. If window {id}
5ff14f96f1c9 patch 8.1.1406: popup_hide() and popup_show() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16808 diff changeset	196 exists but is not a popup window an error is given. E993
5ff14f96f1c9 patch 8.1.1406: popup_hide() and popup_show() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16808 diff changeset	197
5ff14f96f1c9 patch 8.1.1406: popup_hide() and popup_show() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16808 diff changeset	198 popup_show({id}) popup_show()
5ff14f96f1c9 patch 8.1.1406: popup_hide() and popup_show() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16808 diff changeset	199 If {id} is a hidden popup, show it now.
5ff14f96f1c9 patch 8.1.1406: popup_hide() and popup_show() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16808 diff changeset	200 For {id} see `popup_hide()`.
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	201
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	202 popup_move({id}, {options}) popup_move()
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	203 Move popup {id} to the position speficied with {options}.
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	204 {options} may contain the items from \|popup_create()\| that
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	205 specify the popup position: "line", "col", "pos", "maxheight",
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	206 "minheight", "maxwidth" and "minwidth".
16809 5ff14f96f1c9 patch 8.1.1406: popup_hide() and popup_show() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16808 diff changeset	207 For {id} see `popup_hide()`.
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	208
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	209
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	210 popup_filter_menu({id}, {key}) popup_filter_menu()
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	211 {not implemented yet}
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	212 Filter that can be used for a popup. It handles the cursor
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	213 keys to move the selected index in the popup. Space and Enter
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	214 can be used to select an item. 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	215 popup menu with the index of the selected line as the second
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	216 argument.
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	217
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	218
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	219 popup_filter_yesno({id}, {key}) popup_filter_yesno()
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	220 {not implemented yet}
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	221 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	222 '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	223 popup menu with the 1 for 'y' or 'Y' and zero for 'n' or 'N'
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	224 as the second argument. Pressing Esc and CTRL-C works like
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	225 pressing 'n'.
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	226
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	227
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	228 popup_setoptions({id}, {options}) popup_setoptions()
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	229 {not implemented yet}
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	230 Override options in popup {id} with entries in {options}.
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	231
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	232
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	233 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	234 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	235 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	236 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	237
cf630fab9fb6 patch 8.1.1422: popup_getoptions() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16833 diff changeset	238 The "highlight" entry is omitted, use the 'wincolor' option
cf630fab9fb6 patch 8.1.1422: popup_getoptions() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16833 diff changeset	239 for that: >
cf630fab9fb6 patch 8.1.1422: popup_getoptions() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16833 diff changeset	240 let hl = getwinvar(winid, '&wincolor')
cf630fab9fb6 patch 8.1.1422: popup_getoptions() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16833 diff changeset	241
cf630fab9fb6 patch 8.1.1422: popup_getoptions() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16833 diff changeset	242 < 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	243
16855 19162ff4eacd patch 8.1.1429: "pos" option of popup window not supported yet Bram Moolenaar <Bram@vim.org> parents: 16853 diff changeset	244 popup_getpos({id}) popup_getpos()
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	245 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	246 with these entries:
16841 cf630fab9fb6 patch 8.1.1422: popup_getoptions() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16833 diff changeset	247 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	248 line screen line of the popup, one-based
cf630fab9fb6 patch 8.1.1422: popup_getoptions() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16833 diff changeset	249 width width of the popup in screen cells
cf630fab9fb6 patch 8.1.1422: popup_getoptions() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16833 diff changeset	250 height height of the popup in screen cells
cf630fab9fb6 patch 8.1.1422: popup_getoptions() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16833 diff changeset	251 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	252 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	253 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	254 positioning mechanism applied.
5cebaecad422 patch 8.1.1416: popup_getposition() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16817 diff changeset	255 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	256
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	257
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	258 :popupclear :popupc
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	259 :popupc[lear] Emergency solution to a misbehaving plugin: close all popup
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	260 windows.
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	261
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	262
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	263 POPUP BUFFER AND WINDOW popup-buffer
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	264
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	265 A new buffer is created to hold the text and text properties of the popup
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	266 window. The buffer is always associated with the popup window and
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	267 manipulation is restricted:
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	268 - the buffer has no name
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	269 - 'buftype' is "popup"
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	270 - 'swapfile' is off
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	271 - 'bufhidden' is "hide"
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	272 - 'buflisted' is off
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	273 - 'undolevels' is -1: no undo at all
16853 e6bcccccbf7b patch 8.1.1428: popup_atcursor() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16841 diff changeset	274 - all other buffer-local and window_local options are set to their Vim default
e6bcccccbf7b patch 8.1.1428: popup_atcursor() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16841 diff changeset	275 value.
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	276
16853 e6bcccccbf7b patch 8.1.1428: popup_atcursor() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16841 diff changeset	277 It is possible to change the specifically mentioned options, but anything
e6bcccccbf7b patch 8.1.1428: popup_atcursor() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16841 diff changeset	278 might break then, so better leave them alone.
16808 c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16806 diff changeset	279
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	280 The window does have a cursor position, but the cursor is not displayed.
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	281
16833 6699c03347d2 patch 8.1.1418: win_execute() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16829 diff changeset	282 To execute a command in the context of the popup window and buffer use
6699c03347d2 patch 8.1.1418: win_execute() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16829 diff changeset	283 `win_execute()`. Example: >
6699c03347d2 patch 8.1.1418: win_execute() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16829 diff changeset	284 call win_execute(winid, 'syntax enable')
6699c03347d2 patch 8.1.1418: win_execute() is not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16829 diff changeset	285
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	286 Options can be set on the window with `setwinvar()`, e.g.: >
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	287 call setwinvar(winid, '&wrap', 0)
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	288 And options can be set on the buffer with `setbufvar()`, e.g.: >
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	289 call setbufvar(winbufnr(winid), '&filetype', 'java')
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	290
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	291
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	292 POPUP_CREATE() ARGUMENTS popup_create-usage
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	293
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	294 The first argument of \|popup_create()\| specifies the text to be displayed, and
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	295 optionally text properties. It is in one of three forms:
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	296 - a string
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	297 - 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	298 - 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	299 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	300 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	301 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	302 \|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	303 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	304 \|popup-props\|.
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	305
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	306 The second argument of \|popup_create()\| is a dictionary with options:
16855 19162ff4eacd patch 8.1.1429: "pos" option of popup window not supported yet Bram Moolenaar <Bram@vim.org> parents: 16853 diff changeset	307 line screen line where to position the popup; can use a
19162ff4eacd patch 8.1.1429: "pos" option of popup window not supported yet Bram Moolenaar <Bram@vim.org> parents: 16853 diff changeset	308 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	309 the line of the cursor and add or subtract a number of
19162ff4eacd patch 8.1.1429: "pos" option of popup window not supported yet Bram Moolenaar <Bram@vim.org> parents: 16853 diff changeset	310 lines; if omitted the popup is vertically centered,
19162ff4eacd patch 8.1.1429: "pos" option of popup window not supported yet Bram Moolenaar <Bram@vim.org> parents: 16853 diff changeset	311 otherwise "pos" is used.
19162ff4eacd patch 8.1.1429: "pos" option of popup window not supported yet Bram Moolenaar <Bram@vim.org> parents: 16853 diff changeset	312 col screen column where to position the popup; can use a
19162ff4eacd patch 8.1.1429: "pos" option of popup window not supported yet Bram Moolenaar <Bram@vim.org> parents: 16853 diff changeset	313 number or "cursor" to use the column of the cursor,
19162ff4eacd patch 8.1.1429: "pos" option of popup window not supported yet Bram Moolenaar <Bram@vim.org> parents: 16853 diff changeset	314 "cursor+99" and "cursor-99" to add or subtract a
19162ff4eacd patch 8.1.1429: "pos" option of popup window not supported yet Bram Moolenaar <Bram@vim.org> parents: 16853 diff changeset	315 number of columns; if omitted the popup is
19162ff4eacd patch 8.1.1429: "pos" option of popup window not supported yet Bram Moolenaar <Bram@vim.org> parents: 16853 diff changeset	316 horizontally centered, otherwise "pos" is used
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	317 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	318 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	319 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	320 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	321 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	322 "line" and "col" are ignored.
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	323 {not implemented yet}
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	324 flip when TRUE (the default) and the position is relative
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	325 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	326 avoid overlap with the \|popupmenu-completion\| or
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	327 another popup with a higher "zindex"
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	328 {not implemented yet}
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	329 maxheight maximum height
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	330 minheight minimum height
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	331 maxwidth maximum width
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	332 minwidth minimum width
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	333 hidden when TRUE the popup exists but is not displayed; use
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	334 `popup_show()` to unhide it.
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	335 {not implemented yet}
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	336 tab when -1: display the popup on all tabs; when 0 (the
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	337 default): display the popup on the current tab;
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	338 otherwise the number of the tab page the popup is
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	339 displayed on; when invalid the current tab is used
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	340 {only -1 and 0 are implemented}
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	341 title text to be displayed above the first item in the
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	342 popup, on top of any border
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	343 {not implemented yet}
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	344 wrap TRUE to make the lines wrap (default TRUE)
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	345 {not implemented yet}
eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	346 highlight highlight group name to use for the text, stored in
16806 306766ed0f70 patch 8.1.1405: "highlight" option of popup windows not supported Bram Moolenaar <Bram@vim.org> parents: 16800 diff changeset	347 the 'wincolor' option
16853 e6bcccccbf7b patch 8.1.1428: popup_atcursor() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16841 diff changeset	348 padding list with numbers, defining the padding
e6bcccccbf7b patch 8.1.1428: popup_atcursor() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16841 diff changeset	349 above/right/below/left of the popup (similar to CSS);
e6bcccccbf7b patch 8.1.1428: popup_atcursor() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16841 diff changeset	350 an empty list uses a padding of 1 all around; the
e6bcccccbf7b patch 8.1.1428: popup_atcursor() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16841 diff changeset	351 padding goes around the text, inside any border;
e6bcccccbf7b patch 8.1.1428: popup_atcursor() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16841 diff changeset	352 padding uses the 'wincolor' highlight; Example: [1, 2,
e6bcccccbf7b patch 8.1.1428: popup_atcursor() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16841 diff changeset	353 1, 3] has 1 line of padding above, 2 columns on the
e6bcccccbf7b patch 8.1.1428: popup_atcursor() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16841 diff changeset	354 right, 1 line below and 3 columns on the left
e6bcccccbf7b patch 8.1.1428: popup_atcursor() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16841 diff changeset	355 {not implemented yet}
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	356 border list with numbers, defining the border thickness
16853 e6bcccccbf7b patch 8.1.1428: popup_atcursor() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16841 diff changeset	357 above/right/below/left of the popup (similar to CSS);
e6bcccccbf7b patch 8.1.1428: popup_atcursor() not implemented yet Bram Moolenaar <Bram@vim.org> parents: 16841 diff changeset	358 an empty list uses a border of 1 all around
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	359 {not implemented yet}
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	360 borderhighlight highlight group name to use for the border
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	361 {not implemented yet}
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	362 borderchars list with characters, defining the character to use
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	363 for the top/right/bottom/left border; optionally
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	364 followed by the character to use for the
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	365 topright/botright/botleft/topleft corner; an empty
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	366 list can be used to show a double line all around
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	367 {not implemented yet}
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	368 zindex priority for the popup, default 50
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	369 time time in milliseconds after which the popup will close;
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	370 when omitted \|popup_close()\| must be used.
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	371 moved "cell": close the popup if the cursor moved at least
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	372 one screen cell; "word" allows for moving within
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	373 \|<cword>\|, "WORD" allows for moving within \|<cWORD>\|,
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	374 a list with two numbers specifies the start and end
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	375 column
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	376 {not implemented yet}
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	377 filter a callback that can filter typed characters, see
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	378 \|popup-filter\|
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	379 {not implemented yet}
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	380 callback a callback to be used when the popup closes, e.g. when
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	381 using \|popup_filter_menu()\|, see \|popup-callback\|.
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	382 {not implemented yet}
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	383
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	384 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	385 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	386 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	387
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	388 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	389 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	390 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	391
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	392
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	393 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	394
16811 0457d49eb2d9 patch 8.1.1407: popup_create() does not support text properties Bram Moolenaar <Bram@vim.org> parents: 16809 diff changeset	395 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	396 - "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	397 - "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	398 - "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	399 - "transparent" is extra
0457d49eb2d9 patch 8.1.1407: popup_create() does not support text properties Bram Moolenaar <Bram@vim.org> parents: 16809 diff changeset	400 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	401 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	402 first column.
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	403 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	404 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	405 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	406 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	407 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	408 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	409 used
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	410 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	411 \|prop_type_add()\|
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	412 transparent do not show these characters, show the text under it;
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	413 if there is an border character to the right or below
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	414 it will be made transparent as well
16811 0457d49eb2d9 patch 8.1.1407: popup_create() does not support text properties Bram Moolenaar <Bram@vim.org> parents: 16809 diff changeset	415 {not implemented yet}
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	416
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	417
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	418 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	419
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	420 {not implemented yet}
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	421 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	422 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	423
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	424 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	425 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	426 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	427 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	428 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	429
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	430 The filter function is called with two arguments: the ID of the popup and the
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	431 key.
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	432
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	433 Some common key actions:
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	434 Esc close the popup
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	435 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	436 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	437
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	438 A mouse click arrives as <LeftMouse>. The coordinates are in
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	439 v:mouse_popup_col and v:mouse_popup_row. The top-left screen cell of the
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	440 popup is col 1, row 1 (not counting the border).
6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	441
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	442 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	443 \|popup_filter_yesno()\|.
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	444
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	445
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	446 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	447
16778 eda4d65f232c patch 8.1.1391: no popup window support Bram Moolenaar <Bram@vim.org> parents: 16724 diff changeset	448 {not implemented yet}
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	449 A callback that is invoked when the popup closes. Used by
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	450 \|popup_filter_menu()\|. Invoked with two arguments: the ID of the popup and
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	451 the result, which would usually be an index in the popup lines, or whatever
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	452 the filter wants to pass.
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	453
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	454 ==============================================================================
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	455 3. Examples popup-examples
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	456
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	457 TODO
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	458
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	459 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	460
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	461 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	462 if a:result
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	463 " ... '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	464 endif
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	465 endfunc
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	466
16724 6030631a1541 patch 8.1.1364: design for popup window support needs more details Bram Moolenaar <Bram@vim.org> parents: 16654 diff changeset	467 call popup_create(['Continue? y/n'], {
16654 7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	468 \ 'filter': 'popup_filter_yesno',
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	469 \ 'callback': 'MyDialogHandler',
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	470 \ })
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	471 <
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	472
7d54a66c95d7 patch 8.1.1329: plans for popup window support are spread out Bram Moolenaar <Bram@vim.org> parents: diff changeset	473 vim:tw=78:ts=8:noet:ft=help:norl:

Mercurial > vim

annotate runtime/doc/popup.txt @ 16855:19162ff4eacd v8.1.1429