From 41ad5140cdaa904f489bab8acdb4520d00c8992a Mon Sep 17 00:00:00 2001 From: "Kim F. Storm" Date: Sun, 23 Jan 2005 13:30:22 +0000 Subject: [PATCH] (Window Start): Fix `pos-visible-in-window-p' return value. Third element FULLY replaced by PARTIAL which specifies number of invisible pixels if row is only partially visible. (Textual Scrolling): Mention auto-window-vscroll. (Vertical Scrolling): New defvar auto-window-vscroll. --- lispref/windows.texi | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/lispref/windows.texi b/lispref/windows.texi index 636d1d745cc..5041fb5b2df 100644 --- a/lispref/windows.texi +++ b/lispref/windows.texi @@ -1345,10 +1345,12 @@ non-@code{nil} anyway. @xref{Horizontal Scrolling}. If @var{position} is visible, @code{pos-visible-in-window-p} returns @code{t} if @var{partially} is @code{nil}; if @var{partially} is non-@code{nil}, it returns a list of the form @code{(@var{x} @var{y} -@var{fully})}, where @var{x} and @var{y} are the pixel coordinates -relative to the top left corner of the window, and @var{fully} is -@code{t} if the character after @var{position} is fully visible and -@code{nil} otherwise. +@var{partial})}, where @var{x} and @var{y} are the pixel coordinates +relative to the top left corner of the window, and @var{partial} is +@code{nil} if the character after @var{position} is fully visible; +otherwise it is a cons @code{(@var{rtop} . @var{rbot})} where the +@var{rtop} and @var{rbot} specify the number of invisible pixels at +the top and bottom of the row at @var{position}. Here is an example: @@ -1397,6 +1399,12 @@ names that fit the user's point of view. buffer is different from the buffer that is displayed in the selected window. @xref{Current Buffer}. + If the window contains a row which is taller than the height of the +window (for example in the presense of a large image), the scroll +functions will adjust the window vscroll to scroll the partially +visible row. To disable this feature, Lisp code may bind the variable +`auto-window-vscroll' to @code{nil} (@pxref{Vertical Scrolling}). + @deffn Command scroll-up &optional count This function scrolls the text in the selected window upward @var{count} lines. If @var{count} is negative, scrolling is actually @@ -1622,6 +1630,13 @@ If @var{pixels-p} is non-@code{nil}, @var{lines} specifies a number of pixels. In this case, the return value is @var{lines}. @end defun +@defvar auto-window-vscroll +If this variable is non-@code{nil}, the line-move, scroll-up, and +scroll-down functions will automatically modify the window vscroll to +scroll through display rows that are taller that the height of the +window, for example in the presense of large images. +@end defvar + @node Horizontal Scrolling @section Horizontal Scrolling @cindex horizontal scrolling -- 2.11.4.GIT