Mercurial > vim

comparison runtime/doc/popup.txt @ 16841:cf630fab9fb6 v8.1.1422

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
patch 8.1.1422: popup_getoptions() not implemented yet commit https://github.com/vim/vim/commit/8c2a600f72ca930841a5f4f7eac22884238afaf3 Author: Bram Moolenaar <Bram@vim.org> Date: Thu May 30 14:29:45 2019 +0200 patch 8.1.1422: popup_getoptions() not implemented yet Problem: Popup_getoptions() not implemented yet. Solution: Implement it. (closes https://github.com/vim/vim/issues/4452)
author Bram Moolenaar <Bram@vim.org>
date Thu, 30 May 2019 14:30:07 +0200
parents 6699c03347d2
children e6bcccccbf7b
comparison
equal deleted inserted replaced
16840:e9db83da71f5 16841:cf630fab9fb6
84 84
85 85
86 IMPLEMENTATION: 86 IMPLEMENTATION:
87 - Code is in popupwin.c 87 - Code is in popupwin.c
88 - when creating the window set options to Vim default? (verify with 'number') 88 - when creating the window set options to Vim default? (verify with 'number')
89 - Do not show tilde below last line.
90 - Implement filter. 89 - Implement filter.
91 Check that popup_close() works in the filter. 90 Check that popup_close() works in the filter.
91 - Implement the "pos" option.
92 - Handle screen resize in screenalloc(). 92 - Handle screen resize in screenalloc().
93 - Make redrawing more efficient and avoid flicker. 93 - Make redrawing more efficient and avoid flicker.
94 Store popup info in a mask, use the mask in screen_line()
94 Fix redrawing problem with completion. 95 Fix redrawing problem with completion.
95 Fix redrawing problem when scrolling non-current window 96 Fix redrawing problem when scrolling non-current window
96 Fix redrawing the statusline on top of a popup 97 Fix redrawing the statusline on top of a popup
97 - Properly figure out the size and position. 98 - Figure out the size and position better.
99 if wrapping splits a double-wide character
100 if wrapping has an indent
98 - Can the buffer be re-used, to avoid using up lots of buffer numbers? 101 - Can the buffer be re-used, to avoid using up lots of buffer numbers?
99 - Implement all the unimplemented options and features. 102 - Implement all the unimplemented options and features.
100 103
101 104
102 ============================================================================== 105 ==============================================================================
226 {not implemented yet} 229 {not implemented yet}
227 Override options in popup {id} with entries in {options}. 230 Override options in popup {id} with entries in {options}.
228 231
229 232
230 popup_getoptions({id}) *popup_getoptions()* 233 popup_getoptions({id}) *popup_getoptions()*
231 {not implemented yet} 234 Return the {options} for popup {id} in a Dict.
232 Return the {options} for popup {id}. 235 A zero value means the option was not set.
236
237 The "highlight" entry is omitted, use the 'wincolor' option
238 for that: >
239 let hl = getwinvar(winid, '&wincolor')
240
241 < If popup window {id} is not found an empty Dict is returned.
233 242
234 popup_getposition({id}) *popup_getposition()* 243 popup_getposition({id}) *popup_getposition()*
235 Return the position and size of popup {id}. Returns a Dict 244 Return the position and size of popup {id}. Returns a Dict
236 with these entries: 245 with these entries:
237 col screen column of the popup, one-based 246 col screen column of the popup, one-based
238 line screen line of the popup, one-based 247 line screen line of the popup, one-based
239 width width of the popup in screen cells 248 width width of the popup in screen cells
240 height height of the popup in screen cells 249 height height of the popup in screen cells
250 visible one if the popup is displayed, zero if hidden
241 Note that these are the actual screen positions. They differ 251 Note that these are the actual screen positions. They differ
242 from the values in `popup_getoptions()` for the sizing and 252 from the values in `popup_getoptions()` for the sizing and
243 positioning mechanism applied. 253 positioning mechanism applied.
244 If popup window {id} is not found an empty Dict is returned. 254 If popup window {id} is not found an empty Dict is returned.
245 255
302 and "cursor-99" to add or subtract a number of 312 and "cursor-99" to add or subtract a number of
303 columns; default is "cursor" 313 columns; default is "cursor"
304 {only number is implemented} 314 {only number is implemented}
305 pos "topleft", "topright", "botleft" or "botright": 315 pos "topleft", "topright", "botleft" or "botright":
306 defines what corner of the popup "line" and "col" are 316 defines what corner of the popup "line" and "col" are
307 used for. Default is "botleft". Alternatively 317 used for. When not set "topleft" is used.
308 "center" can be used to position the popup in the 318 Alternatively "center" can be used to position the
309 center of the Vim window. 319 popup in the center of the Vim window.
310 {not implemented yet} 320 {not implemented yet}
311 flip when TRUE (the default) and the position is relative 321 flip when TRUE (the default) and the position is relative
312 to the cursor, flip to below or above the cursor to 322 to the cursor, flip to below or above the cursor to
313 avoid overlap with the |popupmenu-completion| or 323 avoid overlap with the |popupmenu-completion| or
314 another popup with a higher "zindex" 324 another popup with a higher "zindex"