* lisp/window.el (display-buffer): Extend doc with body-function (bug#39822)
This commit is contained in:
parent
7e243a8790
commit
bb729496f9
2 changed files with 11 additions and 4 deletions
|
@ -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}
|
||||
|
|
|
@ -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
|
||||
|
|
Loading…
Add table
Reference in a new issue