diff options
| author | Eli Zaretskii | 2023-03-30 16:34:41 +0300 |
|---|---|---|
| committer | Eli Zaretskii | 2023-03-30 16:34:41 +0300 |
| commit | 4508a024e81834cfb01c6f7984182e1a6cbb91ea (patch) | |
| tree | a385a370822bb0aa66c130bd04dd6b376532fc2c | |
| parent | d2e82817a3f341e426c220e98048e1784d1e3076 (diff) | |
| download | emacs-4508a024e81834cfb01c6f7984182e1a6cbb91ea.tar.gz emacs-4508a024e81834cfb01c6f7984182e1a6cbb91ea.zip | |
; Clarify documentation of 'cursor' text property
* doc/lispref/text.texi (Special Properties): Clarify that
'cursor' property is only considered when the overlay hides buffer
text on display. (Bug#62540)
| -rw-r--r-- | doc/lispref/text.texi | 25 |
1 files changed, 13 insertions, 12 deletions
diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi index 0a48beab8b8..4c13185b0dd 100644 --- a/doc/lispref/text.texi +++ b/doc/lispref/text.texi | |||
| @@ -3765,18 +3765,19 @@ Consecutive characters with the same @code{field} property constitute a | |||
| 3765 | @item cursor | 3765 | @item cursor |
| 3766 | @kindex cursor @r{(text property)} | 3766 | @kindex cursor @r{(text property)} |
| 3767 | Normally, the cursor is displayed at the beginning or the end of any | 3767 | Normally, the cursor is displayed at the beginning or the end of any |
| 3768 | overlay and text property strings present at the current buffer | 3768 | overlay and text property strings that ``hide'' (i.e., are displayed |
| 3769 | position. You can instead tell Emacs to place the cursor on any | 3769 | instead of) the current buffer position. You can instead tell Emacs |
| 3770 | desired character of these strings by giving that character a | 3770 | to place the cursor on any desired character of these strings by |
| 3771 | non-@code{nil} @code{cursor} text property. In addition, if the value | 3771 | giving that character a non-@code{nil} @code{cursor} text property. |
| 3772 | of the @code{cursor} property is an integer, it specifies the number | 3772 | In addition, if the value of the @code{cursor} property is an integer, |
| 3773 | of buffer's character positions, starting with the position where the | 3773 | it specifies the number of buffer's character positions, starting with |
| 3774 | overlay or the @code{display} property begins, for which the cursor | 3774 | the position where the overlay or the @code{display} property begins, |
| 3775 | should be displayed on that character. Specifically, if the value of | 3775 | for which the cursor should be displayed on that character. |
| 3776 | the @code{cursor} property of a character is the number @var{n}, the | 3776 | Specifically, if the value of the @code{cursor} property of a |
| 3777 | cursor will be displayed on this character for any buffer position in | 3777 | character is the number @var{n}, the cursor will be displayed on this |
| 3778 | the range @code{[@var{ovpos}..@var{ovpos}+@var{n})}, where @var{ovpos} | 3778 | character for any buffer position in the range |
| 3779 | is the overlay's starting position given by @code{overlay-start} | 3779 | @code{[@var{ovpos}..@var{ovpos}+@var{n})}, where @var{ovpos} is the |
| 3780 | overlay's starting position given by @code{overlay-start} | ||
| 3780 | (@pxref{Managing Overlays}), or the position where the @code{display} | 3781 | (@pxref{Managing Overlays}), or the position where the @code{display} |
| 3781 | text property begins in the buffer. | 3782 | text property begins in the buffer. |
| 3782 | 3783 | ||