Mercurial > vim

comparison runtime/doc/popup.txt @ 16811:0457d49eb2d9 v8.1.1407

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
patch 8.1.1407: popup_create() does not support text properties commit https://github.com/vim/vim/commit/7a8d0278bd6bd57e04f61183cb8e2969cf148e3f Author: Bram Moolenaar <Bram@vim.org> Date: Sun May 26 23:32:06 2019 +0200 patch 8.1.1407: popup_create() does not support text properties Problem: Popup_create() does not support text properties. Solution: Support the third form of the text argument.
author Bram Moolenaar <Bram@vim.org>
date Sun, 26 May 2019 23:45:05 +0200
parents 5ff14f96f1c9
children 069ee8dc8c8d
comparison
equal deleted inserted replaced
16810:53b2302072d2 16811:0457d49eb2d9
277 The first argument of |popup_create()| specifies the text to be displayed, and 277 The first argument of |popup_create()| specifies the text to be displayed, and
278 optionally text properties. It is in one of three forms: 278 optionally text properties. It is in one of three forms:
279 - a string 279 - a string
280 - a list of strings 280 - a list of strings
281 - a list of dictionaries, where each dictionary has these entries: 281 - a list of dictionaries, where each dictionary has these entries:
282 {not implemented yet}
283 text String with the text to display. 282 text String with the text to display.
284 props A list of text properties. Optional. 283 props A list of text properties. Optional.
285 Each entry is a dictionary, like the third argument of 284 Each entry is a dictionary, like the third argument of
286 |prop_add()|, but specifying the column in the 285 |prop_add()|, but specifying the column in the
287 dictionary with a "col" entry, see below: 286 dictionary with a "col" entry, see below:
367 outside of the Vim window will not be displayed, thus truncated. 366 outside of the Vim window will not be displayed, thus truncated.
368 367
369 368
370 POPUP TEXT PROPERTIES *popup-props* 369 POPUP TEXT PROPERTIES *popup-props*
371 370
372 {not implemented yet} 371 These are similar to the third argument of |prop_add()| except:
373 These are similar to the third argument of |prop_add()|, but not exactly the 372 - "lnum" is always the current line in the list
374 same, since they only apply to one line. 373 - "bufnr" is always the buffer of the popup
374 - "col" is in the Dict instead of a separate argument
375 - "transparent" is extra
376 So we get:
375 col starting column, counted in bytes, use one for the 377 col starting column, counted in bytes, use one for the
376 first column. 378 first column.
377 length length of text in bytes; can be zero 379 length length of text in bytes; can be zero
380 end_lnum line number for the end of the text
378 end_col column just after the text; not used when "length" is 381 end_col column just after the text; not used when "length" is
379 present; when {col} and "end_col" are equal, this is a 382 present; when {col} and "end_col" are equal, this is a
380 zero-width text property 383 zero-width text property
381 id user defined ID for the property; when omitted zero is 384 id user defined ID for the property; when omitted zero is
382 used 385 used
383 type name of the text property type, as added with 386 type name of the text property type, as added with
384 |prop_type_add()| 387 |prop_type_add()|
385 transparent do not show these characters, show the text under it; 388 transparent do not show these characters, show the text under it;
386 if there is an border character to the right or below 389 if there is an border character to the right or below
387 it will be made transparent as well 390 it will be made transparent as well
391 {not implemented yet}
388 392
389 393
390 POPUP FILTER *popup-filter* 394 POPUP FILTER *popup-filter*
391 395
392 {not implemented yet} 396 {not implemented yet}