aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii2008-10-18 11:22:08 +0000
committerEli Zaretskii2008-10-18 11:22:08 +0000
commit43c59a3dca02f712c5e69c3d4be56d2353eb967b (patch)
treeaef6279fdb7ceb1a4cd4e944ba3700ebc2f3296c
parent3051e4bf2c9288b75c83661bb53459acf38f1dc6 (diff)
downloademacs-43c59a3dca02f712c5e69c3d4be56d2353eb967b.tar.gz
emacs-43c59a3dca02f712c5e69c3d4be56d2353eb967b.zip
(Displaying Buffers): Minor wording fix.
(Choosing Window): `split-height-threshold' can now be nil. Document `split-width-threshold'. `pop-up-frames' can have the value `graphic-only'.
-rw-r--r--doc/lispref/ChangeLog7
-rw-r--r--doc/lispref/windows.texi52
-rw-r--r--etc/NEWS5
3 files changed, 52 insertions, 12 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 5891f611050..cc74a973792 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,10 @@
12008-10-18 Eli Zaretskii <eliz@gnu.org>
2
3 * windows.texi (Displaying Buffers): Minor wording fix.
4 (Choosing Window): `split-height-threshold' can now be nil.
5 Document `split-width-threshold'. `pop-up-frames' can have the
6 value `graphic-only'.
7
12008-10-17 Eli Zaretskii <eliz@gnu.org> 82008-10-17 Eli Zaretskii <eliz@gnu.org>
2 9
3 * os.texi (Startup Summary): Document `before-init-time' and 10 * os.texi (Startup Summary): Document `before-init-time' and
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi
index 6cc5d03206f..09cfff227d4 100644
--- a/doc/lispref/windows.texi
+++ b/doc/lispref/windows.texi
@@ -794,7 +794,7 @@ See the preceding section for
794@ifnottex 794@ifnottex
795@xref{Buffers and Windows}, for 795@xref{Buffers and Windows}, for
796@end ifnottex 796@end ifnottex
797low-level functions that give you more precise control. All of these 797low-level primitives that give you more precise control. All of these
798functions work by calling @code{set-window-buffer}. 798functions work by calling @code{set-window-buffer}.
799 799
800 Do not use the functions in this section in order to make a buffer 800 Do not use the functions in this section in order to make a buffer
@@ -951,6 +951,16 @@ Precisely how @code{display-buffer} finds or creates a window depends on
951the variables described below. 951the variables described below.
952@end deffn 952@end deffn
953 953
954@defun split-window-preferred-function window
955This variable specifies how to split a window. Its value, if
956non-@code{nil}, should be a function of one argument, which is a
957window. If this variable specifies a function, @code{display-buffer}
958will call it with one or more candidate windows when it looks for a
959window to split. If the argument @var{window} fits, the function is
960expected to split it and return a new window. If the function returns
961@code{nil}, then @var{window} will not be split.
962@end defun
963
954@defopt display-buffer-reuse-frames 964@defopt display-buffer-reuse-frames
955If this variable is non-@code{nil}, @code{display-buffer} searches 965If this variable is non-@code{nil}, @code{display-buffer} searches
956existing frames for a window displaying the buffer. If the buffer is 966existing frames for a window displaying the buffer. If the buffer is
@@ -964,16 +974,31 @@ variables, described below.
964@defopt pop-up-windows 974@defopt pop-up-windows
965This variable controls whether @code{display-buffer} makes new windows. 975This variable controls whether @code{display-buffer} makes new windows.
966If it is non-@code{nil} and there is only one window, then that window 976If it is non-@code{nil} and there is only one window, then that window
967is split. If it is @code{nil}, then @code{display-buffer} does not 977is split vertically. If it is @code{nil}, then @code{display-buffer}
968split the single window, but uses it whole. 978does not split the single window, but uses it whole.
969@end defopt 979@end defopt
970 980
971@defopt split-height-threshold 981@defopt split-height-threshold
972This variable determines when @code{display-buffer} may split a window, 982This variable determines when @code{display-buffer} may split a window
973if there are multiple windows. @code{display-buffer} always splits the 983vertically, if there are multiple windows. If the value is a number,
974largest window if it has at least this many lines. If the largest 984@code{display-buffer} splits the largest window if it has at least
975window is not this tall, it is split only if it is the sole window and 985this many lines. If the largest window is not this tall, or if the
976@code{pop-up-windows} is non-@code{nil}. 986value of this variable is @code{nil}, @code{display-buffer} tries to
987split some window horizontally, subject to restrictions of
988@code{split-width-threshold} (see below). If splitting horizontally
989is impossible, @code{display-buffer} will split a window vertically
990only if it's the only window on its frame and not the minibuffer
991window, and only if @code{pop-up-windows} is non-@code{nil}.
992Otherwise, @code{display-buffer} uses one of the existing windows.
993@end defopt
994
995@defopt split-width-threshold
996This variable determines when @code{display-buffer} may split a window
997horizontally. If the value is a number, @code{display-buffer} may
998split a window if it has at least this many columns. If the value of
999this variable is @code{nil}, @code{display-buffer} will not split any
1000windows horizontally. (It still might split some window vertically,
1001though, see above.)
977@end defopt 1002@end defopt
978 1003
979@defopt even-window-heights 1004@defopt even-window-heights
@@ -989,10 +1014,13 @@ will be left alone.
989@defopt pop-up-frames 1014@defopt pop-up-frames
990This variable controls whether @code{display-buffer} makes new frames. 1015This variable controls whether @code{display-buffer} makes new frames.
991If it is non-@code{nil}, @code{display-buffer} looks for an existing 1016If it is non-@code{nil}, @code{display-buffer} looks for an existing
992window already displaying the desired buffer, on any visible frame. If 1017window already displaying the desired buffer, on any visible frame.
993it finds one, it returns that window. Otherwise it makes a new frame. 1018If it finds one, it returns that window. Otherwise it makes a new
994The variables @code{pop-up-windows} and @code{split-height-threshold} do 1019frame, unless the variable's value is @code{graphic-only} and the
995not matter if @code{pop-up-frames} is non-@code{nil}. 1020selected frame is not on a graphic display. The variables
1021@code{pop-up-windows}, @code{split-height-threshold}, and
1022@code{split-width-threshold} do not matter if @code{pop-up-frames} is
1023non-@code{nil}.
996 1024
997If @code{pop-up-frames} is @code{nil}, then @code{display-buffer} either 1025If @code{pop-up-frames} is @code{nil}, then @code{display-buffer} either
998splits a window or reuses one. 1026splits a window or reuses one.
diff --git a/etc/NEWS b/etc/NEWS
index 58c4388fba2..b2e73354061 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -1221,16 +1221,21 @@ Emacs initialization.
1221 1221
1222** Changes affecting display-buffer 1222** Changes affecting display-buffer
1223 1223
1224+++
1224*** New value nil for split-height-threshold inhibits vertical splitting 1225*** New value nil for split-height-threshold inhibits vertical splitting
1225unless there's no other window. 1226unless there's no other window.
1226 1227
1228+++
1227*** New option split-width-threshold controls horizontal splitting. 1229*** New option split-width-threshold controls horizontal splitting.
1228 1230
1231+++
1229*** A window can be split horizontally even when it's not full-width. 1232*** A window can be split horizontally even when it's not full-width.
1230 1233
1234+++
1231*** New option split-window-preferred-function can be set to a function 1235*** New option split-window-preferred-function can be set to a function
1232to override the default splitting mechanism of display-buffer. 1236to override the default splitting mechanism of display-buffer.
1233 1237
1238+++
1234*** If pop-up-frames has the value `graphic-only', display-buffer only 1239*** If pop-up-frames has the value `graphic-only', display-buffer only
1235makes a separate frame on graphic displays. 1240makes a separate frame on graphic displays.
1236 1241