summaryrefslogtreecommitdiffstats
path: root/runtime
diff options
context:
space:
mode:
authorBram Moolenaar <Bram@vim.org>2022-08-23 18:39:37 +0100
committerBram Moolenaar <Bram@vim.org>2022-08-23 18:39:37 +0100
commitf396ce83eebf6c61596184231d39ce4d41eeac04 (patch)
treed3a624411eaea5463025bd186c39616688cc0876 /runtime
parentadce965162dd89bf29ee0e5baf53652e7515762c (diff)
patch 9.0.0247: cannot add padding to virtual text without highlightv9.0.0247
Problem: Cannot add padding to virtual text without highlight. Solution: Add the "text_padding_left" argument. (issue #10906)
Diffstat (limited to 'runtime')
-rw-r--r--runtime/doc/textprop.txt16
1 files changed, 12 insertions, 4 deletions
diff --git a/runtime/doc/textprop.txt b/runtime/doc/textprop.txt
index 9a148455e0..846915f787 100644
--- a/runtime/doc/textprop.txt
+++ b/runtime/doc/textprop.txt
@@ -126,6 +126,7 @@ prop_add({lnum}, {col}, {props})
If {col} is invalid an error is given. *E964*
{props} is a dictionary with these fields:
+ type name of the text property type
length length of text in bytes, can only be used
for a property that does not continue in
another line; can be zero
@@ -142,9 +143,10 @@ prop_add({lnum}, {col}, {props})
automatically to a negative number; otherwise
zero is used
text text to be displayed before {col}, or after the
- line if {col} is zero
+ line if {col} is zero; prepend and/or append
+ spaces for padding with highlighting
*E1294*
- text_align when "text" is present and {col} is zero
+ text_align when "text" is present and {col} is zero;
specifies where to display the text:
after after the end of the line
right right aligned in the window (unless
@@ -152,14 +154,20 @@ prop_add({lnum}, {col}, {props})
line)
below in the next screen line
When omitted "after" is used. Only one
- "right" property can fit in earch line.
+ "right" property can fit in each line, if
+ there are two ore more these will go in a
+ separate line (still right aligned).
+ text_padding_left *E1296*
+ used when "text" is present and {col} is zero;
+ padding between the end of the text line
+ (leftmost column for "below") and the virtual
+ text, not highlighted
text_wrap when "text" is present and {col} is zero,
specifies what happens if the text doesn't
fit:
wrap wrap the text to the next line
truncate truncate the text to make it fit
When omitted "truncate" is used.
- type name of the text property type
All fields except "type" are optional.
It is an error when both "length" and "end_lnum" or "end_col"