diff options
| author | Martin Rudalics | 2009-05-17 12:11:18 +0000 |
|---|---|---|
| committer | Martin Rudalics | 2009-05-17 12:11:18 +0000 |
| commit | b87661795f9b38291ef2fe8c311362dd7e2d794b (patch) | |
| tree | e9741e2d9a730b70a2e443cc983ed95048ae877b /doc | |
| parent | 2793b89ee485a0efa4210c6263bd845064e70adb (diff) | |
| download | emacs-b87661795f9b38291ef2fe8c311362dd7e2d794b.tar.gz emacs-b87661795f9b38291ef2fe8c311362dd7e2d794b.zip | |
(Selecting Windows): Clarify descriptions of
with-selected-window and get-lru-window.
(Cyclic Window Ordering): Refer to particular frame when talking
about how splitting affects the ordering.
(Displaying Buffers): Fix descriptions of switch-to-buffer and
switch-to-buffer-other-window. Explain how setting of
display-buffer-reuse-frames affects pop-to-buffer.
(Choosing Window): Clarify some details in descriptions of
display-buffer-reuse-frames, pop-up-frames, and
pop-up-frame-function.
(Dedicated Windows): Clarify some details.
(Textual Scrolling): Replace term vscroll by term vertical
scroll position.
(Vertical Scrolling): Fix typo.
(Window Hooks): Relate text on jit-lock-register to window
scrolling and size changes.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lispref/ChangeLog | 19 | ||||
| -rw-r--r-- | doc/lispref/windows.texi | 118 |
2 files changed, 76 insertions, 61 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index 72d437c7f6a..43ee966a463 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -1,3 +1,22 @@ | |||
| 1 | 2009-05-17 Martin Rudalics <rudalics@gmx.at> | ||
| 2 | |||
| 3 | * windows.texi (Selecting Windows): Clarify descriptions of | ||
| 4 | with-selected-window and get-lru-window. | ||
| 5 | (Cyclic Window Ordering): Refer to particular frame when talking | ||
| 6 | about how splitting affects the ordering. | ||
| 7 | (Displaying Buffers): Fix descriptions of switch-to-buffer and | ||
| 8 | switch-to-buffer-other-window. Explain how setting of | ||
| 9 | display-buffer-reuse-frames affects pop-to-buffer. | ||
| 10 | (Choosing Window): Clarify some details in descriptions of | ||
| 11 | display-buffer-reuse-frames, pop-up-frames, and | ||
| 12 | pop-up-frame-function. | ||
| 13 | (Dedicated Windows): Clarify some details. | ||
| 14 | (Textual Scrolling): Replace term vscroll by term vertical | ||
| 15 | scroll position. | ||
| 16 | (Vertical Scrolling): Fix typo. | ||
| 17 | (Window Hooks): Relate text on jit-lock-register to window | ||
| 18 | scrolling and size changes. | ||
| 19 | |||
| 1 | 2009-05-14 Chong Yidong <cyd@stupidchicken.com> | 20 | 2009-05-14 Chong Yidong <cyd@stupidchicken.com> |
| 2 | 21 | ||
| 3 | * frames.texi (Initial Parameters): Clarify what the initial | 22 | * frames.texi (Initial Parameters): Clarify what the initial |
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi index 6f9c8dfb24e..8bc51d4b646 100644 --- a/doc/lispref/windows.texi +++ b/doc/lispref/windows.texi | |||
| @@ -436,8 +436,7 @@ This macro selects @var{window}, executes @var{forms} in sequence, then | |||
| 436 | restores the previously selected window and current buffer. The ordering | 436 | restores the previously selected window and current buffer. The ordering |
| 437 | of recently selected windows and the buffer list remain unchanged unless | 437 | of recently selected windows and the buffer list remain unchanged unless |
| 438 | you deliberately change them within @var{forms}, for example, by calling | 438 | you deliberately change them within @var{forms}, for example, by calling |
| 439 | @code{select-window} with argument @var{norecord} @code{nil} or omitted | 439 | @code{select-window} with argument @var{norecord} @code{nil}. |
| 440 | there. | ||
| 441 | @end defmac | 440 | @end defmac |
| 442 | 441 | ||
| 443 | @cindex finding windows | 442 | @cindex finding windows |
| @@ -446,14 +445,13 @@ offering various criteria for the choice. | |||
| 446 | 445 | ||
| 447 | @defun get-lru-window &optional frame dedicated | 446 | @defun get-lru-window &optional frame dedicated |
| 448 | This function returns the window least recently ``used'' (that is, | 447 | This function returns the window least recently ``used'' (that is, |
| 449 | selected). If any full-width windows are present, it only considers | 448 | selected) among a set of candidate windows. If any full-width windows |
| 450 | these. | 449 | are present, it only considers these. |
| 451 | 450 | ||
| 452 | The selected window can be the least recently used window if it is the | 451 | The selected window is returned if it is the only candidate. A |
| 453 | only window. A newly created window becomes the least recently used | 452 | minibuffer window is never a candidate. A dedicated window |
| 454 | window until it is selected. A minibuffer window is never a candidate. | 453 | (@pxref{Dedicated Windows}) is never a candidate unless the optional |
| 455 | A dedicated window (@pxref{Dedicated Windows}) is never a candidate | 454 | argument @var{dedicated} is non-@code{nil}. |
| 456 | unless the optional argument @var{dedicated} is non-@code{nil}. | ||
| 457 | 455 | ||
| 458 | The optional argument @var{frame} specifies which windows are | 456 | The optional argument @var{frame} specifies which windows are |
| 459 | considered. | 457 | considered. |
| @@ -514,9 +512,9 @@ some other window, it moves through the windows on the screen in a | |||
| 514 | specific order. For any given configuration of windows, this order | 512 | specific order. For any given configuration of windows, this order |
| 515 | never varies. It is called the @dfn{cyclic ordering of windows}. | 513 | never varies. It is called the @dfn{cyclic ordering of windows}. |
| 516 | 514 | ||
| 517 | This ordering generally goes from top to bottom, and from left to | 515 | For a particular frame, this ordering generally goes from top to |
| 518 | right. But it may go down first or go right first, depending on the | 516 | bottom, and from left to right. But it may go down first or go right |
| 519 | order in which windows were split. | 517 | first, depending on the order in which windows were split. |
| 520 | 518 | ||
| 521 | If the first split was vertical (into windows one above each other), | 519 | If the first split was vertical (into windows one above each other), |
| 522 | and then the subwindows were split horizontally, then the ordering is | 520 | and then the subwindows were split horizontally, then the ordering is |
| @@ -795,9 +793,8 @@ that does not identify an existing buffer, then a new buffer by that | |||
| 795 | name is created. The major mode for the new buffer is set according to | 793 | name is created. The major mode for the new buffer is set according to |
| 796 | the variable @code{default-major-mode}; see @ref{Auto Major Mode}. | 794 | the variable @code{default-major-mode}; see @ref{Auto Major Mode}. |
| 797 | 795 | ||
| 798 | When @code{enable-recursive-minibuffers} is non-@code{nil} and the | 796 | When the selected window is the minibuffer window or is strongly |
| 799 | selected window is either the minibuffer window or is dedicated to its | 797 | dedicated to its buffer (@pxref{Dedicated Windows}), this function calls |
| 800 | buffer (@pxref{Dedicated Windows}), @code{switch-to-buffer} calls | ||
| 801 | @code{pop-to-buffer} (see below) to display the buffer in some other | 798 | @code{pop-to-buffer} (see below) to display the buffer in some other |
| 802 | window. | 799 | window. |
| 803 | 800 | ||
| @@ -817,15 +814,13 @@ for the described features. | |||
| 817 | 814 | ||
| 818 | @deffn Command switch-to-buffer-other-window buffer-or-name &optional norecord | 815 | @deffn Command switch-to-buffer-other-window buffer-or-name &optional norecord |
| 819 | This function makes the buffer specified by @var{buffer-or-name} current | 816 | This function makes the buffer specified by @var{buffer-or-name} current |
| 820 | and displays it in a window not currently selected. It then selects | 817 | and displays it in a window not currently selected, using the function |
| 821 | that window. The handling of the buffer is the same as in | 818 | @code{pop-to-buffer} (see below). |
| 822 | @code{switch-to-buffer}. | ||
| 823 | 819 | ||
| 824 | The currently selected window is absolutely never used to do the job. | 820 | The currently selected window is absolutely never used to do the job. |
| 825 | If it is the only window, then it is split to make a distinct window for | 821 | If the selected window already displays @var{buffer-or-name}, then it |
| 826 | this purpose. If the selected window is already displaying the buffer, | 822 | continues to do so, but another window is nonetheless found to display |
| 827 | then it continues to do so, but another window is nonetheless found to | 823 | it in as well. |
| 828 | display it in as well. | ||
| 829 | 824 | ||
| 830 | This function updates the buffer list just like @code{switch-to-buffer} | 825 | This function updates the buffer list just like @code{switch-to-buffer} |
| 831 | unless @var{norecord} is non-@code{nil}. | 826 | unless @var{norecord} is non-@code{nil}. |
| @@ -835,8 +830,8 @@ unless @var{norecord} is non-@code{nil}. | |||
| 835 | This command makes @var{buffer-or-name} the current buffer and switches | 830 | This command makes @var{buffer-or-name} the current buffer and switches |
| 836 | to it in some window, preferably not the window previously selected. | 831 | to it in some window, preferably not the window previously selected. |
| 837 | The ``popped-to'' window becomes the selected window. Its frame is | 832 | The ``popped-to'' window becomes the selected window. Its frame is |
| 838 | given the X server's focus, if possible; see @ref{Input Focus}. The return | 833 | given the X server's focus, if possible; see @ref{Input Focus}. The |
| 839 | value is the buffer that was switched to. | 834 | return value is the buffer that was switched to. |
| 840 | 835 | ||
| 841 | If @var{buffer-or-name} is @code{nil}, that means to choose some other | 836 | If @var{buffer-or-name} is @code{nil}, that means to choose some other |
| 842 | buffer, but you don't specify which. If @var{buffer-or-name} is a | 837 | buffer, but you don't specify which. If @var{buffer-or-name} is a |
| @@ -844,16 +839,15 @@ string that does not name an existing buffer, a buffer by that name is | |||
| 844 | created. The major mode for the new buffer is set according to the | 839 | created. The major mode for the new buffer is set according to the |
| 845 | variable @code{default-major-mode}. @xref{Auto Major Mode}. | 840 | variable @code{default-major-mode}. @xref{Auto Major Mode}. |
| 846 | 841 | ||
| 847 | If the variable @code{pop-up-frames} is non-@code{nil}, | 842 | If either of the variables @code{display-buffer-reuse-frames} or |
| 848 | @code{pop-to-buffer} looks for a window in any visible frame already | 843 | @code{pop-up-frames} is non-@code{nil}, @code{pop-to-buffer} looks for a |
| 849 | displaying the buffer; if there is one, it selects and returns that | 844 | window in any visible frame already displaying the buffer; if there is |
| 850 | window. If no such window exists, it creates a new frame and displays | 845 | one, it selects and returns that window. If no such window exists and |
| 851 | the buffer in it. | 846 | @code{pop-up-frames} is non-@code{nil}, it creates a new frame and |
| 852 | 847 | displays the buffer in it. Otherwise, @code{pop-to-buffer} operates | |
| 853 | If @code{pop-up-frames} is @code{nil}, then @code{pop-to-buffer} | 848 | entirely within the selected frame. (If the selected frame has just a |
| 854 | operates entirely within the selected frame. (If the selected frame has | 849 | minibuffer, @code{pop-to-buffer} operates within the most recently |
| 855 | just a minibuffer, @code{pop-to-buffer} operates within the most | 850 | selected frame that was not just a minibuffer.) |
| 856 | recently selected frame that was not just a minibuffer.) | ||
| 857 | 851 | ||
| 858 | If the variable @code{pop-up-windows} is non-@code{nil}, windows may be | 852 | If the variable @code{pop-up-windows} is non-@code{nil}, windows may be |
| 859 | split to create a new window that is different from the original window. | 853 | split to create a new window that is different from the original window. |
| @@ -946,10 +940,10 @@ the variables described below. | |||
| 946 | 940 | ||
| 947 | @defopt display-buffer-reuse-frames | 941 | @defopt display-buffer-reuse-frames |
| 948 | If this variable is non-@code{nil}, @code{display-buffer} searches | 942 | If this variable is non-@code{nil}, @code{display-buffer} searches |
| 949 | existing frames for a window displaying @var{buffer-or-name}. If the | 943 | visible and iconified frames for a window displaying |
| 950 | buffer is already displayed in a window in some frame, | 944 | @var{buffer-or-name}. If there is such a window, @code{display-buffer} |
| 951 | @code{display-buffer} makes the frame visible and raises it, to use that | 945 | makes that window's frame visible and raises it if necessary, and |
| 952 | window. If the buffer is not already displayed, or | 946 | returns the window. If there is no such window or |
| 953 | @code{display-buffer-reuse-frames} is @code{nil}, the behavior of | 947 | @code{display-buffer-reuse-frames} is @code{nil}, the behavior of |
| 954 | @code{display-buffer} is determined by the variables described next. | 948 | @code{display-buffer} is determined by the variables described next. |
| 955 | @end defopt | 949 | @end defopt |
| @@ -1050,12 +1044,14 @@ window heights will be left alone. | |||
| 1050 | 1044 | ||
| 1051 | @c Emacs 19 feature | 1045 | @c Emacs 19 feature |
| 1052 | @defopt pop-up-frames | 1046 | @defopt pop-up-frames |
| 1053 | This variable specifies whether @code{display-buffer} makes new frames. | 1047 | This variable specifies whether @code{display-buffer} should make new |
| 1054 | If it is non-@code{nil}, @code{display-buffer} looks for an existing | 1048 | frames. If it is non-@code{nil}, @code{display-buffer} looks for a |
| 1055 | window already displaying the desired buffer, on any visible frame. If | 1049 | window already displaying @var{buffer-or-name} on any visible or |
| 1056 | it finds one, it returns that window. Otherwise it makes a new frame, | 1050 | iconified frame. If it finds such a window, it makes that window's |
| 1057 | unless the variable's value is @code{graphic-only} and the selected | 1051 | frame visible and raises it if necessary, and returns the window. |
| 1058 | frame is not on a graphic display. @xref{Frames}, for more information. | 1052 | Otherwise it makes a new frame, unless the variable's value is |
| 1053 | @code{graphic-only} and the selected frame is not on a graphic display. | ||
| 1054 | @xref{Frames}, for more information. | ||
| 1059 | 1055 | ||
| 1060 | Note that the value of @code{pop-up-windows} does not matter if | 1056 | Note that the value of @code{pop-up-windows} does not matter if |
| 1061 | @code{pop-up-frames} is non-@code{nil}. If @code{pop-up-frames} is | 1057 | @code{pop-up-frames} is non-@code{nil}. If @code{pop-up-frames} is |
| @@ -1068,11 +1064,11 @@ one. | |||
| 1068 | This variable specifies how to make a new frame if @code{pop-up-frames} | 1064 | This variable specifies how to make a new frame if @code{pop-up-frames} |
| 1069 | is non-@code{nil}. | 1065 | is non-@code{nil}. |
| 1070 | 1066 | ||
| 1071 | Its value should be a function of no arguments. When | 1067 | The value of this variable must be a function of no arguments. When |
| 1072 | @code{display-buffer} makes a new frame, it does so by calling that | 1068 | @code{display-buffer} makes a new frame, it does so by calling that |
| 1073 | function, which should return a frame. The default value of the | 1069 | function, which should return a frame. The default value of this |
| 1074 | variable is a function that creates a frame using parameters from | 1070 | variable is a function that creates a frame using the parameters |
| 1075 | @code{pop-up-frame-alist}. | 1071 | specified by @code{pop-up-frame-alist} described next. |
| 1076 | @end defopt | 1072 | @end defopt |
| 1077 | 1073 | ||
| 1078 | @defopt pop-up-frame-alist | 1074 | @defopt pop-up-frame-alist |
| @@ -1232,9 +1228,9 @@ When you kill a buffer (@pxref{Killing Buffers}) displayed in a | |||
| 1232 | dedicated window, any such window usually gets deleted too, since | 1228 | dedicated window, any such window usually gets deleted too, since |
| 1233 | @code{kill-buffer} calls @code{replace-buffer-in-windows} for cleaning | 1229 | @code{kill-buffer} calls @code{replace-buffer-in-windows} for cleaning |
| 1234 | up windows. Burying a buffer (@pxref{The Buffer List}) deletes the | 1230 | up windows. Burying a buffer (@pxref{The Buffer List}) deletes the |
| 1235 | selected window if it is dedicated and shows that buffer. However, if | 1231 | selected window if it is dedicated to that buffer. If, however, that |
| 1236 | that window is the only window on its frame, another buffer is displayed | 1232 | window is the only window on its frame, @code{bury-buffer} displays |
| 1237 | in it and the frame is iconified. | 1233 | another buffer in it and iconifies the frame. |
| 1238 | 1234 | ||
| 1239 | @defun window-dedicated-p &optional window | 1235 | @defun window-dedicated-p &optional window |
| 1240 | This function returns non-@code{nil} if @var{window} is dedicated to its | 1236 | This function returns non-@code{nil} if @var{window} is dedicated to its |
| @@ -1253,9 +1249,8 @@ As a special case, if @var{flag} is @code{t}, @var{window} becomes | |||
| 1253 | @dfn{strongly} dedicated to its buffer. @code{set-window-buffer} | 1249 | @dfn{strongly} dedicated to its buffer. @code{set-window-buffer} |
| 1254 | signals an error when the window it acts upon is strongly dedicated to | 1250 | signals an error when the window it acts upon is strongly dedicated to |
| 1255 | its buffer and does not already display the buffer it is asked to | 1251 | its buffer and does not already display the buffer it is asked to |
| 1256 | display. In any other case, @code{set-window-buffer} will display | 1252 | display. Other functions do not treat @code{t} differently from any |
| 1257 | another buffer in that window. Other functions do not treat @code{t} | 1253 | non-@code{nil} value. |
| 1258 | differently from any non-@code{nil} value. | ||
| 1259 | @end defun | 1254 | @end defun |
| 1260 | 1255 | ||
| 1261 | @node Window Point | 1256 | @node Window Point |
| @@ -1558,9 +1553,10 @@ window. @xref{Current Buffer}. | |||
| 1558 | 1553 | ||
| 1559 | If the window contains a row which is taller than the height of the | 1554 | If the window contains a row which is taller than the height of the |
| 1560 | window (for example in the presence of a large image), the scroll | 1555 | window (for example in the presence of a large image), the scroll |
| 1561 | functions will adjust the window vscroll to scroll the partially visible | 1556 | functions will adjust the window's vertical scroll position to scroll |
| 1562 | row. To disable this feature, Lisp code may bind the variable | 1557 | the partially visible row. To disable this feature, Lisp code may bind |
| 1563 | @code{auto-window-vscroll} to @code{nil} (@pxref{Vertical Scrolling}). | 1558 | the variable @code{auto-window-vscroll} to @code{nil} (@pxref{Vertical |
| 1559 | Scrolling}). | ||
| 1564 | 1560 | ||
| 1565 | @deffn Command scroll-up &optional count | 1561 | @deffn Command scroll-up &optional count |
| 1566 | This function scrolls the text in the selected window upward | 1562 | This function scrolls the text in the selected window upward |
| @@ -1792,7 +1788,7 @@ pixels. In this case, the return value is @var{lines}. | |||
| 1792 | @defvar auto-window-vscroll | 1788 | @defvar auto-window-vscroll |
| 1793 | If this variable is non-@code{nil}, the line-move, scroll-up, and | 1789 | If this variable is non-@code{nil}, the line-move, scroll-up, and |
| 1794 | scroll-down functions will automatically modify the vertical scroll | 1790 | scroll-down functions will automatically modify the vertical scroll |
| 1795 | position to scroll through display rows that are taller that the height | 1791 | position to scroll through display rows that are taller than the height |
| 1796 | of the window, for example in the presence of large images. | 1792 | of the window, for example in the presence of large images. |
| 1797 | @end defvar | 1793 | @end defvar |
| 1798 | 1794 | ||
| @@ -2598,9 +2594,9 @@ frame selected. | |||
| 2598 | @end defvar | 2594 | @end defvar |
| 2599 | 2595 | ||
| 2600 | In addition, you can use @code{jit-lock-register} to register a Font | 2596 | In addition, you can use @code{jit-lock-register} to register a Font |
| 2601 | Lock fontification function, which will be called whenever part of the | 2597 | Lock fontification function, which will be called whenever parts of a |
| 2602 | buffer needs to be refontified (usually because it has been changed). | 2598 | buffer are (re)fontified because a window was scrolled or its size |
| 2603 | @xref{Other Font Lock Variables}. | 2599 | changed. @xref{Other Font Lock Variables}. |
| 2604 | 2600 | ||
| 2605 | @ignore | 2601 | @ignore |
| 2606 | arch-tag: 3f6c36e8-df49-4986-b757-417feed88be3 | 2602 | arch-tag: 3f6c36e8-df49-4986-b757-417feed88be3 |