aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiles Bader2000-12-09 02:58:55 +0000
committerMiles Bader2000-12-09 02:58:55 +0000
commit00480554c4ed048fabd1bc4f34351dca2c9c270b (patch)
tree3b7e53960e57e759c16e572389cc451b1f3424ba
parent26fcde616f379b4941441a71d07942d4fa0d49db (diff)
downloademacs-00480554c4ed048fabd1bc4f34351dca2c9c270b.tar.gz
emacs-00480554c4ed048fabd1bc4f34351dca2c9c270b.zip
(Window Start): Update documentation for `pos-visible-in-window-p'.
-rw-r--r--lispref/ChangeLog5
-rw-r--r--lispref/windows.texi21
2 files changed, 14 insertions, 12 deletions
diff --git a/lispref/ChangeLog b/lispref/ChangeLog
index 64e61df4665..7d37f87d75e 100644
--- a/lispref/ChangeLog
+++ b/lispref/ChangeLog
@@ -1,3 +1,8 @@
12000-12-09 Miles Bader <miles@gnu.org>
2
3 * windows.texi (Window Start): Update documentation for
4 `pos-visible-in-window-p'.
5
12000-11-12 Stefan Monnier <monnier@cs.yale.edu> 62000-11-12 Stefan Monnier <monnier@cs.yale.edu>
2 7
3 * lists.texi (Building Lists): Add footnote to explain how to add 8 * lists.texi (Building Lists): Add footnote to explain how to add
diff --git a/lispref/windows.texi b/lispref/windows.texi
index 1d89018495c..5d46ed35e9d 100644
--- a/lispref/windows.texi
+++ b/lispref/windows.texi
@@ -1211,14 +1211,16 @@ off screen at the next redisplay, then redisplay computes a new window-start
1211position that works well with point, and thus @var{position} is not used. 1211position that works well with point, and thus @var{position} is not used.
1212@end defun 1212@end defun
1213 1213
1214@defun pos-visible-in-window-p &optional position window fully 1214@defun pos-visible-in-window-p &optional position window partially
1215This function returns @code{t} if @var{position} is within the range of 1215This function returns @code{t} if @var{position} is within the range of
1216text currently visible on the screen in @var{window}. If @var{fully} is 1216text currently visible on the screen in @var{window}. It returns
1217non-@code{nil}, then locations that are partially obscured are not 1217@code{nil} if @var{position} is scrolled vertically or horizontally out
1218considered visible. It returns @code{nil} if @var{position} is scrolled 1218of view. Locations that are partially obscured are not considered
1219vertically out of view. The argument @var{position} defaults to the 1219visible unless @var{partially} is non-@code{nil}. The argument
1220current position of point; @var{window}, to the selected window. Here 1220@var{position} defaults to the current position of point in
1221is an example: 1221@var{window}; @var{window}, to the selected window.
1222
1223Here is an example:
1222 1224
1223@example 1225@example
1224@group 1226@group
@@ -1227,11 +1229,6 @@ is an example:
1227 (recenter 0)) 1229 (recenter 0))
1228@end group 1230@end group
1229@end example 1231@end example
1230
1231The @code{pos-visible-in-window-p} function considers only vertical
1232scrolling. If @var{position} is out of view only because @var{window}
1233has been scrolled horizontally, @code{pos-visible-in-window-p} returns
1234@code{t} anyway. @xref{Horizontal Scrolling}.
1235@end defun 1232@end defun
1236 1233
1237@node Textual Scrolling 1234@node Textual Scrolling