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

* positions.texi (Screen Lines): Document (cols . lines) argument

Browse source 
for vertical-motion.
This commit is contained in:
Chong Yidong 2009-04-05 05:11:48 +00:00
parent 9496c82e55
commit ea30ce4f23
2 changed files with 13 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
doc/lispref/ChangeLog
View file

@ -1,3 +1,8 @@
2009-04-05 Chong Yidong <cyd@stupidchicken.com>
* positions.texi (Screen Lines): Document (cols . lines) argument
for vertical-motion.
2009-04-04 Chong Yidong <cyd@stupidchicken.com>
* frames.texi (Frames): Clean up introduction. Document `ns'

11
doc/lispref/positions.texi
View file

@ -520,9 +520,14 @@ This function moves point to the start of the screen line @var{count}
screen lines down from the screen line containing point. If @var{count}
is negative, it moves up instead.
@code{vertical-motion} returns the number of screen lines over which it
moved point. The value may be less in absolute value than @var{count}
if the beginning or end of the buffer was reached.
The @var{count} argument can be a cons cell, @code{(@var{cols}
. @var{lines})}, instead of an integer. Then the function moves by
@var{lines} screen lines, and puts point @var{cols} columns from the
start of that screen line.
The return value is the number of screen lines over which point was
moved. The value may be less in absolute value than @var{count} if
the beginning or end of the buffer was reached.
The window @var{window} is used for obtaining parameters such as the
width, the horizontal scrolling, and the display table. But