blob: bbab6d03da0f532edf2e4ec1135f501e9cdd60c8 [file] [log] [blame]
Bram Moolenaar68e65602019-05-26 21:33:31 +02001*popup.txt* For Vim version 8.1. Last change: 2019 May 26
Bram Moolenaar957f85d2019-05-12 21:43:48 +02002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
Bram Moolenaar5c017b22019-05-21 23:09:01 +02007Displaying text in floating window. *popup* *popup-window*
Bram Moolenaar957f85d2019-05-12 21:43:48 +02008
9THIS IS UNDER DESIGN - ANYTHING MAY STILL CHANGE
10
111. Introduction |popup-intro|
122. Functions |popup-functions|
133. Examples |popup-examples|
14
15
Bram Moolenaar5c017b22019-05-21 23:09:01 +020016{not available if the |+eval| feature was disabled at compile time}
17{not able to use text properties if the |+textprop| feature was disabled at
18compile time}
Bram Moolenaar957f85d2019-05-12 21:43:48 +020019
20==============================================================================
211. Introduction *popup-intro*
22
Bram Moolenaar5c017b22019-05-21 23:09:01 +020023We are talking about popup windows here, text that goes on top of the regular
24windows and is under control of a plugin. You cannot edit the text in the
25popup window like with regular windows.
26
27A popup window can be used for such things as:
Bram Moolenaar68e65602019-05-26 21:33:31 +020028- briefly show a message without overwriting the command line
Bram Moolenaar5c017b22019-05-21 23:09:01 +020029- prompt the user with a dialog
Bram Moolenaar4d784b22019-05-25 19:51:39 +020030- display contextual information while typing
Bram Moolenaar5c017b22019-05-21 23:09:01 +020031- give extra information for auto-completion
32
33The text in the popup window can be colored with |text-properties|. It is
34also possible to use syntax highlighting.
35
Bram Moolenaar4d784b22019-05-25 19:51:39 +020036The default color used is "Pmenu". If you prefer something else use the
37"highlight" argument or the 'wincolor' option, e.g.: >
38 hi MyPopupColor ctermbg=lightblue guibg=lightblue
39 call setwinvar(winid, '&wincolor', 'MyPopupColor')
40
41'hlsearch' and match highlighting are not displayed in a popup window.
42
Bram Moolenaar5c017b22019-05-21 23:09:01 +020043A popup window has a window-ID like other windows, but behaves differently.
44The size can be up to the whole Vim window and it overlaps other windows.
Bram Moolenaar68e65602019-05-26 21:33:31 +020045Popup windows can also overlap each other.
46
47The popup window contains a buffer, and that buffer is always associated with
48the popup window. The window cannot be used in Normal, Visual or Insert mode,
49it does not get keyboard focus. You can use functions like `setbufline()` to
50change the text in the buffer. There are more differences from how this
51window and buffer behave compared to regular windows and buffers, see
52|popup-buffer|.
Bram Moolenaar5c017b22019-05-21 23:09:01 +020053
54If this is not what you are looking for, check out other popup functionality:
Bram Moolenaar957f85d2019-05-12 21:43:48 +020055- popup menu, see |popup-menu|
56- balloon, see |balloon-eval|
57
Bram Moolenaar5c017b22019-05-21 23:09:01 +020058
Bram Moolenaar4d784b22019-05-25 19:51:39 +020059WINDOW POSITION AND SIZE *popup-position*
60
Bram Moolenaar68e65602019-05-26 21:33:31 +020061The height of the window is normally equal to the number of, possibly
62wrapping, lines in the buffer. It can be limited with the "maxheight"
63property. You can use empty lines to increase the height.
Bram Moolenaar4d784b22019-05-25 19:51:39 +020064
65The width of the window is normally equal to the longest line in the buffer.
66It can be limited with the "maxwidth" property. You can use spaces to
67increase the width.
68
69By default the 'wrap' option is set, so that no text disappears. However, if
70there is not enough space, some text may be invisible.
71
72
Bram Moolenaar5c017b22019-05-21 23:09:01 +020073TODO:
74
75Example how to use syntax highlighting of a code snippet.
76
77Scrolling: When the screen scrolls up for output of an Ex command, what
78happens with popups?
791. Stay where they are. Problem: listed text may go behind and can't be read.
802. Scroll with the page. What if they get updated? Either postpone, or take
81 the scroll offset into account.
82Probably 2. is the best choice.
83
Bram Moolenaar5c017b22019-05-21 23:09:01 +020084
85IMPLEMENTATION:
Bram Moolenaar4d784b22019-05-25 19:51:39 +020086- Code is in popupwin.c
Bram Moolenaar68e65602019-05-26 21:33:31 +020087- Implement list of lines with text properties
Bram Moolenaar68e65602019-05-26 21:33:31 +020088- Implement filter.
89- Handle screen resize in screenalloc().
Bram Moolenaar4d784b22019-05-25 19:51:39 +020090- Make redrawing more efficient and avoid flicker.
Bram Moolenaar68e65602019-05-26 21:33:31 +020091- Properly figure out the size and position.
92- Implement all the unimplemented options and features.
Bram Moolenaar5c017b22019-05-21 23:09:01 +020093
Bram Moolenaar957f85d2019-05-12 21:43:48 +020094
95==============================================================================
962. Functions *popup-functions*
97
98THIS IS UNDER DESIGN - ANYTHING MAY STILL CHANGE
99
Bram Moolenaar68e65602019-05-26 21:33:31 +0200100[functions to be moved to eval.txt later, keep overview of functions here]
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200101
Bram Moolenaar5c017b22019-05-21 23:09:01 +0200102popup_create({text}, {options}) *popup_create()*
103 Open a popup window showing {text}, which is either:
104 - a string
105 - a list of strings
106 - a list of text lines with text properties
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200107 {not implemented yet}
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200108 {options} is a dictionary with many possible entries.
Bram Moolenaar5c017b22019-05-21 23:09:01 +0200109 See |popup_create-usage| for details.
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200110
Bram Moolenaar5c017b22019-05-21 23:09:01 +0200111 Returns a window-ID, which can be used with other popup
112 functions. Use `winbufnr()` to get the number of the buffer
113 in the window: >
114 let winid = popup_create('hello', {})
115 let bufnr = winbufnr(winid)
116 call setbufline(bufnr, 2, 'second line')
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200117< In case of failure zero is returned.
118
119
120popup_close({id}) *popup_close()*
121 Close popup {id}. The window and the associated buffer will
122 be deleted.
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200123
124
Bram Moolenaar5c017b22019-05-21 23:09:01 +0200125popup_dialog({text}, {options}) *popup_dialog()*
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200126 {not implemented yet}
Bram Moolenaar5c017b22019-05-21 23:09:01 +0200127 Just like |popup_create()| but with these default options: >
128 call popup_create({text}, {
129 \ 'pos': 'center',
130 \ 'zindex': 200,
131 \ 'border': [],
132 \})
133< Use {options} to change the properties.
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200134
135
136popup_notification({text}, {options}) *popup_notification()*
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200137 {not implemented yet}
Bram Moolenaar5c017b22019-05-21 23:09:01 +0200138 Show the {text} for 3 seconds at the top of the Vim window.
139 This works like: >
140 call popup_create({text}, {
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200141 \ 'line': 1,
142 \ 'col': 10,
143 \ 'time': 3000,
Bram Moolenaar5c017b22019-05-21 23:09:01 +0200144 \ 'tab': -1,
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200145 \ 'zindex': 200,
146 \ 'highlight': 'WarningMsg',
Bram Moolenaar51fe3b12019-05-26 20:10:06 +0200147 \ 'border': [],
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200148 \ })
149< Use {options} to change the properties.
150
Bram Moolenaar5c017b22019-05-21 23:09:01 +0200151
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200152popup_atcursor({text}, {options}) *popup_atcursor()*
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200153 {not implemented yet}
Bram Moolenaar5c017b22019-05-21 23:09:01 +0200154 Show the {text} above the cursor, and close it when the cursor
155 moves. This works like: >
156 call popup_create({text}, {
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200157 \ 'line': 'cursor-1',
158 \ 'col': 'cursor',
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200159 \ 'moved': 'WORD',
160 \ })
161< Use {options} to change the properties.
162
163
Bram Moolenaar5c017b22019-05-21 23:09:01 +0200164popup_menu({text}, {options}) *popup_menu()*
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200165 {not implemented yet}
Bram Moolenaar5c017b22019-05-21 23:09:01 +0200166 Show the {text} near the cursor, handle selecting one of the
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200167 items with cursorkeys, and close it an item is selected with
Bram Moolenaar5c017b22019-05-21 23:09:01 +0200168 Space or Enter. {text} should have multiple lines to make this
169 useful. This works like: >
170 call popup_create({text}, {
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200171 \ 'pos': 'center',
172 \ 'zindex': 200,
173 \ 'wrap': 0,
174 \ 'border': [],
175 \ 'filter': 'popup_filter_menu',
176 \ })
177< Use {options} to change the properties. Should at least set
178 "callback" to a function that handles the selected item.
179
180
Bram Moolenaar5c017b22019-05-21 23:09:01 +0200181popup_hide({id}) *popup_hide()*
182 If {id} is a displayed popup, hide it now. If the popup has a
183 filter it will not be invoked for so long as the popup is
184 hidden.
Bram Moolenaar2cd0dce2019-05-26 22:17:52 +0200185 If window {id} does not exist nothing happens. If window {id}
186 exists but is not a popup window an error is given. *E993*
187
188popup_show({id}) *popup_show()*
189 If {id} is a hidden popup, show it now.
190 For {id} see `popup_hide()`.
Bram Moolenaar5c017b22019-05-21 23:09:01 +0200191
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200192popup_move({id}, {options}) *popup_move()*
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200193 {not implemented yet}
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200194 Move popup {id} to the position speficied with {options}.
Bram Moolenaar5c017b22019-05-21 23:09:01 +0200195 {options} may contain the items from |popup_create()| that
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200196 specify the popup position: "line", "col", "pos", "maxheight",
197 "minheight", "maxwidth" and "minwidth".
Bram Moolenaar2cd0dce2019-05-26 22:17:52 +0200198 For {id} see `popup_hide()`.
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200199
200
201popup_filter_menu({id}, {key}) *popup_filter_menu()*
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200202 {not implemented yet}
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200203 Filter that can be used for a popup. It handles the cursor
204 keys to move the selected index in the popup. Space and Enter
205 can be used to select an item. Invokes the "callback" of the
206 popup menu with the index of the selected line as the second
207 argument.
208
209
210popup_filter_yesno({id}, {key}) *popup_filter_yesno()*
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200211 {not implemented yet}
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200212 Filter that can be used for a popup. It handles only the keys
213 'y', 'Y' and 'n' or 'N'. Invokes the "callback" of the
214 popup menu with the 1 for 'y' or 'Y' and zero for 'n' or 'N'
215 as the second argument. Pressing Esc and CTRL-C works like
216 pressing 'n'.
217
218
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200219popup_setoptions({id}, {options}) *popup_setoptions()*
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200220 {not implemented yet}
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200221 Override options in popup {id} with entries in {options}.
222
223
224popup_getoptions({id}) *popup_getoptions()*
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200225 {not implemented yet}
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200226 Return the {options} for popup {id}.
227
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200228popup_getposition({id}) *popup_getposition()*
229 {not implemented yet}
230 Return the position and size of popup {id}. Returns a Dict
231 with these entries:
232 col screen column of the popup, one-based
233 line screen line of the popup, one-based
234 width width of the popup in screen cells
235 height height of the popup in screen cells
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200236
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200237win_execute({id}, {command})
238 {not implemented yet}
239 Like `execute()` but in the context of window {id}.
240 The window will temporarily be made the current window,
241 without triggering autocommands.
242 Example: >
243 call win_execute(winid, 'syntax enable')
244<
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200245
Bram Moolenaar5c017b22019-05-21 23:09:01 +0200246 *:popupclear* *:popupc*
247:popupc[lear] Emergency solution to a misbehaving plugin: close all popup
248 windows.
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200249
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200250
Bram Moolenaar5c017b22019-05-21 23:09:01 +0200251POPUP BUFFER AND WINDOW *popup-buffer*
252
253A new buffer is created to hold the text and text properties of the popup
254window. The buffer is always associated with the popup window and
255manipulation is restricted:
256- the buffer has no name
257- 'buftype' is "popup"
258- 'swapfile' is off
259- 'bufhidden' is "hide"
260- 'buflisted' is off
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200261- 'undolevels' is -1: no undo at all
Bram Moolenaar5c017b22019-05-21 23:09:01 +0200262TODO: more
263
Bram Moolenaar68e65602019-05-26 21:33:31 +0200264It is possible to change these options, but anything might break then, so
265better leave them alone.
266
Bram Moolenaar5c017b22019-05-21 23:09:01 +0200267The window does have a cursor position, but the cursor is not displayed.
268
269Options can be set on the window with `setwinvar()`, e.g.: >
270 call setwinvar(winid, '&wrap', 0)
271And options can be set on the buffer with `setbufvar()`, e.g.: >
272 call setbufvar(winbufnr(winid), '&filetype', 'java')
273
274
275POPUP_CREATE() ARGUMENTS *popup_create-usage*
276
277The first argument of |popup_create()| specifies the text to be displayed, and
278optionally text properties. It is in one of three forms:
279- a string
280- a list of strings
281- a list of dictionaries, where each dictionary has these entries:
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200282 {not implemented yet}
Bram Moolenaar5c017b22019-05-21 23:09:01 +0200283 text String with the text to display.
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200284 props A list of text properties. Optional.
285 Each entry is a dictionary, like the third argument of
286 |prop_add()|, but specifying the column in the
287 dictionary with a "col" entry, see below:
288 |popup-props|.
289
Bram Moolenaar5c017b22019-05-21 23:09:01 +0200290The second argument of |popup_create()| is a dictionary with options:
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200291 line screen line where to position the popup; can use
292 "cursor", "cursor+1" or "cursor-1" to use the line of
293 the cursor and add or subtract a number of lines;
294 default is "cursor-1".
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200295 {only number is implemented}
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200296 col screen column where to position the popup; can use
297 "cursor" to use the column of the cursor, "cursor+99"
298 and "cursor-99" to add or subtract a number of
299 columns; default is "cursor"
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200300 {only number is implemented}
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200301 pos "topleft", "topright", "botleft" or "botright":
302 defines what corner of the popup "line" and "col" are
303 used for. Default is "botleft". Alternatively
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200304 "center" can be used to position the popup in the
305 center of the Vim window.
306 {not implemented yet}
Bram Moolenaar5c017b22019-05-21 23:09:01 +0200307 flip when TRUE (the default) and the position is relative
308 to the cursor, flip to below or above the cursor to
309 avoid overlap with the |popupmenu-completion| or
310 another popup with a higher "zindex"
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200311 {not implemented yet}
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200312 maxheight maximum height
313 minheight minimum height
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200314 {not implemented yet}
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200315 maxwidth maximum width
316 minwidth minimum width
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200317 {not implemented yet}
Bram Moolenaar5c017b22019-05-21 23:09:01 +0200318 hidden when TRUE the popup exists but is not displayed; use
319 `popup_show()` to unhide it.
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200320 {not implemented yet}
Bram Moolenaar5c017b22019-05-21 23:09:01 +0200321 tab when -1: display the popup on all tabs; when 0 (the
322 default): display the popup on the current tab;
323 otherwise the number of the tab page the popup is
324 displayed on; when invalid the current tab is used
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200325 {only -1 and 0 are implemented}
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200326 title text to be displayed above the first item in the
327 popup, on top of any border
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200328 {not implemented yet}
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200329 wrap TRUE to make the lines wrap (default TRUE)
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200330 {not implemented yet}
331 highlight highlight group name to use for the text, stored in
Bram Moolenaar20c023a2019-05-26 21:03:24 +0200332 the 'wincolor' option
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200333 border list with numbers, defining the border thickness
334 above/right/below/left of the popup; an empty list
335 uses a border of 1 all around
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200336 {not implemented yet}
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200337 borderhighlight highlight group name to use for the border
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200338 {not implemented yet}
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200339 borderchars list with characters, defining the character to use
340 for the top/right/bottom/left border; optionally
341 followed by the character to use for the
342 topright/botright/botleft/topleft corner; an empty
343 list can be used to show a double line all around
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200344 {not implemented yet}
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200345 zindex priority for the popup, default 50
346 time time in milliseconds after which the popup will close;
347 when omitted |popup_close()| must be used.
348 moved "cell": close the popup if the cursor moved at least
349 one screen cell; "word" allows for moving within
350 |<cword>|, "WORD" allows for moving within |<cWORD>|,
351 a list with two numbers specifies the start and end
352 column
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200353 {not implemented yet}
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200354 filter a callback that can filter typed characters, see
355 |popup-filter|
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200356 {not implemented yet}
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200357 callback a callback to be used when the popup closes, e.g. when
358 using |popup_filter_menu()|, see |popup-callback|.
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200359 {not implemented yet}
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200360
361Depending on the "zindex" the popup goes under or above other popups. The
362completion menu (|popup-menu|) has zindex 100. For messages that occur for a
363short time the suggestion is to use zindex 1000.
364
365By default text wraps, which causes a line in {lines} to occupy more than one
366screen line. When "wrap" is FALSE then the text outside of the popup or
367outside of the Vim window will not be displayed, thus truncated.
368
369
370POPUP TEXT PROPERTIES *popup-props*
371
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200372{not implemented yet}
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200373These are similar to the third argument of |prop_add()|, but not exactly the
374same, since they only apply to one line.
375 col starting column, counted in bytes, use one for the
376 first column.
377 length length of text in bytes; can be zero
378 end_col column just after the text; not used when "length" is
379 present; when {col} and "end_col" are equal, this is a
380 zero-width text property
381 id user defined ID for the property; when omitted zero is
382 used
383 type name of the text property type, as added with
384 |prop_type_add()|
385 transparent do not show these characters, show the text under it;
386 if there is an border character to the right or below
387 it will be made transparent as well
388
389
390POPUP FILTER *popup-filter*
391
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200392{not implemented yet}
Bram Moolenaar5c017b22019-05-21 23:09:01 +0200393A callback that gets any typed keys while a popup is displayed. The filter is
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200394not invoked when the popup is hidden.
Bram Moolenaar5c017b22019-05-21 23:09:01 +0200395
396The filter can return TRUE to indicate the key has been handled and is to be
397discarded, or FALSE to let Vim handle the key as usual in the current state.
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200398In case it returns FALSE and there is another popup window visible, that
399filter is also called. The filter of the popup window with the highest zindex
400is called first.
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200401
402The filter function is called with two arguments: the ID of the popup and the
403key.
404
405Some common key actions:
406 Esc close the popup
407 cursor keys select another entry
408 Tab accept current suggestion
409
Bram Moolenaar5c017b22019-05-21 23:09:01 +0200410A mouse click arrives as <LeftMouse>. The coordinates are in
411v:mouse_popup_col and v:mouse_popup_row. The top-left screen cell of the
412popup is col 1, row 1 (not counting the border).
413
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200414Vim provides standard filters |popup_filter_menu()| and
415|popup_filter_yesno()|.
416
417
418POPUP CALLBACK *popup-callback*
419
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200420{not implemented yet}
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200421A callback that is invoked when the popup closes. Used by
422|popup_filter_menu()|. Invoked with two arguments: the ID of the popup and
423the result, which would usually be an index in the popup lines, or whatever
424the filter wants to pass.
425
426==============================================================================
4273. Examples *popup-examples*
428
429TODO
430
431Prompt the user to press y/Y or n/N: >
432
433 func MyDialogHandler(id, result)
434 if a:result
435 " ... 'y' or 'Y' was pressed
436 endif
437 endfunc
438
Bram Moolenaar5c017b22019-05-21 23:09:01 +0200439 call popup_create(['Continue? y/n'], {
Bram Moolenaar957f85d2019-05-12 21:43:48 +0200440 \ 'filter': 'popup_filter_yesno',
441 \ 'callback': 'MyDialogHandler',
442 \ })
443<
444
445 vim:tw=78:ts=8:noet:ft=help:norl: