Mercurial > vim

comparison runtime/doc/textprop.txt @ 29816:bbe62ea78aac v9.0.0247

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
patch 9.0.0247: cannot add padding to virtual text without highlight Commit: https://github.com/vim/vim/commit/f396ce83eebf6c61596184231d39ce4d41eeac04 Author: Bram Moolenaar <Bram@vim.org> Date: Tue Aug 23 18:39:37 2022 +0100 patch 9.0.0247: cannot add padding to virtual text without highlight Problem: Cannot add padding to virtual text without highlight. Solution: Add the "text_padding_left" argument. (issue https://github.com/vim/vim/issues/10906)
author Bram Moolenaar <Bram@vim.org>
date Tue, 23 Aug 2022 19:45:05 +0200
parents 2acb87ee55fc
children b15334beeaa4
comparison
equal deleted inserted replaced
29815:9941dc321348 29816:bbe62ea78aac
124 counted in bytes, use one for the first column. 124 counted in bytes, use one for the first column.
125 If {lnum} is invalid an error is given. *E966* 125 If {lnum} is invalid an error is given. *E966*
126 If {col} is invalid an error is given. *E964* 126 If {col} is invalid an error is given. *E964*
127 127
128 {props} is a dictionary with these fields: 128 {props} is a dictionary with these fields:
129 type name of the text property type
129 length length of text in bytes, can only be used 130 length length of text in bytes, can only be used
130 for a property that does not continue in 131 for a property that does not continue in
131 another line; can be zero 132 another line; can be zero
132 end_lnum line number for the end of text (inclusive) 133 end_lnum line number for the end of text (inclusive)
133 end_col column just after the text; not used when 134 end_col column just after the text; not used when
140 number, should be positive; when using "text" 141 number, should be positive; when using "text"
141 then "id" must not be present and will be set 142 then "id" must not be present and will be set
142 automatically to a negative number; otherwise 143 automatically to a negative number; otherwise
143 zero is used 144 zero is used
144 text text to be displayed before {col}, or after the 145 text text to be displayed before {col}, or after the
145 line if {col} is zero 146 line if {col} is zero; prepend and/or append
147 spaces for padding with highlighting
146 *E1294* 148 *E1294*
147 text_align when "text" is present and {col} is zero 149 text_align when "text" is present and {col} is zero;
148 specifies where to display the text: 150 specifies where to display the text:
149 after after the end of the line 151 after after the end of the line
150 right right aligned in the window (unless 152 right right aligned in the window (unless
151 the text wraps to the next screen 153 the text wraps to the next screen
152 line) 154 line)
153 below in the next screen line 155 below in the next screen line
154 When omitted "after" is used. Only one 156 When omitted "after" is used. Only one
155 "right" property can fit in earch line. 157 "right" property can fit in each line, if
158 there are two ore more these will go in a
159 separate line (still right aligned).
160 text_padding_left *E1296*
161 used when "text" is present and {col} is zero;
162 padding between the end of the text line
163 (leftmost column for "below") and the virtual
164 text, not highlighted
156 text_wrap when "text" is present and {col} is zero, 165 text_wrap when "text" is present and {col} is zero,
157 specifies what happens if the text doesn't 166 specifies what happens if the text doesn't
158 fit: 167 fit:
159 wrap wrap the text to the next line 168 wrap wrap the text to the next line
160 truncate truncate the text to make it fit 169 truncate truncate the text to make it fit
161 When omitted "truncate" is used. 170 When omitted "truncate" is used.
162 type name of the text property type
163 All fields except "type" are optional. 171 All fields except "type" are optional.
164 172
165 It is an error when both "length" and "end_lnum" or "end_col" 173 It is an error when both "length" and "end_lnum" or "end_col"
166 are given. Either use "length" or "end_col" for a property 174 are given. Either use "length" or "end_col" for a property
167 within one line, or use "end_lnum" and "end_col" for a 175 within one line, or use "end_lnum" and "end_col" for a