Next: Precedence of Action Functions, Previous: Buffer Display Action Alists, Up: Displaying Buffers
The behavior of buffer display actions (see Choosing Window) can be further modified by the following user options.
If the value of this variable is non-
nil
,display-buffer
is allowed to split an existing window to make a new window for displaying in. This is the default.This variable is provided for backward compatibility only. It is obeyed by
display-buffer
via a special mechanism indisplay-buffer-fallback-action
, which calls the action functiondisplay-buffer-pop-up-window
(see Buffer Display Action Functions) when the value of this option is non-nil
. It is not consulted bydisplay-buffer-pop-up-window
itself, which the user may specify directly indisplay-buffer-alist
etc.
This variable specifies a function for splitting a window, in order to make a new window for displaying a buffer. It is used by the
display-buffer-pop-up-window
action function to actually split the window.The value must be a function that takes one argument, a window, and returns either a new window (which will be used to display the desired buffer) or
nil
(which means the splitting failed). The default value issplit-window-sensibly
, which is documented next.
This function tries to split window and return the newly created window. If window cannot be split, it returns
nil
. If window is omitted ornil
, it defaults to the selected window.This function obeys the usual rules that determine when a window may be split (see Splitting Windows). It first tries to split by placing the new window below, subject to the restriction imposed by
split-height-threshold
(see below), in addition to any other restrictions. If that fails, it tries to split by placing the new window to the right, subject tosplit-width-threshold
(see below). If that also fails, and the window is the only window on its frame, this function again tries to split and place the new window below, disregardingsplit-height-threshold
. If this fails as well, this function gives up and returnsnil
.
This variable specifies whether
split-window-sensibly
is allowed to split the window placing the new window below. If it is an integer, that means to split only if the original window has at least that many lines. If it isnil
, that means not to split this way.
This variable specifies whether
split-window-sensibly
is allowed to split the window placing the new window to the right. If the value is an integer, that means to split only if the original window has at least that many columns. If the value isnil
, that means not to split this way.
This variable, if non-
nil
, causesdisplay-buffer
to even window sizes whenever it reuses an existing window, and that window is adjacent to the selected one.If its value is
width-only
, sizes are evened only if the reused window is on the left or right of the selected one and the selected window is wider than the reused one. If its value isheight-only
sizes are evened only if the reused window is above or beneath the selected window and the selected window is higher than the reused one. Any other non-nil
value means to even sizes in any of these cases provided the selected window is larger than the reused one in the sense of their combination.
If the value of this variable is non-
nil
, that meansdisplay-buffer
may display buffers by making new frames. The default isnil
.A non-
nil
value also means that whendisplay-buffer
is looking for a window already displaying buffer-or-name, it can search any visible or iconified frame, not just the selected frame.This variable is provided mainly for backward compatibility. It is obeyed by
display-buffer
via a special mechanism indisplay-buffer-fallback-action
, which calls the action functiondisplay-buffer-pop-up-frame
(see Buffer Display Action Functions) if the value is non-nil
. (This is done before attempting to split a window.) This variable is not consulted bydisplay-buffer-pop-up-frame
itself, which the user may specify directly indisplay-buffer-alist
etc.
This variable specifies a function for creating a new frame, in order to make a new window for displaying a buffer. It is used by the
display-buffer-pop-up-frame
action function.The value should be a function that takes no arguments and returns a frame, or
nil
if no frame could be created. The default value is a function that creates a frame using the parameters specified bypop-up-frame-alist
(see below).
This variable holds an alist of frame parameters (see Frame Parameters), which is used by the function specified by
pop-up-frame-function
to make a new frame. The default isnil
.This option is provided for backward compatibility only. Note, that when
display-buffer-pop-up-frame
calls the function specified bypop-up-frame-function
, it prepends the value of allpop-up-frame-parameters
action alist entries topop-up-frame-alist
so that the values specified by the action alist entry effectively override any corresponding values ofpop-up-frame-alist
.Hence, users should set up a
pop-up-frame-parameters
action alist entry indisplay-buffer-alist
instead of customizingpop-up-frame-alist
. Only this will guarantee that the value of a parameter specified by the user overrides the value of that parameter specified by the caller ofdisplay-buffer
.
Many efforts in the design of display-buffer
have been given
to maintain compatibility with code that uses older options like
pop-up-windows
, pop-up-frames
,
pop-up-frame-alist
, same-window-buffer-names
and
same-window-regexps
. Lisp Programs and users should refrain
from using these options. Above we already warned against customizing
pop-up-frame-alist
. Here we describe how to convert the
remaining options to use display actions instead.
pop-up-windows
t
by default. Instead of customizing it to
nil
and thus telling display-buffer
what not to do, it's
much better to list in display-buffer-base-action
the action
functions it should try instead as, for example:
(customize-set-variable 'display-buffer-base-action '((display-buffer-reuse-window display-buffer-same-window display-buffer-in-previous-window display-buffer-use-some-window)))
pop-up-frames
t
, customize
display-buffer-base-action
, for example, as follows:
(customize-set-variable 'display-buffer-base-action '((display-buffer-reuse-window display-buffer-pop-up-frame) (reusable-frames . 0)))
same-window-buffer-names
same-window-regexps
display-buffer-alist
entry for that buffer
specifying the action function display-buffer-same-window
.
(customize-set-variable 'display-buffer-alist (cons '("\\*foo\\*" (display-buffer-same-window)) display-buffer-alist))