diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lispref/windows.texi | 45 |
1 files changed, 22 insertions, 23 deletions
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi index af497cf6af9..b86bccab202 100644 --- a/doc/lispref/windows.texi +++ b/doc/lispref/windows.texi | |||
| @@ -198,12 +198,13 @@ relationships between live windows. The root node of a window tree is | |||
| 198 | called the @dfn{root window}. It can be either a live window (if the | 198 | called the @dfn{root window}. It can be either a live window (if the |
| 199 | frame has just one window), or an internal window. | 199 | frame has just one window), or an internal window. |
| 200 | 200 | ||
| 201 | A minibuffer window (@pxref{Minibuffer Windows}) is not part of its | 201 | A minibuffer window (@pxref{Minibuffer Windows}) that is not alone |
| 202 | frame's window tree unless the frame is a minibuffer-only frame. | 202 | on its frame does not have a parent window, so it strictly speaking is |
| 203 | Nonetheless, most of the functions in this section accept the | 203 | not part of its frame's window tree. Nonetheless, it is a sibling |
| 204 | minibuffer window as an argument. Also, the function | 204 | window of the frame's root window, and thus can be reached via |
| 205 | @code{window-tree} described at the end of this section lists the | 205 | @code{window-next-sibling}. Also, the function @code{window-tree} |
| 206 | minibuffer window alongside the actual window tree. | 206 | described at the end of this section lists the minibuffer window |
| 207 | alongside the actual window tree. | ||
| 207 | 208 | ||
| 208 | @defun frame-root-window &optional frame-or-window | 209 | @defun frame-root-window &optional frame-or-window |
| 209 | This function returns the root window for @var{frame-or-window}. The | 210 | This function returns the root window for @var{frame-or-window}. The |
| @@ -6037,26 +6038,24 @@ size and has to check out these windows by using the method described | |||
| 6037 | in the previous paragraph. | 6038 | in the previous paragraph. |
| 6038 | 6039 | ||
| 6039 | These function are usually only called when at least one window was | 6040 | These function are usually only called when at least one window was |
| 6040 | added or has changed size since the last time this hook was run for the | 6041 | added or has changed size since the last time this hook was run for |
| 6041 | associated frame. In some rare cases this hook also runs when a window | 6042 | the associated frame. In some rare cases this hook also runs when a |
| 6042 | that was added intermittently has been deleted afterwards. In these | 6043 | window that was added intermittently has been deleted afterwards. In |
| 6043 | cases none of the windows on the frame will appear to have changed its | 6044 | these cases none of the windows on the frame will appear to have |
| 6044 | size. | 6045 | changed its size. |
| 6045 | |||
| 6046 | You may use @code{save-selected-window} in these functions | ||
| 6047 | (@pxref{Selecting Windows}). However, do not use | ||
| 6048 | @code{save-window-excursion} (@pxref{Window Configurations}); exiting | ||
| 6049 | that macro counts as a size change, which would cause these functions to | ||
| 6050 | be called again. | ||
| 6051 | @end defvar | 6046 | @end defvar |
| 6052 | 6047 | ||
| 6053 | @defvar window-configuration-change-hook | 6048 | @defvar window-configuration-change-hook |
| 6054 | A normal hook that is run every time the window configuration of a frame | 6049 | A normal hook that is run every time the window configuration of a |
| 6055 | changes. Window configuration changes include splitting and deleting | 6050 | frame changes. Window configuration changes include splitting and |
| 6056 | windows, and the display of a different buffer in a window. Resizing the | 6051 | deleting windows, and the display of a different buffer in a window. |
| 6057 | frame or individual windows do not count as configuration changes. Use | 6052 | |
| 6058 | @code{window-size-change-functions}, see above, when you want to track | 6053 | The hook can be also used for tracking changes of window sizes. It |
| 6059 | size changes that are not caused by the deletion or creation of windows. | 6054 | is, however, not run when the size of a frame changes or automatic |
| 6055 | resizing of a minibuffer window (@pxref{Minibuffer Windows}) changes | ||
| 6056 | the size of another window. As a rule, adding a function to | ||
| 6057 | @code{window-size-change-functions}, see above, is the recommended way | ||
| 6058 | for reliably tracking size changes of any window. | ||
| 6060 | 6059 | ||
| 6061 | The buffer-local value of this hook is run once for each window on the | 6060 | The buffer-local value of this hook is run once for each window on the |
| 6062 | affected frame, with the relevant window selected and its buffer | 6061 | affected frame, with the relevant window selected and its buffer |