diff options
| -rw-r--r-- | doc/lispref/ChangeLog | 11 | ||||
| -rw-r--r-- | doc/lispref/windows.texi | 195 |
2 files changed, 111 insertions, 95 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index cc3d2b080e6..0fcd8fca4db 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -1,3 +1,14 @@ | |||
| 1 | 2008-11-16 Martin Rudalics <rudalics@gmx.at> | ||
| 2 | |||
| 3 | * windows.texi (Splitting Windows, Deleting Windows) | ||
| 4 | (Selecting Windows, Cyclic Window Ordering) | ||
| 5 | (Buffers and Windows, Displaying Buffers, Choosing Window) | ||
| 6 | (Dedicated Windows, Window Point, Window Start and End) | ||
| 7 | (Textual Scrolling, Vertical Scrolling, Horizontal Scrolling) | ||
| 8 | (Size of Window, Resizing Windows, Window Configurations) | ||
| 9 | (Window Parameters): Avoid @var at beginning of sentences and | ||
| 10 | reword accordingly. | ||
| 11 | |||
| 1 | 2008-11-11 Lute Kamstra <lute@gnu.org> | 12 | 2008-11-11 Lute Kamstra <lute@gnu.org> |
| 2 | 13 | ||
| 3 | * files.texi (File Name Components): Fix file-name-extension | 14 | * files.texi (File Name Components): Fix file-name-extension |
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi index 9f1026bd1f5..c7b5497e43e 100644 --- a/doc/lispref/windows.texi +++ b/doc/lispref/windows.texi | |||
| @@ -113,8 +113,8 @@ previously visible in the window that was split. | |||
| 113 | 113 | ||
| 114 | @deffn Command split-window &optional window size horizontal | 114 | @deffn Command split-window &optional window size horizontal |
| 115 | This function splits a new window out of @var{window}'s screen area. It | 115 | This function splits a new window out of @var{window}'s screen area. It |
| 116 | returns the new window. @var{window} defaults to the selected window. | 116 | returns the new window. The default for @var{window} is the selected |
| 117 | When you split the selected window, it remains selected. | 117 | window. When you split the selected window, it remains selected. |
| 118 | 118 | ||
| 119 | If @var{horizontal} is non-@code{nil}, then @var{window} splits into two | 119 | If @var{horizontal} is non-@code{nil}, then @var{window} splits into two |
| 120 | side by side windows. The original window keeps the leftmost @var{size} | 120 | side by side windows. The original window keeps the leftmost @var{size} |
| @@ -329,21 +329,21 @@ using a deleted window as if it were live. | |||
| 329 | 329 | ||
| 330 | @deffn Command delete-window &optional window | 330 | @deffn Command delete-window &optional window |
| 331 | This function removes @var{window} from display and returns @code{nil}. | 331 | This function removes @var{window} from display and returns @code{nil}. |
| 332 | @var{window} defaults to the selected window. An error is signaled if | 332 | The default for @var{window} is the selected window. An error is |
| 333 | @var{window} is the only window on its frame. | 333 | signaled if @var{window} is the only window on its frame. |
| 334 | @end deffn | 334 | @end deffn |
| 335 | 335 | ||
| 336 | @deffn Command delete-other-windows &optional window | 336 | @deffn Command delete-other-windows &optional window |
| 337 | This function makes @var{window} the only window on its frame, by | 337 | This function makes @var{window} the only window on its frame, by |
| 338 | deleting the other windows in that frame. @var{window} defaults to the | 338 | deleting the other windows in that frame. The default for @var{window} |
| 339 | selected window. The return value is @code{nil}. | 339 | is the selected window. The return value is @code{nil}. |
| 340 | @end deffn | 340 | @end deffn |
| 341 | 341 | ||
| 342 | @deffn Command delete-windows-on &optional buffer-or-name frame | 342 | @deffn Command delete-windows-on &optional buffer-or-name frame |
| 343 | This function deletes all windows showing @var{buffer-or-name}. If | 343 | This function deletes all windows showing @var{buffer-or-name}. If |
| 344 | there are no windows showing @var{buffer-or-name}, it does nothing. | 344 | there are no windows showing @var{buffer-or-name}, it does nothing. The |
| 345 | @var{buffer-or-name} may be a buffer or the name of an existing buffer | 345 | optional argument @var{buffer-or-name} may be a buffer or the name of an |
| 346 | and defaults to the current buffer. | 346 | existing buffer and defaults to the current buffer. |
| 347 | 347 | ||
| 348 | @code{delete-windows-on} operates frame by frame. If a frame has | 348 | @code{delete-windows-on} operates frame by frame. If a frame has |
| 349 | several windows showing different buffers, then those showing | 349 | several windows showing different buffers, then those showing |
| @@ -356,11 +356,11 @@ showing @var{buffer-or-name} is dedicated to its buffer | |||
| 356 | (@pxref{Dedicated Windows}), and there are other frames left, that | 356 | (@pxref{Dedicated Windows}), and there are other frames left, that |
| 357 | window's frame is deleted. | 357 | window's frame is deleted. |
| 358 | 358 | ||
| 359 | The argument @var{frame} specifies which frames to operate on. This | 359 | The optional argument @var{frame} specifies which frames to operate on. |
| 360 | function does not use it in quite the same way as the other functions | 360 | This function does not use it in quite the same way as the other |
| 361 | which scan all windows; specifically, the values @code{t} and @code{nil} | 361 | functions which scan all windows; specifically, the values @code{t} and |
| 362 | have the opposite of their meanings in other functions. Here are the | 362 | @code{nil} have the opposite of their meanings in other functions. Here |
| 363 | full details: | 363 | are the full details: |
| 364 | 364 | ||
| 365 | @itemize @bullet | 365 | @itemize @bullet |
| 366 | @item | 366 | @item |
| @@ -453,10 +453,10 @@ The selected window can be the least recently used window if it is the | |||
| 453 | only window. A newly created window becomes the least recently used | 453 | only window. A newly created window becomes the least recently used |
| 454 | window until it is selected. A minibuffer window is never a candidate. | 454 | window until it is selected. A minibuffer window is never a candidate. |
| 455 | A dedicated window (@pxref{Dedicated Windows}) is never a candidate | 455 | A dedicated window (@pxref{Dedicated Windows}) is never a candidate |
| 456 | unless the @var{dedicated} argument is non-@code{nil}, so if all | 456 | unless the optional argument @var{dedicated} is non-@code{nil}. |
| 457 | existing windows are dedicated, the function returns @code{nil}. | ||
| 458 | 457 | ||
| 459 | The argument @var{frame} specifies which windows are considered. | 458 | The optional argument @var{frame} specifies which windows are |
| 459 | considered. | ||
| 460 | 460 | ||
| 461 | @itemize @bullet | 461 | @itemize @bullet |
| 462 | @item | 462 | @item |
| @@ -477,15 +477,14 @@ This function returns the window with the largest area (height times | |||
| 477 | width). If there are no side-by-side windows, then this is the window | 477 | width). If there are no side-by-side windows, then this is the window |
| 478 | with the most lines. A minibuffer window is never a candidate. A | 478 | with the most lines. A minibuffer window is never a candidate. A |
| 479 | dedicated window (@pxref{Dedicated Windows}) is never a candidate unless | 479 | dedicated window (@pxref{Dedicated Windows}) is never a candidate unless |
| 480 | the @var{dedicated} argument is non-@code{nil}, so if all existing | 480 | the optional argument @var{dedicated} is non-@code{nil}. |
| 481 | windows are dedicated, the function returns @code{nil}. | ||
| 482 | 481 | ||
| 483 | If there are two candidate windows of the same size, this function | 482 | If there are two candidate windows of the same size, this function |
| 484 | prefers the one that comes first in the cyclic ordering of windows, | 483 | prefers the one that comes first in the cyclic ordering of windows, |
| 485 | starting from the selected window (@pxref{Cyclic Window Ordering}). | 484 | starting from the selected window (@pxref{Cyclic Window Ordering}). |
| 486 | 485 | ||
| 487 | The argument @var{frame} specifies which set of windows to consider, see | 486 | The optional argument @var{frame} specifies which set of windows to |
| 488 | @code{get-lru-window} above. | 487 | consider, see @code{get-lru-window} above. |
| 489 | @end defun | 488 | @end defun |
| 490 | 489 | ||
| 491 | @cindex window that satisfies a predicate | 490 | @cindex window that satisfies a predicate |
| @@ -531,22 +530,23 @@ In general, within each set of siblings at any level in the window tree | |||
| 531 | @cindex minibuffer window, and @code{next-window} | 530 | @cindex minibuffer window, and @code{next-window} |
| 532 | This function returns the window following @var{window} in the cyclic | 531 | This function returns the window following @var{window} in the cyclic |
| 533 | ordering of windows. This is the window @kbd{C-x o} selects if typed | 532 | ordering of windows. This is the window @kbd{C-x o} selects if typed |
| 534 | when @var{window} is selected. @var{window} defaults to the selected | 533 | when @var{window} is selected. The default for @var{window} is the |
| 535 | window. | 534 | selected window. |
| 536 | 535 | ||
| 537 | The value of the argument @var{minibuf} specifies whether the minibuffer | 536 | The value of the optional argument @var{minibuf} specifies whether the |
| 538 | is included in the window order. Normally, when @var{minibuf} is | 537 | minibuffer is included in the window order. Normally, when |
| 539 | @code{nil}, the minibuffer is included only if it is currently | 538 | @var{minibuf} is @code{nil}, the minibuffer is included only if it is |
| 540 | ``active''; this matches the behavior of @kbd{C-x o}. (The minibuffer | 539 | currently ``active''; this matches the behavior of @kbd{C-x o}. (The |
| 541 | window is active while the minibuffer is in use; see @ref{Minibuffers}.) | 540 | minibuffer window is active while the minibuffer is in use; see |
| 541 | @ref{Minibuffers}.) | ||
| 542 | 542 | ||
| 543 | If @var{minibuf} is @code{t}, the cyclic ordering includes the | 543 | If @var{minibuf} is @code{t}, the cyclic ordering includes the |
| 544 | minibuffer window even if it is not active. If @var{minibuf} is neither | 544 | minibuffer window even if it is not active. If @var{minibuf} is neither |
| 545 | @code{t} nor @code{nil}, the minibuffer window is not included even if | 545 | @code{t} nor @code{nil}, the minibuffer window is not included even if |
| 546 | it is active. | 546 | it is active. |
| 547 | 547 | ||
| 548 | The argument @var{all-frames} specifies which frames to consider. Here | 548 | The optional argument @var{all-frames} specifies which frames to |
| 549 | are the possible values and their meanings: | 549 | consider. Here are the possible values and their meanings: |
| 550 | 550 | ||
| 551 | @table @asis | 551 | @table @asis |
| 552 | @item @code{nil} | 552 | @item @code{nil} |
| @@ -607,7 +607,7 @@ If @var{count} is zero, it does not skip any window, thus re-selecting | |||
| 607 | the selected window. In an interactive call, @var{count} is the numeric | 607 | the selected window. In an interactive call, @var{count} is the numeric |
| 608 | prefix argument. | 608 | prefix argument. |
| 609 | 609 | ||
| 610 | The argument @var{all-frames} has the same meaning as in | 610 | The optional argument @var{all-frames} has the same meaning as in |
| 611 | @code{next-window}, but the @var{minibuf} argument of @code{next-window} | 611 | @code{next-window}, but the @var{minibuf} argument of @code{next-window} |
| 612 | is always effectively @code{nil}. This function returns @code{nil}. | 612 | is always effectively @code{nil}. This function returns @code{nil}. |
| 613 | @end deffn | 613 | @end deffn |
| @@ -625,8 +625,8 @@ for details. | |||
| 625 | 625 | ||
| 626 | @defun window-list &optional frame minibuf window | 626 | @defun window-list &optional frame minibuf window |
| 627 | This function returns a list of all windows on @var{frame}, starting | 627 | This function returns a list of all windows on @var{frame}, starting |
| 628 | with @var{window}. @var{frame} defaults to the selected frame; | 628 | with @var{window}. The default for @var{frame} is the selected frame; |
| 629 | @var{window} defaults to the selected window. | 629 | the default for @var{window} is the selected window. |
| 630 | 630 | ||
| 631 | The value of @var{minibuf} specifies if the minibuffer window shall be | 631 | The value of @var{minibuf} specifies if the minibuffer window shall be |
| 632 | included in the result list. If @var{minibuf} is @code{t}, the result | 632 | included in the result list. If @var{minibuf} is @code{t}, the result |
| @@ -657,10 +657,13 @@ here when you need complete control. | |||
| 657 | 657 | ||
| 658 | @defun set-window-buffer window buffer-or-name &optional keep-margins | 658 | @defun set-window-buffer window buffer-or-name &optional keep-margins |
| 659 | This function makes @var{window} display @var{buffer-or-name} as its | 659 | This function makes @var{window} display @var{buffer-or-name} as its |
| 660 | contents. It returns @code{nil}. @var{buffer-or-name} must be a | 660 | contents. It returns @code{nil}. The default for @var{window} is the |
| 661 | buffer, or the name of an existing buffer. This is the fundamental | 661 | selected window. The argument @var{buffer-or-name} must specify a |
| 662 | primitive for changing which buffer is displayed in a window, and all | 662 | buffer or the name of an existing buffer. |
| 663 | ways of doing that call this function. | 663 | |
| 664 | @code{set-window-buffer} is the fundamental primitive for changing which | ||
| 665 | buffer is displayed in a window, and all ways of doing that call this | ||
| 666 | function. | ||
| 664 | 667 | ||
| 665 | @example | 668 | @example |
| 666 | @group | 669 | @group |
| @@ -675,12 +678,12 @@ settings based on the local variables of that buffer. | |||
| 675 | However, if @var{keep-margins} is non-@code{nil}, display margins and | 678 | However, if @var{keep-margins} is non-@code{nil}, display margins and |
| 676 | fringe widths of @var{window} remain unchanged. @xref{Fringes}. | 679 | fringe widths of @var{window} remain unchanged. @xref{Fringes}. |
| 677 | 680 | ||
| 678 | This function signals an error when @var{window} is @dfn{strongly} | 681 | @code{set-window-buffer} signals an error when @var{window} is |
| 679 | dedicated to its buffer (@pxref{Dedicated Windows}) and does not already | 682 | @dfn{strongly} dedicated to its buffer (@pxref{Dedicated Windows}) and |
| 680 | display @var{buffer-or-name}. | 683 | does not already display @var{buffer-or-name}. |
| 681 | 684 | ||
| 682 | This function runs @code{window-scroll-functions} before running | 685 | Note that this function runs @code{window-scroll-functions} before |
| 683 | @code{window-configuration-change-hook}. | 686 | running @code{window-configuration-change-hook}. |
| 684 | @end defun | 687 | @end defun |
| 685 | 688 | ||
| 686 | @defvar buffer-display-count | 689 | @defvar buffer-display-count |
| @@ -690,8 +693,8 @@ displayed in a window. It is incremented each time | |||
| 690 | @end defvar | 693 | @end defvar |
| 691 | 694 | ||
| 692 | @defun window-buffer &optional window | 695 | @defun window-buffer &optional window |
| 693 | This function returns the buffer that @var{window} is displaying. | 696 | This function returns the buffer that @var{window} is displaying. The |
| 694 | @var{window} defaults to the selected window. | 697 | default for @var{window} is the selected window. |
| 695 | 698 | ||
| 696 | @example | 699 | @example |
| 697 | @group | 700 | @group |
| @@ -708,9 +711,9 @@ several such windows, then the function returns the first one in the | |||
| 708 | cyclic ordering of windows, starting from the selected window. | 711 | cyclic ordering of windows, starting from the selected window. |
| 709 | @xref{Cyclic Window Ordering}. | 712 | @xref{Cyclic Window Ordering}. |
| 710 | 713 | ||
| 711 | @var{BUFFER-OR-NAME} may be a buffer or a buffer name and defaults to | 714 | The argument @var{BUFFER-OR-NAME} may be a buffer or a buffer name and |
| 712 | the current buffer. The argument @var{all-frames} specifies which | 715 | defaults to the current buffer. The optional argument @var{all-frames} |
| 713 | windows to consider: | 716 | specifies which windows to consider: |
| 714 | 717 | ||
| 715 | @itemize @bullet | 718 | @itemize @bullet |
| 716 | @item | 719 | @item |
| @@ -734,8 +737,8 @@ compatible with the other functions. | |||
| 734 | 737 | ||
| 735 | @defun get-buffer-window-list &optional buffer-or-name minibuf all-frames | 738 | @defun get-buffer-window-list &optional buffer-or-name minibuf all-frames |
| 736 | This function returns a list of all windows currently displaying | 739 | This function returns a list of all windows currently displaying |
| 737 | @var{buffer-or-name}. @var{buffer-or-name} may be a buffer or the name | 740 | @var{buffer-or-name}. The argument @var{buffer-or-name} may be a buffer |
| 738 | of an existing buffer and defaults to the current buffer. | 741 | or the name of an existing buffer and defaults to the current buffer. |
| 739 | 742 | ||
| 740 | The two remaining arguments work like the same-named arguments of | 743 | The two remaining arguments work like the same-named arguments of |
| 741 | @code{next-window}; they are @emph{not} like the optional arguments of | 744 | @code{next-window}; they are @emph{not} like the optional arguments of |
| @@ -783,7 +786,7 @@ This function makes @var{buffer-or-name} the current buffer, and also | |||
| 783 | displays the buffer in the selected window. This means that a human can | 786 | displays the buffer in the selected window. This means that a human can |
| 784 | see the buffer and subsequent keyboard commands will apply to it. | 787 | see the buffer and subsequent keyboard commands will apply to it. |
| 785 | Contrast this with @code{set-buffer}, which makes @var{buffer-or-name} | 788 | Contrast this with @code{set-buffer}, which makes @var{buffer-or-name} |
| 786 | the current buffer but does not display it in the selected window, | 789 | the current buffer but does not display it in the selected window; |
| 787 | see @ref{Current Buffer}. | 790 | see @ref{Current Buffer}. |
| 788 | 791 | ||
| 789 | If @var{buffer-or-name} is @code{nil}, @code{switch-to-buffer} chooses a | 792 | If @var{buffer-or-name} is @code{nil}, @code{switch-to-buffer} chooses a |
| @@ -877,8 +880,8 @@ other buffer. In the usual applications of this function, you | |||
| 877 | don't care which other buffer is used; you just want to make sure that | 880 | don't care which other buffer is used; you just want to make sure that |
| 878 | @var{buffer-or-name} is no longer displayed. | 881 | @var{buffer-or-name} is no longer displayed. |
| 879 | 882 | ||
| 880 | @var{buffer-or-name} may be a buffer or the name of an existing buffer | 883 | The argument @var{buffer-or-name} may be a buffer or the name of an |
| 881 | and defaults to the current buffer. | 884 | existing buffer and defaults to the current buffer. |
| 882 | 885 | ||
| 883 | If a window displaying @var{buffer-or-name} is dedicated | 886 | If a window displaying @var{buffer-or-name} is dedicated |
| 884 | (@pxref{Dedicated Windows}), and is not the only window on its frame, | 887 | (@pxref{Dedicated Windows}), and is not the only window on its frame, |
| @@ -903,8 +906,8 @@ to customize it. | |||
| 903 | This command makes @var{buffer-or-name} appear in some window, but it | 906 | This command makes @var{buffer-or-name} appear in some window, but it |
| 904 | does not select that window and does not make the buffer specified by | 907 | does not select that window and does not make the buffer specified by |
| 905 | @var{buffer-or-name} current. The identity of the selected window is | 908 | @var{buffer-or-name} current. The identity of the selected window is |
| 906 | unaltered by this function. @var{buffer-or-name} must be a buffer, or | 909 | unaltered by this function. The argument @var{buffer-or-name} must be a |
| 907 | the name of an existing buffer. | 910 | buffer or the name of an existing buffer. |
| 908 | 911 | ||
| 909 | @var{not-this-window} non-@code{nil} means to display the specified | 912 | @var{not-this-window} non-@code{nil} means to display the specified |
| 910 | buffer in a window other than the selected one, even if it is already | 913 | buffer in a window other than the selected one, even if it is already |
| @@ -916,11 +919,11 @@ does nothing. | |||
| 916 | @code{display-buffer} returns the window chosen to display | 919 | @code{display-buffer} returns the window chosen to display |
| 917 | @var{buffer-or-name}. | 920 | @var{buffer-or-name}. |
| 918 | 921 | ||
| 919 | If the argument @var{frame} is non-@code{nil}, it specifies which frames | 922 | If the optional argument @var{frame} is non-@code{nil}, it specifies |
| 920 | to check when deciding whether the buffer is already displayed. If the | 923 | which frames to check when deciding whether the buffer is already |
| 921 | buffer is already displayed in some window on one of these frames, | 924 | displayed. If the buffer is already displayed in some window on one of |
| 922 | @code{display-buffer} simply returns that window. Here are the possible | 925 | these frames, @code{display-buffer} simply returns that window. Here |
| 923 | values of @var{frame}: | 926 | are the possible values of @var{frame}: |
| 924 | 927 | ||
| 925 | @itemize @bullet | 928 | @itemize @bullet |
| 926 | @item | 929 | @item |
| @@ -1214,8 +1217,8 @@ This function returns non-@code{nil} if @var{window} is dedicated to its | |||
| 1214 | buffer and @code{nil} otherwise. More precisely, the return value is | 1217 | buffer and @code{nil} otherwise. More precisely, the return value is |
| 1215 | the value assigned by the last call of @code{set-window-dedicated-p} for | 1218 | the value assigned by the last call of @code{set-window-dedicated-p} for |
| 1216 | @var{window} or @code{nil} if that function was never called with | 1219 | @var{window} or @code{nil} if that function was never called with |
| 1217 | @var{window} as its argument. @var{window} defaults to the selected | 1220 | @var{window} as its argument. The default for @var{window} is the |
| 1218 | window. | 1221 | selected window. |
| 1219 | @end defun | 1222 | @end defun |
| 1220 | 1223 | ||
| 1221 | @defun set-window-dedicated-p window flag | 1224 | @defun set-window-dedicated-p window flag |
| @@ -1269,8 +1272,8 @@ position of point in that buffer. | |||
| 1269 | @defun window-point &optional window | 1272 | @defun window-point &optional window |
| 1270 | This function returns the current position of point in @var{window}. | 1273 | This function returns the current position of point in @var{window}. |
| 1271 | For a nonselected window, this is the value point would have (in that | 1274 | For a nonselected window, this is the value point would have (in that |
| 1272 | window's buffer) if that window were selected. @var{window} defaults to | 1275 | window's buffer) if that window were selected. The default for |
| 1273 | the selected window. | 1276 | @var{window} is the selected window. |
| 1274 | 1277 | ||
| 1275 | When @var{window} is the selected window and its buffer is also the | 1278 | When @var{window} is the selected window and its buffer is also the |
| 1276 | current buffer, the value returned is the same as point in that buffer. | 1279 | current buffer, the value returned is the same as point in that buffer. |
| @@ -1344,7 +1347,7 @@ description of @code{count-lines}. @xref{Definition of count-lines}. | |||
| 1344 | @cindex window end position | 1347 | @cindex window end position |
| 1345 | @defun window-end &optional window update | 1348 | @defun window-end &optional window update |
| 1346 | This function returns the position where display of its buffer ends in | 1349 | This function returns the position where display of its buffer ends in |
| 1347 | @var{window}. @var{window} defaults to the selected window. | 1350 | @var{window}. The default for @var{window} is the selected window. |
| 1348 | 1351 | ||
| 1349 | Simply changing the buffer text or moving point does not update the | 1352 | Simply changing the buffer text or moving point does not update the |
| 1350 | value that @code{window-end} returns. The value is updated only when | 1353 | value that @code{window-end} returns. The value is updated only when |
| @@ -1470,13 +1473,13 @@ Here is an example: | |||
| 1470 | @end defun | 1473 | @end defun |
| 1471 | 1474 | ||
| 1472 | @defun window-line-height &optional line window | 1475 | @defun window-line-height &optional line window |
| 1473 | This function returns information about text line @var{line} in @var{window}. | 1476 | This function returns the height of text line @var{line} in |
| 1474 | If @var{line} is one of @code{header-line} or @code{mode-line}, | 1477 | @var{window}. If @var{line} is one of @code{header-line} or |
| 1475 | @code{window-line-height} returns information about the corresponding | 1478 | @code{mode-line}, @code{window-line-height} returns information about |
| 1476 | line of the window. Otherwise, @var{line} is a text line number | 1479 | the corresponding line of the window. Otherwise, @var{line} is a text |
| 1477 | starting from 0. A negative number counts from the end of the window. | 1480 | line number starting from 0. A negative number counts from the end of |
| 1478 | The argument @var{line} defaults to the current line in @var{window}; | 1481 | the window. The default for @var{line} is the current line in |
| 1479 | @var{window}, to the selected window. | 1482 | @var{window}; the default for @var{window} is the selected window. |
| 1480 | 1483 | ||
| 1481 | If the display is not up to date, @code{window-line-height} returns | 1484 | If the display is not up to date, @code{window-line-height} returns |
| 1482 | @code{nil}. In that case, @code{pos-visible-in-window-p} may be used | 1485 | @code{nil}. In that case, @code{pos-visible-in-window-p} may be used |
| @@ -1726,8 +1729,8 @@ could scroll just part of the way through a tall line or an image. | |||
| 1726 | 1729 | ||
| 1727 | @defun window-vscroll &optional window pixels-p | 1730 | @defun window-vscroll &optional window pixels-p |
| 1728 | This function returns the current vertical scroll position of | 1731 | This function returns the current vertical scroll position of |
| 1729 | @var{window}. @var{window} defaults to the selected window. If | 1732 | @var{window}. The default for @var{window} is the selected window. |
| 1730 | @var{pixels-p} is non-@code{nil}, the return value is measured in | 1733 | If @var{pixels-p} is non-@code{nil}, the return value is measured in |
| 1731 | pixels, rather than in units of the normal line height. | 1734 | pixels, rather than in units of the normal line height. |
| 1732 | 1735 | ||
| 1733 | @example | 1736 | @example |
| @@ -1845,8 +1848,8 @@ of scrolling, this works just like @code{scroll-left}. | |||
| 1845 | @defun window-hscroll &optional window | 1848 | @defun window-hscroll &optional window |
| 1846 | This function returns the total leftward horizontal scrolling of | 1849 | This function returns the total leftward horizontal scrolling of |
| 1847 | @var{window}---the number of columns by which the text in @var{window} | 1850 | @var{window}---the number of columns by which the text in @var{window} |
| 1848 | is scrolled left past the left margin. @var{window} defaults to the | 1851 | is scrolled left past the left margin. The default for |
| 1849 | selected window. | 1852 | @var{window} is the selected window. |
| 1850 | 1853 | ||
| 1851 | The return value is never negative. It is zero when no horizontal | 1854 | The return value is never negative. It is zero when no horizontal |
| 1852 | scrolling has been done in @var{window} (which is usually the case). | 1855 | scrolling has been done in @var{window} (which is usually the case). |
| @@ -1925,8 +1928,8 @@ characters that separates side-by-side windows. | |||
| 1925 | This function returns the number of lines in @var{window}, including its | 1928 | This function returns the number of lines in @var{window}, including its |
| 1926 | mode line and header line, if any. If @var{window} fills its entire | 1929 | mode line and header line, if any. If @var{window} fills its entire |
| 1927 | frame except for the echo area, this is typically one less than the | 1930 | frame except for the echo area, this is typically one less than the |
| 1928 | value of @code{frame-height} on that frame. @var{window} defaults to | 1931 | value of @code{frame-height} on that frame. The default for |
| 1929 | the selected window. | 1932 | @var{window} is the selected window. |
| 1930 | 1933 | ||
| 1931 | @example | 1934 | @example |
| 1932 | @group | 1935 | @group |
| @@ -1950,8 +1953,8 @@ mode line (if any) or the header line (if any). | |||
| 1950 | @end defun | 1953 | @end defun |
| 1951 | 1954 | ||
| 1952 | @defun window-width &optional window | 1955 | @defun window-width &optional window |
| 1953 | This function returns the number of columns in @var{window}. | 1956 | This function returns the number of columns in @var{window}. The |
| 1954 | @var{window} defaults to the selected window. | 1957 | default for @var{window} is the selected window. |
| 1955 | 1958 | ||
| 1956 | The return value does not include the window's scroll bar or the column | 1959 | The return value does not include the window's scroll bar or the column |
| 1957 | of @samp{|} characters that separates side-by-side windows. Moreover, | 1960 | of @samp{|} characters that separates side-by-side windows. Moreover, |
| @@ -1971,13 +1974,13 @@ whether a window is a wide as the containing frame. Use the function | |||
| 1971 | 1974 | ||
| 1972 | @defun window-full-width-p &optional window | 1975 | @defun window-full-width-p &optional window |
| 1973 | This function returns non-@code{nil} if @var{window} is as wide as the | 1976 | This function returns non-@code{nil} if @var{window} is as wide as the |
| 1974 | frame that contains it; otherwise @code{nil}. @var{window} defaults to | 1977 | frame that contains it; otherwise @code{nil}. The default for |
| 1975 | the selected window. | 1978 | @var{window} is the selected window. |
| 1976 | @end defun | 1979 | @end defun |
| 1977 | 1980 | ||
| 1978 | @defun window-edges &optional window | 1981 | @defun window-edges &optional window |
| 1979 | This function returns a list of the edge coordinates of @var{window}. | 1982 | This function returns a list of the edge coordinates of @var{window}. |
| 1980 | @var{window} defaults to the selected window. | 1983 | The default for @var{window} is the selected window. |
| 1981 | 1984 | ||
| 1982 | The order of the list is @code{(@var{left} @var{top} @var{right} | 1985 | The order of the list is @code{(@var{left} @var{top} @var{right} |
| 1983 | @var{bottom})}, all elements relative to 0, 0 at the top left corner of | 1986 | @var{bottom})}, all elements relative to 0, 0 at the top left corner of |
| @@ -2163,7 +2166,8 @@ function returns @code{nil}. | |||
| 2163 | 2166 | ||
| 2164 | @defun fit-window-to-buffer &optional window max-height min-height | 2167 | @defun fit-window-to-buffer &optional window max-height min-height |
| 2165 | This function makes @var{window} the right height to display its | 2168 | This function makes @var{window} the right height to display its |
| 2166 | contents exactly. @var{window} defaults to the selected window. | 2169 | contents exactly. The default for @var{window} is the selected |
| 2170 | window. | ||
| 2167 | 2171 | ||
| 2168 | The argument @var{max-height} specifies the maximum height the window | 2172 | The argument @var{max-height} specifies the maximum height the window |
| 2169 | is allowed to be; @code{nil} means use the frame height. The argument | 2173 | is allowed to be; @code{nil} means use the frame height. The argument |
| @@ -2175,8 +2179,8 @@ values include the mode line and/or header line. | |||
| 2175 | @deffn Command shrink-window-if-larger-than-buffer &optional window | 2179 | @deffn Command shrink-window-if-larger-than-buffer &optional window |
| 2176 | This command shrinks @var{window} vertically to be as small as possible | 2180 | This command shrinks @var{window} vertically to be as small as possible |
| 2177 | while still showing the full contents of its buffer---but not less than | 2181 | while still showing the full contents of its buffer---but not less than |
| 2178 | @code{window-min-height} lines. @var{window} defaults to the selected | 2182 | @code{window-min-height} lines. The default for @var{window} is |
| 2179 | window. | 2183 | the selected window. |
| 2180 | 2184 | ||
| 2181 | However, this command does nothing if the window is already too small to | 2185 | However, this command does nothing if the window is already too small to |
| 2182 | display the whole text of the buffer, or if part of the contents are | 2186 | display the whole text of the buffer, or if part of the contents are |
| @@ -2223,8 +2227,8 @@ before it is automatically deleted. Making a window smaller than | |||
| 2223 | @code{window-min-height} automatically deletes it, and no window may be | 2227 | @code{window-min-height} automatically deletes it, and no window may be |
| 2224 | created shorter than this. The value is measured in line units. When | 2228 | created shorter than this. The value is measured in line units. When |
| 2225 | the window wants a mode line and/or a header line, they are counted as | 2229 | the window wants a mode line and/or a header line, they are counted as |
| 2226 | one line each. The default value of this variable is @code{4}. A value | 2230 | one line each. The default value is @code{4}. A value less than |
| 2227 | less than @code{1} is ignored. | 2231 | @code{1} is ignored. |
| 2228 | @end defopt | 2232 | @end defopt |
| 2229 | 2233 | ||
| 2230 | @defopt window-min-width | 2234 | @defopt window-min-width |
| @@ -2367,7 +2371,8 @@ window configuration; see @ref{Frame Configurations}. | |||
| 2367 | 2371 | ||
| 2368 | @defun current-window-configuration &optional frame | 2372 | @defun current-window-configuration &optional frame |
| 2369 | This function returns a new object representing @var{frame}'s current | 2373 | This function returns a new object representing @var{frame}'s current |
| 2370 | window configuration. @var{frame} defaults to the selected frame. | 2374 | window configuration. The default for @var{frame} is the selected |
| 2375 | frame. | ||
| 2371 | @end defun | 2376 | @end defun |
| 2372 | 2377 | ||
| 2373 | @defun set-window-configuration configuration | 2378 | @defun set-window-configuration configuration |
| @@ -2475,22 +2480,22 @@ This sections describes how window parameters can be used to associate | |||
| 2475 | additional information with windows. | 2480 | additional information with windows. |
| 2476 | 2481 | ||
| 2477 | @defun window-parameter window parameter | 2482 | @defun window-parameter window parameter |
| 2478 | This function returns @var{window}'s value for @var{parameter}. | 2483 | This function returns @var{window}'s value for @var{parameter}. The |
| 2479 | @var{window} defaults to the selected window. If @var{window} has no | 2484 | default for @var{window} is the selected window. If @var{window} |
| 2480 | setting for @var{parameter}, this function returns @code{nil}. | 2485 | has no setting for @var{parameter}, this function returns @code{nil}. |
| 2481 | @end defun | 2486 | @end defun |
| 2482 | 2487 | ||
| 2483 | @defun window-parameters &optional window | 2488 | @defun window-parameters &optional window |
| 2484 | This function returns all parameters of @var{window} and their values. | 2489 | This function returns all parameters of @var{window} and their values. |
| 2485 | @var{window} defaults to the selected window. The return value is an | 2490 | The default for @var{window} is the selected window. The return value |
| 2486 | association list of elements of the form @code{(@var{parameter} | 2491 | is an association list of elements of the form @code{(@var{parameter} |
| 2487 | . @var{value})}. | 2492 | . @var{value})}. |
| 2488 | @end defun | 2493 | @end defun |
| 2489 | 2494 | ||
| 2490 | @defun set-window-parameter window parameter value | 2495 | @defun set-window-parameter window parameter value |
| 2491 | This function sets @var{window}'s value of @var{parameter} to | 2496 | This function sets @var{window}'s value of @var{parameter} to |
| 2492 | @var{value} and returns @var{value}. @var{window} defaults to the | 2497 | @var{value} and returns @var{value}. The default for @var{window} |
| 2493 | selected window. | 2498 | is the selected window. |
| 2494 | @end defun | 2499 | @end defun |
| 2495 | 2500 | ||
| 2496 | Currently, window parameters are not saved in window configurations and | 2501 | Currently, window parameters are not saved in window configurations and |