[Emacs-diffs] Changes to emacs/lispref/windows.texi [emacs-unicode-2]

[Miles Bader]

Index: emacs/lispref/windows.texi
diff -c emacs/lispref/windows.texi:1.64.2.2 emacs/lispref/windows.texi:1.64.2.3
*** emacs/lispref/windows.texi:1.64.2.2 Sat Jul 17 02:46:47 2004
--- emacs/lispref/windows.texi  Fri Jul 23 04:30:39 2004
***************
*** 1195,1201 ****
  
  @defun set-window-point window position
  This function positions point in @var{window} at position
! @var{position} in @var{window}'s buffer.
  @end defun
  
  @node Window Start
--- 1195,1201 ----
  
  @defun set-window-point window position
  This function positions point in @var{window} at position
! @var{position} in @var{window}'s buffer.  It returns @var{position}.
  @end defun
  
  @node Window Start
***************
*** 1233,1239 ****
  redisplay.
  
  For a realistic example of using @code{window-start}, see the
! description of @code{count-lines} in @ref{Text Lines}.
  @end defun
  
  @defun window-end &optional window update
--- 1233,1239 ----
  redisplay.
  
  For a realistic example of using @code{window-start}, see the
! description of @code{count-lines}.  @xref{Definition of count-lines}.
  @end defun
  
  @defun window-end &optional window update
***************
*** 1324,1337 ****
  @end defun
  
  @defun pos-visible-in-window-p &optional position window partially
! This function returns @code{t} if @var{position} is within the range of
! text currently visible on the screen in @var{window}.  It returns
! @code{nil} if @var{position} is scrolled vertically or horizontally out
! of view.  Locations that are partially obscured are not considered
  visible unless @var{partially} is address@hidden  The argument
  @var{position} defaults to the current position of point in
  @var{window}; @var{window}, to the selected window.
  
  Here is an example:
  
  @example
--- 1324,1350 ----
  @end defun
  
  @defun pos-visible-in-window-p &optional position window partially
! This function returns address@hidden if @var{position} is within the
! range of text currently visible on the screen in @var{window}.  It
! returns @code{nil} if @var{position} is scrolled vertically out of
! view.  Locations that are partially obscured are not considered
  visible unless @var{partially} is address@hidden  The argument
  @var{position} defaults to the current position of point in
  @var{window}; @var{window}, to the selected window.
  
+ The @code{pos-visible-in-window-p} function considers only vertical
+ scrolling.  If @var{position} is out of view only because @var{window}
+ has been scrolled horizontally, @code{pos-visible-in-window-p} returns
+ address@hidden 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
+ address@hidden, 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.
+ 
  Here is an example:
  
  @example
***************
*** 1348,1354 ****
  @cindex textual scrolling
  @cindex scrolling textually
  
!   @dfn{Textual scrolling} means moving the text up or down though a
  window.  It works by changing the value of the window's display-start
  location.  It may also change the value of @code{window-point} to keep
  point on the screen.
--- 1361,1367 ----
  @cindex textual scrolling
  @cindex scrolling textually
  
!   @dfn{Textual scrolling} means moving the text up or down through a
  window.  It works by changing the value of the window's display-start
  location.  It may also change the value of @code{window-point} to keep
  point on the screen.
***************
*** 1419,1425 ****
  the one at the top left corner.  You can specify a different window to
  scroll, when the minibuffer is selected, by setting the variable
  @code{minibuffer-scroll-window}.  This variable has no effect when any
! other window is selected.  @xref{Minibuffer Misc}.
  
  When the minibuffer is active, it is the next window if the selected
  window is the one at the bottom right corner.  In this case,
--- 1432,1441 ----
  the one at the top left corner.  You can specify a different window to
  scroll, when the minibuffer is selected, by setting the variable
  @code{minibuffer-scroll-window}.  This variable has no effect when any
! other window is selected.  When it is address@hidden and the
! minibuffer is selected, it takes precedence over
! @code{other-window-scroll-buffer}.  @xref{Definition of
! minibuffer-scroll-window}.
  
  When the minibuffer is active, it is the next window if the selected
  window is the one at the bottom right corner.  In this case,
***************
*** 1563,1572 ****
  line whose height is very short off the screen, while a value of 3.3
  could scroll just part of the way through a tall line or an image.
  
! @defun window-vscroll &optional window
  This function returns the current vertical scroll position of
! @var{window}, If @var{window} is @code{nil}, the selected window is
! used.
  
  @example
  @group
--- 1579,1589 ----
  line whose height is very short off the screen, while a value of 3.3
  could scroll just part of the way through a tall line or an image.
  
! @defun window-vscroll &optional window pixels-p
  This function returns the current vertical scroll position of
! @var{window}.  If @var{window} is @code{nil}, the selected window is
! used.  If @var{pixels-p} is address@hidden, the return value is
! measured in pixels, rather than in units of the normal line height.
  
  @example
  @group
***************
*** 1576,1582 ****
  @end example
  @end defun
  
! @defun set-window-vscroll window lines
  This function sets @var{window}'s vertical scroll position to
  @var{lines}.  The argument @var{lines} should be zero or positive; if
  not, it is taken as zero.
--- 1593,1599 ----
  @end example
  @end defun
  
! @defun set-window-vscroll window lines &optional pixels-p
  This function sets @var{window}'s vertical scroll position to
  @var{lines}.  The argument @var{lines} should be zero or positive; if
  not, it is taken as zero.
***************
*** 1595,1600 ****
--- 1612,1620 ----
       @result{} 1.13
  @end group
  @end example
