[Emacs-diffs] trunk r116581: Document some changes about windows.

[Xue Fuqiao]

------------------------------------------------------------
revno: 116581 [merge]
revision-id: address@hidden
parent: address@hidden
parent: address@hidden
committer: Xue Fuqiao <address@hidden>
branch nick: trunk
timestamp: Thu 2014-02-27 22:10:55 +0800
message:
  Document some changes about windows.
  
  * doc/lispref/windows.texi (Window Sizes): Document `window-size'.
  (Display Action Functions): Document `display-buffer-at-bottom'.
  (Window Configurations): Minor fixes.
  
  * doc/lispref/modes.texi (Header Lines): Document `window-header-line-height'.
  
  * doc/lispref/display.texi (Scroll Bars): Document `window-scroll-bar-width'.
  
  * etc/NEWS: Related markup.
modified:
  doc/lispref/ChangeLog          changelog-20091113204419-o5vbwnq5f7feedwu-6155
  doc/lispref/display.texi       
display.texi-20091113204419-o5vbwnq5f7feedwu-6172
  doc/lispref/modes.texi         modes.texi-20091113204419-o5vbwnq5f7feedwu-6201
  doc/lispref/windows.texi       
windows.texi-20091113204419-o5vbwnq5f7feedwu-6224
  etc/NEWS                       news-20100311060928-aoit31wvzf25yr1z-1

=== modified file 'doc/lispref/ChangeLog'
--- a/doc/lispref/ChangeLog     2014-02-27 12:56:45 +0000
+++ b/doc/lispref/ChangeLog     2014-02-27 14:09:26 +0000
@@ -1,5 +1,13 @@
 2014-02-27  Xue Fuqiao  <address@hidden>
 
+       * windows.texi (Window Sizes): Document `window-size'.
+       (Display Action Functions): Document `display-buffer-at-bottom'.
+       (Window Configurations): Minor fixes.
+
+       * modes.texi (Header Lines): Document `window-header-line-height'.
+
+       * display.texi (Scroll Bars): Document `window-scroll-bar-width'.
+
        * windows.texi (Window Sizes, Resizing Windows): Document some
        pixelwise window operations.
 

=== modified file 'doc/lispref/display.texi'
--- a/doc/lispref/display.texi  2014-02-25 08:41:47 +0000
+++ b/doc/lispref/display.texi  2014-02-27 14:09:26 +0000
@@ -3849,6 +3849,12 @@
 @var{horizontal-type} is not actually meaningful.
 @end defun
 
address@hidden window-scroll-bar-width &optional window
+This function returns the width of @var{window}'s vertical scrollbar,
+in pixels.  @var{window} must be a live window.  If @var{window} is
address@hidden or omitted, it will be the selected window.
address@hidden defun
+
 If you don't specify these values for a window with
 @code{set-window-scroll-bars}, the buffer-local variables
 @code{scroll-bar-mode} and @code{scroll-bar-width} in the buffer being

=== modified file 'doc/lispref/modes.texi'
--- a/doc/lispref/modes.texi    2014-01-10 19:40:32 +0000
+++ b/doc/lispref/modes.texi    2014-02-27 14:09:26 +0000
@@ -2221,6 +2221,15 @@
 It is normally @code{nil}, so that ordinary buffers have no header line.
 @end defvar
 
+The function @code{window-header-line-height} returns the height of
+the header line:
+
address@hidden window-header-line-height &optional window
+Return the height of @var{window}'s header line, in pixels.
address@hidden must be a live window.  If @var{window} is @code{nil} or
+omitted, it will be the selected window.
address@hidden defun
+
   A window that is just one line tall never displays a header line.  A
 window that is two lines tall cannot display both a mode line and a
 header line at once; if it has a mode line, then it does not display a

=== modified file 'doc/lispref/windows.texi'
--- a/doc/lispref/windows.texi  2014-02-27 12:56:45 +0000
+++ b/doc/lispref/windows.texi  2014-02-27 14:09:26 +0000
@@ -413,6 +413,22 @@
 font or size, the reported height and width for that window may differ
 from the actual number of text lines or columns displayed within it.
 
address@hidden window-size &optional window horizontal pixelwise round
+This function returns the height or width of @var{window}.
address@hidden must be a valid window.  The default value of
address@hidden is the selected window.
+
+If @var{horizontal} is omitted or nil, return the total height of
address@hidden, in lines; otherwise return the total width in columns.
+
+The optional argument @var{pixelwise} means return size of
address@hidden, in pixels.
+
+The optional argument @var{round} is ignored if @var{pixelwise} is
address@hidden  Otherwise it is handled as for
address@hidden and @code{window-total-width}.
address@hidden defun
+
 @cindex window height
 @cindex height of a window
 @cindex total height of a window
@@ -2078,6 +2094,15 @@
 methods above, even if that window never showed @var{buffer} before.
 @end defun
 
address@hidden display-buffer-at-bottom buffer alist
+This function tries to display @var{buffer} in a window at the bottom
+of the selected frame.
+
+This either splits the window at the bottom of the frame or the
+frame's root window, or reuses an existing window at the bottom of the
+selected frame.
address@hidden defun
+
 @defun display-buffer-use-some-window buffer alist
 This function tries to display @var{buffer} by choosing an existing
 window and displaying the buffer in that window.  It can fail if all
@@ -3533,6 +3558,7 @@
 (@code{set-window-configuration} effectively clones the windows of a
 frame into the root window of that very frame only).
 
address@hidden window state
 @defun window-state-get &optional window writable
 This function returns the state of @var{window} as a Lisp object.  The
 argument @var{window} must be a valid window and defaults to the root
@@ -3554,10 +3580,11 @@
 the following function to restore the state of the window.
 
 @defun window-state-put state &optional window ignore
-This function puts the window state @var{state} into @var{window}.  The
-argument @var{state} should be the state of a window returned by an
-earlier invocation of @code{window-state-get}, see above.  The optional
-argument @var{window} must specify a valid window and defaults to the
+This function puts the window state @var{state} into @var{window}.
+The argument @var{state} should be the state of a window returned by
+an earlier invocation of @code{window-state-get}, see above.  The
+optional argument @var{window} can be either a live window or an
+internal window (@pxref{Windows and Frames}) and defaults to the
 selected one.  If @var{window} is not live, it is replaced by a live
 window before putting @var{state} into it.
 

=== modified file 'etc/NEWS'
--- a/etc/NEWS  2014-02-27 12:00:30 +0000
+++ b/etc/NEWS  2014-02-27 14:10:55 +0000
@@ -254,9 +254,11 @@
 and as such superfluous.  After being reimplemented in Lisp, its
 interactive form was mistakenly retained.
 
++++
 *** The functions `window-size' and `window-total-size' now have an
 optional argument to return a rounded size value.
 
++++
 *** `window-state-put' now allows to put a window state into internal
 windows too.
 
@@ -266,10 +268,12 @@
 using the scroll bar (i.e. dragging the thumb down even when the end
 of the buffer is visible).
 
++++
 *** New basic action function `display-buffer-in-previous-window' has
 `display-buffer' display a buffer in a window previously showing that
 buffer.
 
++++
 *** New basic action function `display-buffer-at-bottom' has
 `display-buffer' choose or make a window at the bottom of the selected
 frame.