Variable: display-buffer-function

display-buffer-function is a customizable variable defined in window.el.gz.

This variable is obsolete since 24.3; use display-buffer-alist instead.

Value

nil

Documentation

If non-nil, function to call to handle display-buffer.

It will receive two args, the buffer and a flag which if non-nil means that the currently selected window is not acceptable. It should choose or create a window, display the specified buffer in it, and return the window.

The specified function should call display-buffer-record-window with corresponding arguments to set up the quit-restore parameter of the window used.

Probably introduced at or before Emacs version 24.3.

Source Code

;; Defined in /usr/src/emacs/lisp/window.el.gz
(defcustom display-buffer-function nil
  "If non-nil, function to call to handle `display-buffer'.
It will receive two args, the buffer and a flag which if non-nil
means that the currently selected window is not acceptable.  It
should choose or create a window, display the specified buffer in
it, and return the window.

The specified function should call `display-buffer-record-window'
with corresponding arguments to set up the quit-restore parameter
of the window used."
  :type '(choice
	  (const nil)
	  (function :tag "function"))
  :group 'windows)