diff options
author | Juri Linkov <juri@linkov.net> | 2020-04-03 00:50:19 +0300 |
---|---|---|
committer | Juri Linkov <juri@linkov.net> | 2020-04-03 00:50:19 +0300 |
commit | bb729496f9b699896fed8d65bf499a193a7c4886 (patch) | |
tree | 5528fa9ee9942682e29c75a863c6be95536de66e | |
parent | 7e243a87904a036473c6ac87229d4ed652d1e49b (diff) | |
download | emacs-bb729496f9b699896fed8d65bf499a193a7c4886.tar.gz emacs-bb729496f9b699896fed8d65bf499a193a7c4886.tar.bz2 emacs-bb729496f9b699896fed8d65bf499a193a7c4886.zip |
* lisp/window.el (display-buffer): Extend doc with body-function (bug#39822)
-rw-r--r-- | doc/lispref/windows.texi | 9 | ||||
-rw-r--r-- | lisp/window.el | 6 |
2 files changed, 11 insertions, 4 deletions
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi index 00142d87dcc..af2f3acd467 100644 --- a/doc/lispref/windows.texi +++ b/doc/lispref/windows.texi @@ -3053,10 +3053,11 @@ action function that cares about this entry. @item body-function The value must be a function taking one argument (a displayed window). This function can be used to fill the displayed window's body with -some contents. It is called @emph{after} the buffer is displayed, and -@emph{before} the entries @code{window-height}, @code{window-width} -and @code{preserve-size} are applied that could resize the window -to fit it to the inserted contents. +some contents that might depend on dimensions of the displayed window. +It is called @emph{after} the buffer is displayed, and @emph{before} +the entries @code{window-height}, @code{window-width} and +@code{preserve-size} are applied that could resize the window to fit +it to the inserted contents. @end table By convention, the entries @code{window-height}, @code{window-width} diff --git a/lisp/window.el b/lisp/window.el index 0121a78191a..8512a0e2f97 100644 --- a/lisp/window.el +++ b/lisp/window.el @@ -7405,6 +7405,12 @@ Action alist entries are: parameters to give the chosen window. `allow-no-window' -- A non-nil value means that `display-buffer' may not display the buffer and return nil immediately. + `body-function' -- A function called with one argument - the + displayed window. It is called after the buffer is + displayed, and before `window-height', `window-width' + and `preserve-size' are applied. The function is supposed + to fill the window body with some contents that might depend + on dimensions of the displayed window. The entries `window-height', `window-width' and `preserve-size' are applied only when the window used for displaying the buffer |