mirror/emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2025-01-29 19:48:19 +00:00
Code Issues Releases Activity

(Fields): Clarify explanation of constrain-to-field.

Browse Source
This commit is contained in:
Richard M. Stallman 2006-09-18 21:56:30 +00:00
parent f573c8b035
commit a0c489f163
2 changed files with 18 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
lispref/ChangeLog
View File

@ -1,3 +1,7 @@
2006-09-18 Richard Stallman <rms@gnu.org>
* text.texi (Fields): Clarify explanation of constrain-to-field.
2006-09-16 Eli Zaretskii <eliz@gnu.org>
* variables.texi (Tips for Defining): Fix a typo.

23
lispref/text.texi
View File

@ -3783,20 +3783,25 @@ This function ``constrains'' @var{new-pos} to the field that
closest to @var{new-pos} that is in the same field as @var{old-pos}.
If @var{new-pos} is @code{nil}, then @code{constrain-to-field} uses
the value of point instead, and moves point to the resulting position.
the value of point instead, and moves point to the resulting position
as well as returning it.
If @var{old-pos} is at the boundary of two fields, then the acceptable
positions for @var{new-pos} depend on the value of the optional argument
@var{escape-from-edge}. If @var{escape-from-edge} is @code{nil}, then
@var{new-pos} is constrained to the field that has the same @code{field}
property (either a text-property or an overlay property) that new
characters inserted at @var{old-pos} would get. (This depends on the
final positions depend on the argument @var{escape-from-edge}. If
@var{escape-from-edge} is @code{nil}, then @var{new-pos} must be in
the field whose @code{field} property equals what new characters
inserted at @var{old-pos} would inherit. (This depends on the
stickiness of the @code{field} property for the characters before and
after @var{old-pos}.) If @var{escape-from-edge} is non-@code{nil},
@var{new-pos} is constrained to the union of the two adjacent fields.
@var{new-pos} can be anywhere in the two adjacent fields.
Additionally, if two fields are separated by another field with the
special value @code{boundary}, then any point within this special field
is also considered to be ``on the boundary.''
special value @code{boundary}, then any point within this special
field is also considered to be ``on the boundary.''
Commands like @kbd{C-a} with no argumemt, that normally move backward
to a specific kind of location and stay there once there, probably
should specify @code{nil} for @var{escape-from-edge}. Other motion
commands that check fields should probably pass @code{t}.
If the optional argument @var{only-in-line} is non-@code{nil}, and
constraining @var{new-pos} in the usual way would move it to a different