comparison runtime/doc/textprop.txt @ 29756:2acb87ee55fc

Update runtime files Commit: https://github.com/vim/vim/commit/e1f3fd1d02e3f5fe6d2b6d82687c6846b8e500f8 Author: Bram Moolenaar <Bram@vim.org> Date: Mon Aug 15 18:51:32 2022 +0100 Update runtime files
author Bram Moolenaar <Bram@vim.org>
date Mon, 15 Aug 2022 20:00:05 +0200
parents 33d7c1fa2dac
children bbe62ea78aac
comparison
equal deleted inserted replaced
29755:e726ee71b93b 29756:2acb87ee55fc
141 then "id" must not be present and will be set 141 then "id" must not be present and will be set
142 automatically to a negative number; otherwise 142 automatically to a negative number; otherwise
143 zero is used 143 zero is used
144 text text to be displayed before {col}, or after the 144 text text to be displayed before {col}, or after the
145 line if {col} is zero 145 line if {col} is zero
146 *E1294*
146 text_align when "text" is present and {col} is zero 147 text_align when "text" is present and {col} is zero
147 specifies where to display the text: 148 specifies where to display the text:
148 after after the end of the line 149 after after the end of the line
149 right right aligned in the window 150 right right aligned in the window (unless
151 the text wraps to the next screen
152 line)
150 below in the next screen line 153 below in the next screen line
151 When omitted "after" is used. 154 When omitted "after" is used. Only one
155 "right" property can fit in earch line.
152 text_wrap when "text" is present and {col} is zero, 156 text_wrap when "text" is present and {col} is zero,
153 specifies what happens if the text doesn't 157 specifies what happens if the text doesn't
154 fit: 158 fit:
155 wrap wrap the text to the next line 159 wrap wrap the text to the next line
156 truncate truncate the text to make it fit 160 truncate truncate the text to make it fit
184 determine how it is displayed. 188 determine how it is displayed.
185 The text will be displayed but it is not part of the actual 189 The text will be displayed but it is not part of the actual
186 buffer line, the cursor cannot be placed on it. A mouse click 190 buffer line, the cursor cannot be placed on it. A mouse click
187 in the text will move the cursor to the first character after 191 in the text will move the cursor to the first character after
188 the text, or the last character of the line. 192 the text, or the last character of the line.
193 Any Tab and other control character in the text will be
194 changed to a space (Rationale: otherwise the size of the text
195 is difficult to compute).
189 A negative "id" will be chosen and is returned. Once a 196 A negative "id" will be chosen and is returned. Once a
190 Any Tab in the text will be changed to a space (Rationale:
191 otherwise the size of the text is difficult to compute).
192 property with "text" has been added for a buffer then using a 197 property with "text" has been added for a buffer then using a
193 negative "id" for any other property will give an error: 198 negative "id" for any other property will give an error:
194 *E1293* 199 *E1293*
195 Make sure to use a highlight that makes clear to the user that 200 Make sure to use a highlight that makes clear to the user that
196 this is virtual text, otherwise it will be very confusing that 201 this is virtual text, otherwise it will be very confusing that