procyberian/emacs
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

; Clarify documentation of 'cursor' text property

Browse source 
* doc/lispref/text.texi (Special Properties): Clarify that
'cursor' property is only considered when the overlay hides buffer
text on display.  (Bug#62540)
This commit is contained in:
Eli Zaretskii 2023-03-30 16:34:41 +03:00
parent d2e82817a3
commit 4508a024e8
1 changed files with 13 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

25
doc/lispref/text.texi
View file

@ -3765,18 +3765,19 @@ Consecutive characters with the same @code{field} property constitute a
@item cursor @item cursor
@kindex cursor @r{(text property)} @kindex cursor @r{(text property)}
Normally, the cursor is displayed at the beginning or the end of any Normally, the cursor is displayed at the beginning or the end of any
overlay and text property strings present at the current buffer overlay and text property strings that ``hide'' (i.e., are displayed
position. You can instead tell Emacs to place the cursor on any instead of) the current buffer position. You can instead tell Emacs
desired character of these strings by giving that character a to place the cursor on any desired character of these strings by
non-@code{nil} @code{cursor} text property. In addition, if the value giving that character a non-@code{nil} @code{cursor} text property.
of the @code{cursor} property is an integer, it specifies the number In addition, if the value of the @code{cursor} property is an integer,
of buffer's character positions, starting with the position where the it specifies the number of buffer's character positions, starting with
overlay or the @code{display} property begins, for which the cursor the position where the overlay or the @code{display} property begins,
should be displayed on that character. Specifically, if the value of for which the cursor should be displayed on that character.
the @code{cursor} property of a character is the number @var{n}, the Specifically, if the value of the @code{cursor} property of a
cursor will be displayed on this character for any buffer position in character is the number @var{n}, the cursor will be displayed on this
the range @code{[@var{ovpos}..@var{ovpos}+@var{n})}, where @var{ovpos} character for any buffer position in the range
is the overlay's starting position given by @code{overlay-start} @code{[@var{ovpos}..@var{ovpos}+@var{n})}, where @var{ovpos} is the
overlay's starting position given by @code{overlay-start}
(@pxref{Managing Overlays}), or the position where the @code{display} (@pxref{Managing Overlays}), or the position where the @code{display}
text property begins in the buffer. text property begins in the buffer.