diff options
author | Martin Rudalics <rudalics@gmx.at> | 2018-12-08 09:37:40 +0100 |
---|---|---|
committer | Martin Rudalics <rudalics@gmx.at> | 2018-12-08 09:37:40 +0100 |
commit | d2b3a37886d97abdc10e16f6389200e8ad45dd7a (patch) | |
tree | f1649e61eb920544548e52931803278ebef4addc /doc | |
parent | 1d676aabca4bdba6948fb7a9d875ba63b51aed63 (diff) | |
download | emacs-d2b3a37886d97abdc10e16f6389200e8ad45dd7a.tar.gz |
New buffer display action alist entry 'window-min-height' (Bug#32825)
* lisp/window.el (display-buffer-below-selected): Handle
'window-min-height' action alist entry (Bug#32825).
* doc/lispref/windows.texi (Buffer Display Action Functions)
(Buffer Display Action Alists): Add documentation for
'window-min-height' action alist entries.
* etc/NEWS: Mention 'window-min-height' action alist entry.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/lispref/windows.texi | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi index b86bccab202..eb057662112 100644 --- a/doc/lispref/windows.texi +++ b/doc/lispref/windows.texi @@ -2607,6 +2607,12 @@ suitable @code{window-height} or @code{window-width} entry, see above. If splitting the selected window fails and there is a non-dedicated window below the selected one showing some other buffer, this function tries to use that window for showing @var{buffer}. + +If @var{alist} contains a @code{window-min-height} entry, this +function ensures that the window used is or can become at least as +high as specified by that entry's value. Note that this is only a +guarantee. In order to actually resize the window used, @var{alist} +must also provide an appropriate @code{window-height} entry. @end defun @defun display-buffer-at-bottom buffer alist @@ -2790,6 +2796,22 @@ The value specifies an alist of window parameters to give the chosen window. All action functions that choose a window should process this entry. +@vindex window-min-height@r{, a buffer display action alist entry} +@item window-min-height +The value specifies a minimum height of the window used, in lines. If +a window is not or cannot be made as high as specified by this entry, +the window is not considered for use. The only client of this entry +is presently @code{display-buffer-below-selected}. + +Note that providing such an entry alone does not necessarily make the +window as tall as specified by its value. To actually resize an +existing window or make a new window as tall as specified by that +value, a @code{window-height} entry specifying that value should be +provided as well. Such a @code{window-height} entry can, however, +specify a completely different value or ask the window height to be +fit to that of its buffer in which case the @code{window-min-height} +entry provides the guaranteed minimum height of the window used. + @vindex window-height@r{, a buffer display action alist entry} @item window-height The value specifies whether and how to adjust the height of the chosen |