elisp: Dedicated Windows
27.17 Dedicated Windows
=======================
Functions for displaying a buffer can be told to not use specific
windows by marking these windows as “dedicated” to their buffers.
‘display-buffer’ (Choosing Window) never uses a dedicated window
for displaying another buffer in it. ‘get-lru-window’ and
‘get-largest-window’ (Cyclic Window Ordering) do not consider
dedicated windows as candidates when their DEDICATED argument is
non-‘nil’. The behavior of ‘set-window-buffer’ (Buffers and
Windows) with respect to dedicated windows is slightly different, see
below.
Functions supposed to remove a buffer from a window or a window from
a frame can behave specially when a window they operate on is dedicated.
We will distinguish three basic cases, namely where (1) the window is
not the only window on its frame, (2) the window is the only window on
its frame but there are other frames on the same terminal left, and (3)
the window is the only window on the only frame on the same terminal.
In particular, ‘delete-windows-on’ (Deleting Windows) handles
case (2) by deleting the associated frame and case (3) by showing
another buffer in that frame’s only window. The function
‘replace-buffer-in-windows’ (Buffers and Windows) which is
called when a buffer gets killed, deletes the window in case (1) and
behaves like ‘delete-windows-on’ otherwise.
When ‘bury-buffer’ (Buffer List) operates on the selected
window (which shows the buffer that shall be buried), it handles case
(2) by calling ‘frame-auto-hide-function’ (Quitting Windows) to
deal with the selected frame. The other two cases are handled as with
‘replace-buffer-in-windows’.
-- Function: window-dedicated-p &optional window
This function returns non-‘nil’ if WINDOW is dedicated to its
buffer and ‘nil’ otherwise. More precisely, the return value is
the value assigned by the last call of ‘set-window-dedicated-p’ for
WINDOW, or ‘nil’ if that function was never called with WINDOW as
its argument. The default for WINDOW is the selected window.
-- Function: set-window-dedicated-p window flag
This function marks WINDOW as dedicated to its buffer if FLAG is
non-‘nil’, and non-dedicated otherwise.
As a special case, if FLAG is ‘t’, WINDOW becomes “strongly”
dedicated to its buffer. ‘set-window-buffer’ signals an error when
the window it acts upon is strongly dedicated to its buffer and
does not already display the buffer it is asked to display. Other
functions do not treat ‘t’ differently from any non-‘nil’ value.