+ 
+ If @var{pixels-p} is address@hidden, @var{lines} specifies a number of
+ pixels.  In this case, the return value is @var{lines}.
  @end defun
  
  @node Horizontal Scrolling
***************
*** 1803,1817 ****
  rightmost column used by @var{window}, and @var{bottom} is one more than
  the bottommost row used by @var{window} and its mode-line.
  
! If a window has a scroll bar, the right edge value includes the width of
! the scroll bar.  Otherwise, if the window has a neighbor on the right,
! its right edge value includes the width of the separator line between
! the window and that neighbor.  Since the width of the window does not
! include this separator, the width does not usually equal the difference
! between the right and left edges.
  @end defun
  
! @defun window-inside-edges window
  This is similar to @code{window-edges}, but the edge values
  it returns include only the text area of the window.  They
  do not include the header line, mode line, scroll bar or
--- 1823,1838 ----
  rightmost column used by @var{window}, and @var{bottom} is one more than
  the bottommost row used by @var{window} and its mode-line.
  
! The edges include the space used by the window's scroll bar, display
! margins, fringes, header line, and mode line, if it has them.  Also,
! if the window has a neighbor on the right, its right edge value
! includes the width of the separator line between the window and that
! neighbor.  Since the width of the window does not include this
! separator, the width does not usually equal the difference between the
! right and left edges.
  @end defun
  
! @defun window-inside-edges &optional window
  This is similar to @code{window-edges}, but the edge values
  it returns include only the text area of the window.  They
  do not include the header line, mode line, scroll bar or
***************
*** 1877,1889 ****
  @end group
  @end example
  
! @defun window-pixel-edges window
  This function is like @code{window-edges} except that, on a graphical
  display, the edge values are measured in pixels instead of in
  character lines and columns.
  @end defun
  
! @defun window-inside-pixel-edges window
  This function is like @code{window-inside-edges} except that, on a
  graphical display, the edge values are measured in pixels instead of
  in character lines and columns.
--- 1898,1910 ----
  @end group
  @end example
  
! @defun window-pixel-edges &optional window
  This function is like @code{window-edges} except that, on a graphical
  display, the edge values are measured in pixels instead of in
  character lines and columns.
  @end defun
  
! @defun window-inside-pixel-edges &optional window
  This function is like @code{window-inside-edges} except that, on a
  graphical display, the edge values are measured in pixels instead of
  in character lines and columns.
***************
*** 1975,1980 ****
--- 1996,2004 ----
  display the whole text of the buffer, or if part of the contents are
  currently scrolled off screen, or if the window is not the full width of
  its frame, or if the window is the only window in its frame.
+ 
+ This command returns address@hidden if it actually shrank the window
+ and @code{nil} otherwise.
  @end deffn
  
  @tindex window-size-fixed
***************
*** 1988,1996 ****
  if the value is @code{width}, then only the window's width is fixed.
  Any other address@hidden value fixes both the width and the height.
  
! The usual way to use this variable is to give it a buffer-local value in
! a particular buffer.  That way, the windows (but usually there is only
! one) displaying that buffer have fixed size.
  
  Explicit size-change functions such as @code{enlarge-window}
  get an error if they would have to change a window size which is fixed.
--- 2012,2018 ----
  if the value is @code{width}, then only the window's width is fixed.
  Any other address@hidden value fixes both the width and the height.
  
! This variable automatically becomes buffer-local when set.
  
  Explicit size-change functions such as @code{enlarge-window}
  get an error if they would have to change a window size which is fixed.
***************
*** 2132,2138 ****
  
  If the frame which @var{configuration} was saved from is dead, all this
  function does is restore the three variables @code{window-min-height},
! @code{window-min-width} and @code{minibuffer-scroll-window}.
  
  Here is a way of using this function to get the same effect
  as @code{save-window-excursion}:
--- 2154,2161 ----
  
  If the frame which @var{configuration} was saved from is dead, all this
  function does is restore the three variables @code{window-min-height},
! @code{window-min-width} and @code{minibuffer-scroll-window}. In this
! case, the function returns @code{nil}.  Otherwise, it returns @code{t}.
  
  Here is a way of using this function to get the same effect
  as @code{save-window-excursion}:
***************
*** 2151,2160 ****
  @defspec save-window-excursion address@hidden
  This special form records the window configuration, executes @var{forms}
  in sequence, then restores the earlier window configuration.  The window
! configuration includes the value of point and the portion of the buffer
! that is visible.  It also includes the choice of selected window.
! However, it does not include the value of point in the current buffer;
! use @code{save-excursion} also, if you wish to preserve that.
  
  Don't use this construct when @code{save-selected-window} is sufficient.
  
--- 2174,2184 ----
  @defspec save-window-excursion address@hidden
  This special form records the window configuration, executes @var{forms}
  in sequence, then restores the earlier window configuration.  The window
! configuration includes, for each window, the value of point and the
! portion of the buffer that is visible.  It also includes the choice of
! selected window.  However, it does not include the value of point in
! the current buffer; use @code{save-excursion} also, if you wish to
! preserve that.
  
  Don't use this construct when @code{save-selected-window} is sufficient.
  
***************
*** 2275,2280 ****
--- 2299,2305 ----
  
  @defun window-redisplay-end-trigger &optional window
  This function returns @var{window}'s current end trigger position.
+ If @var{window} is @code{nil} or omitted, it uses the selected window.
  @end defun
  
  @defvar window-configuration-change-hook