aboutsummaryrefslogtreecommitdiffstats
path: root/doc/lispref
diff options
context:
space:
mode:
authorMartin Rudalics2016-01-29 11:14:13 +0100
committerMartin Rudalics2016-01-29 11:14:13 +0100
commitc32cc606df56d6dd7b394c32b2d5599f12dfd20e (patch)
treee202eeb9c9c8be01e23e5def7b6c4622b1653bc5 /doc/lispref
parentd7a93efd0e512ce145ee696561054f8065fe03ab (diff)
downloademacs-c32cc606df56d6dd7b394c32b2d5599f12dfd20e.tar.gz
emacs-c32cc606df56d6dd7b394c32b2d5599f12dfd20e.zip
c:/emacs-git/next/ChangeLog
Diffstat (limited to 'doc/lispref')
-rw-r--r--doc/lispref/frames.texi9
-rw-r--r--doc/lispref/windows.texi73
2 files changed, 43 insertions, 39 deletions
diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi
index 55d72427548..b98e3a5cdd1 100644
--- a/doc/lispref/frames.texi
+++ b/doc/lispref/frames.texi
@@ -714,9 +714,12 @@ Sizes}) or splitting (@pxref{Splitting Windows}) windows.
714 714
715@cindex line height 715@cindex line height
716@cindex column width 716@cindex column width
717The term @dfn{line height} is sometimes used instead of ``default 717@cindex canonical character height
718character height''. Similarly, the term @dfn{column width} is used as 718@cindex canonical character width
719shorthand for ``default character width''. 719The terms @dfn{line height} and @dfn{canonical character height} are
720sometimes used instead of ``default character height''. Similarly, the
721terms @dfn{column width} and @dfn{canonical character width} are used
722instead of ``default character width''.
720 723
721@defun frame-char-height &optional frame 724@defun frame-char-height &optional frame
722@defunx frame-char-width &optional frame 725@defunx frame-char-width &optional frame
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi
index ca756e3ff7f..771bd4eeb29 100644
--- a/doc/lispref/windows.texi
+++ b/doc/lispref/windows.texi
@@ -371,14 +371,14 @@ means to use the left or top edge of @var{window} as reference position.
371If the optional argument @var{wrap} is non-@code{nil}, this means to 371If the optional argument @var{wrap} is non-@code{nil}, this means to
372wrap @var{direction} around frame borders. For example, if @var{window} 372wrap @var{direction} around frame borders. For example, if @var{window}
373is at the top of the frame and @var{direction} is @code{above}, then 373is at the top of the frame and @var{direction} is @code{above}, then
374return the minibuffer window provided the frame has one, and a window at 374this function usually returns the frame's minibuffer window if it's
375the bottom of the frame otherwise. 375active and a window at the bottom of the frame otherwise.
376 376
377If the optional argument @var{mini} is @code{nil}, this means to return 377If the optional argument @var{mini} is @code{nil}, this means to return
378the minibuffer window if and only if it is currently active. If 378the minibuffer window if and only if it is currently active. If
379@var{mini} is non-@code{nil}, it returns the minibuffer window even when 379@var{mini} is non-@code{nil}, this function may return the minibuffer
380it's not active. However, if @var{wrap} non-@code{nil}, it always acts 380window even when it's not active. However, if @var{wrap} is
381as if @var{mini} were @code{nil}. 381non-@code{nil}, it always acts as if @var{mini} were @code{nil}.
382 382
383If it doesn't find a suitable window, this function returns @code{nil}. 383If it doesn't find a suitable window, this function returns @code{nil}.
384@end defun 384@end defun
@@ -664,15 +664,17 @@ following function useful:
664 664
665@defun window-max-chars-per-line &optional window face 665@defun window-max-chars-per-line &optional window face
666This function returns the number of characters displayed in the 666This function returns the number of characters displayed in the
667specified @var{face} in the specified @var{window} (which must be a 667specified face @var{face} in the specified window @var{window} (which
668live window). If @var{face} was remapped (@pxref{Face Remapping}), 668must be a live window). If @var{face} was remapped (@pxref{Face
669the information is returned for the remapped face. If omitted or 669Remapping}), the information is returned for the remapped face. If
670@code{nil}, @var{face} defaults to the default face, and @var{window} 670omitted or @code{nil}, @var{face} defaults to the default face, and
671defaults to the selected window. Unlike @code{window-body-width}, 671@var{window} defaults to the selected window.
672this function accounts for the actual size of the @var{face}'s font, 672
673instead of working in units of frame's canonical character width. It 673Unlike @code{window-body-width}, this function accounts for the actual
674also accounts for space used by the continuation glyph, if 674size of @var{face}'s font, instead of working in units of the canonical
675@var{window} lacks one or both of its fringes. 675character width of @var{window}'s frame (@pxref{Frame Font}). It also
676accounts for space used by the continuation glyph, if @var{window} lacks
677one or both of its fringes.
676@end defun 678@end defun
677 679
678@cindex fixed-size window 680@cindex fixed-size window
@@ -701,7 +703,7 @@ margins, fringes, a scroll bar and a right divider, if present.
701The following function tells how small a specific window can get taking 703The following function tells how small a specific window can get taking
702into account the sizes of its areas and the values of 704into account the sizes of its areas and the values of
703@code{window-min-height}, @code{window-min-width} and 705@code{window-min-height}, @code{window-min-width} and
704@code{window-size-fixed}. 706@code{window-size-fixed} (@pxref{Preserving Window Sizes}).
705 707
706@defun window-min-size &optional window horizontal ignore pixelwise 708@defun window-min-size &optional window horizontal ignore pixelwise
707This function returns the minimum size of @var{window}. @var{window} 709This function returns the minimum size of @var{window}. @var{window}
@@ -713,10 +715,9 @@ of @var{window}'s lines.
713The return value makes sure that all components of @var{window} remain 715The return value makes sure that all components of @var{window} remain
714fully visible if @var{window}'s size were actually set to it. With 716fully visible if @var{window}'s size were actually set to it. With
715@var{horizontal} @code{nil} it includes the mode and header line, the 717@var{horizontal} @code{nil} it includes the mode and header line, the
716horizontal scroll bar and the bottom divider. With @var{horizontal} 718horizontal scroll bar and the bottom divider, if present. With
717non-@code{nil} it includes the fringes, a scroll bar, and a right 719@var{horizontal} non-@code{nil} it includes the margins and fringes, the
718divider, if present. It does not, however, include the space reserved 720vertical scroll bar and the right divider, if present.
719for the margins.
720 721
721The optional argument @var{ignore}, if non-@code{nil}, means ignore 722The optional argument @var{ignore}, if non-@code{nil}, means ignore
722restrictions imposed by fixed size windows, @code{window-min-height} or 723restrictions imposed by fixed size windows, @code{window-min-height} or
@@ -1263,8 +1264,8 @@ frame), an error is signaled.
1263By default, the space taken up by @var{window} is given to one of its 1264By default, the space taken up by @var{window} is given to one of its
1264adjacent sibling windows, if any. However, if the variable 1265adjacent sibling windows, if any. However, if the variable
1265@code{window-combination-resize} is non-@code{nil}, the space is 1266@code{window-combination-resize} is non-@code{nil}, the space is
1266proportionally distributed among any remaining windows in the window 1267proportionally distributed among any remaining windows in the same
1267combination. @xref{Recombining Windows}. 1268window combination. @xref{Recombining Windows}.
1268 1269
1269The behavior of this function may be altered by the window parameters 1270The behavior of this function may be altered by the window parameters
1270of @var{window}, so long as the variable 1271of @var{window}, so long as the variable
@@ -1771,11 +1772,13 @@ nor the buffer list.
1771@defun window-use-time &optional window 1772@defun window-use-time &optional window
1772This functions returns the use time of window @var{window}. 1773This functions returns the use time of window @var{window}.
1773@var{window} must be a live window and defaults to the selected one. 1774@var{window} must be a live window and defaults to the selected one.
1774The @dfn{use time} of a window is not really a time value, but it does 1775
1775increase monotonically with each window selection, so the window with 1776The @dfn{use time} of a window is not really a time value, but an
1776the lowest use time is the least recently selected one, and the 1777integer that does increase monotonically with each call of
1777window with the highest use time is the most recently selected 1778@code{select-window} with a @code{nil} @var{norecord} argument. The
1778one. 1779window with the lowest use time is usually called the least recently
1780used window while the window with the highest use time is called the
1781most recently used one (@pxref{Cyclic Window Ordering}).
1779@end defun 1782@end defun
1780 1783
1781 1784
@@ -1790,11 +1793,11 @@ some other window, it moves through live windows in a specific order.
1790For any given configuration of windows, this order never varies. It 1793For any given configuration of windows, this order never varies. It
1791is called the @dfn{cyclic ordering of windows}. 1794is called the @dfn{cyclic ordering of windows}.
1792 1795
1793 The ordering is determined by a depth-first traversal of the frame's 1796 The ordering is determined by a depth-first traversal of each frame's
1794window tree, retrieving the live windows which are the leaf nodes of 1797window tree, retrieving the live windows which are the leaf nodes of the
1795the tree (@pxref{Windows and Frames}). If the minibuffer is active, 1798tree (@pxref{Windows and Frames}). If the minibuffer is active, the
1796the minibuffer window is included too. The ordering is cyclic, so the 1799minibuffer window is included too. The ordering is cyclic, so the last
1797last window in the sequence is followed by the first one. 1800window in the sequence is followed by the first one.
1798 1801
1799@defun next-window &optional window minibuf all-frames 1802@defun next-window &optional window minibuf all-frames
1800@cindex minibuffer window, and @code{next-window} 1803@cindex minibuffer window, and @code{next-window}
@@ -2146,9 +2149,8 @@ Invokes @code{pop-to-buffer} to proceed.
2146Marks the selected window as non-dedicated and proceeds. 2149Marks the selected window as non-dedicated and proceeds.
2147@end table 2150@end table
2148 2151
2149When called non-interactively, @code{switch-to-buffer} always signals an 2152This option does not affect non-interactive calls of
2150error when the selected window is dedicated to its buffer and 2153@code{switch-to-buffer}.
2151@var{force-same-window} is non-@code{nil}.
2152@end defopt 2154@end defopt
2153 2155
2154By default, @code{switch-to-buffer} shows the buffer at its position of 2156By default, @code{switch-to-buffer} shows the buffer at its position of
@@ -2209,7 +2211,7 @@ for the documentation of @code{display-buffer}.
2209 2211
2210@deffn Command pop-to-buffer buffer-or-name &optional action norecord 2212@deffn Command pop-to-buffer buffer-or-name &optional action norecord
2211This function makes @var{buffer-or-name} the current buffer and 2213This function makes @var{buffer-or-name} the current buffer and
2212displays it in some window, preferably not the window previously 2214displays it in some window, preferably not the window currently
2213selected. It then selects the displaying window. If that window is 2215selected. It then selects the displaying window. If that window is
2214on a different graphical frame, that frame is given input focus if 2216on a different graphical frame, that frame is given input focus if
2215possible (@pxref{Input Focus}). The return value is the buffer that 2217possible (@pxref{Input Focus}). The return value is the buffer that
@@ -2420,7 +2422,6 @@ frame is a candidate; this function replaces the default predicate.
2420If @var{alist} has a non-@code{nil} @code{inhibit-same-window} entry, 2422If @var{alist} has a non-@code{nil} @code{inhibit-same-window} entry,
2421the selected window is used; thus if the selected frame has a single 2423the selected window is used; thus if the selected frame has a single
2422window, it is not used. 2424window, it is not used.
2423
2424@end defun 2425@end defun
2425 2426
2426@defun display-buffer-pop-up-window buffer alist 2427@defun display-buffer-pop-up-window buffer alist