aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMartin Rudalics2018-12-08 09:37:40 +0100
committerMartin Rudalics2018-12-08 09:37:40 +0100
commitd2b3a37886d97abdc10e16f6389200e8ad45dd7a (patch)
treef1649e61eb920544548e52931803278ebef4addc /doc
parent1d676aabca4bdba6948fb7a9d875ba63b51aed63 (diff)
downloademacs-d2b3a37886d97abdc10e16f6389200e8ad45dd7a.tar.gz
emacs-d2b3a37886d97abdc10e16f6389200e8ad45dd7a.zip
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.texi22
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.
2607If splitting the selected window fails and there is a non-dedicated 2607If splitting the selected window fails and there is a non-dedicated
2608window below the selected one showing some other buffer, this function 2608window below the selected one showing some other buffer, this function
2609tries to use that window for showing @var{buffer}. 2609tries to use that window for showing @var{buffer}.
2610
2611If @var{alist} contains a @code{window-min-height} entry, this
2612function ensures that the window used is or can become at least as
2613high as specified by that entry's value. Note that this is only a
2614guarantee. In order to actually resize the window used, @var{alist}
2615must also provide an appropriate @code{window-height} entry.
2610@end defun 2616@end defun
2611 2617
2612@defun display-buffer-at-bottom buffer alist 2618@defun display-buffer-at-bottom buffer alist
@@ -2790,6 +2796,22 @@ The value specifies an alist of window parameters to give the chosen
2790window. All action functions that choose a window should process this 2796window. All action functions that choose a window should process this
2791entry. 2797entry.
2792 2798
2799@vindex window-min-height@r{, a buffer display action alist entry}
2800@item window-min-height
2801The value specifies a minimum height of the window used, in lines. If
2802a window is not or cannot be made as high as specified by this entry,
2803the window is not considered for use. The only client of this entry
2804is presently @code{display-buffer-below-selected}.
2805
2806Note that providing such an entry alone does not necessarily make the
2807window as tall as specified by its value. To actually resize an
2808existing window or make a new window as tall as specified by that
2809value, a @code{window-height} entry specifying that value should be
2810provided as well. Such a @code{window-height} entry can, however,
2811specify a completely different value or ask the window height to be
2812fit to that of its buffer in which case the @code{window-min-height}
2813entry provides the guaranteed minimum height of the window used.
2814
2793@vindex window-height@r{, a buffer display action alist entry} 2815@vindex window-height@r{, a buffer display action alist entry}
2794@item window-height 2816@item window-height
2795The value specifies whether and how to adjust the height of the chosen 2817The value specifies whether and how to adjust the height of the chosen