annotate doc/lispref/windows.texi @ 101062:f3c2e48fc800

* elisp.texi (Top): Update node listing. * display.texi (PostScript Images): Node deleted.
author Chong Yidong <cyd@stupidchicken.com>
date Sat, 10 Jan 2009 13:09:20 +0000
parents cb5d2387102c
children a9330f5194ee
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1 @c -*-texinfo-*-
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2 @c This is part of the GNU Emacs Lisp Reference Manual.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2001,
100974
cb5d2387102c Add 2009 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 100846
diff changeset
4 @c 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5 @c See the file elisp.texi for copying conditions.
84116
0ba80d073e27 (setfilename): Go up one more level to ../../info.
Glenn Morris <rgm@gnu.org>
parents: 84112
diff changeset
6 @setfilename ../../info/windows
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7 @node Windows, Frames, Buffers, Top
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8 @chapter Windows
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10 This chapter describes most of the functions and variables related to
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
11 Emacs windows. @xref{Frames and Windows}, for how windows relate to
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
12 frames. @xref{Display}, for information on how text is displayed in
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
13 windows.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15 @menu
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16 * Basic Windows:: Basic information on using windows.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17 * Splitting Windows:: Splitting one window into two windows.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18 * Deleting Windows:: Deleting a window gives its space to other windows.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19 * Selecting Windows:: The selected window is the one that you edit in.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20 * Cyclic Window Ordering:: Moving around the existing windows.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21 * Buffers and Windows:: Each window displays the contents of a buffer.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22 * Displaying Buffers:: Higher-level functions for displaying a buffer
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
23 and choosing a window for it.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
24 * Choosing Window:: How to choose a window for displaying a buffer.
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
25 * Dedicated Windows:: How to avoid displaying another buffer in
99465
3bf4c25d3b4b (Basic Windows, Splitting Windows)
Eli Zaretskii <eliz@gnu.org>
parents: 99441
diff changeset
26 a specific window.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
27 * Window Point:: Each window has its own location of point.
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
28 * Window Start and End:: Buffer positions indicating which text is
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
29 on-screen in a window.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
30 * Textual Scrolling:: Moving text up and down through the window.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
31 * Vertical Scrolling:: Moving the contents up and down on the window.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
32 * Horizontal Scrolling:: Moving the contents sideways on the window.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
33 * Size of Window:: Accessing the size of a window.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
34 * Resizing Windows:: Changing the size of a window.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
35 * Coordinates and Windows:: Converting coordinates to windows.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
36 * Window Tree:: The layout and sizes of all windows in a frame.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
37 * Window Configurations:: Saving and restoring the state of the screen.
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
38 * Window Parameters:: Associating additional information with windows.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
39 * Window Hooks:: Hooks for scrolling, window size changes,
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
40 redisplay going past a certain point,
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
41 or window configuration changes.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
42 @end menu
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
43
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
44 @node Basic Windows
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
45 @section Basic Concepts of Emacs Windows
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
46 @cindex window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
47 @cindex selected window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
48
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
49 A @dfn{window} in Emacs is the physical area of the screen in which a
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
50 buffer is displayed. The term is also used to refer to a Lisp object that
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
51 represents that screen area in Emacs Lisp. It should be
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
52 clear from the context which is meant.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
53
99474
ecad25300f20 Fix usage of `see @ref'.
Eli Zaretskii <eliz@gnu.org>
parents: 99465
diff changeset
54 Emacs groups windows into frames; see @ref{Frames}. A frame
99465
3bf4c25d3b4b (Basic Windows, Splitting Windows)
Eli Zaretskii <eliz@gnu.org>
parents: 99441
diff changeset
55 represents an area of screen available for Emacs to use. Each frame
3bf4c25d3b4b (Basic Windows, Splitting Windows)
Eli Zaretskii <eliz@gnu.org>
parents: 99441
diff changeset
56 always contains at least one window, but you can subdivide it
3bf4c25d3b4b (Basic Windows, Splitting Windows)
Eli Zaretskii <eliz@gnu.org>
parents: 99441
diff changeset
57 vertically or horizontally into multiple, nonoverlapping Emacs
3bf4c25d3b4b (Basic Windows, Splitting Windows)
Eli Zaretskii <eliz@gnu.org>
parents: 99441
diff changeset
58 windows.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
59
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
60 In each frame, at any time, one and only one window is designated as
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
61 @dfn{selected within the frame}. The frame's cursor appears in that
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
62 window, but the other windows have ``non-selected'' cursors, normally
99465
3bf4c25d3b4b (Basic Windows, Splitting Windows)
Eli Zaretskii <eliz@gnu.org>
parents: 99441
diff changeset
63 less visible. (@xref{Cursor Parameters}, for customizing this.) At
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
64 any time, one frame is the selected frame; and the window selected
85114
5039706521c9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
65 within that frame is @dfn{the selected window}. The selected window's
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
66 buffer is usually the current buffer (except when @code{set-buffer} has
99474
ecad25300f20 Fix usage of `see @ref'.
Eli Zaretskii <eliz@gnu.org>
parents: 99465
diff changeset
67 been used); see @ref{Current Buffer}.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
68
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
69 For practical purposes, a window exists only while it is displayed in
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
70 a frame. Once removed from the frame, the window is effectively deleted
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
71 and should not be used, @emph{even though there may still be references
99474
ecad25300f20 Fix usage of `see @ref'.
Eli Zaretskii <eliz@gnu.org>
parents: 99465
diff changeset
72 to it} from other Lisp objects; see @ref{Deleting Windows}. Restoring a
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
73 saved window configuration is the only way for a window no longer on the
99474
ecad25300f20 Fix usage of `see @ref'.
Eli Zaretskii <eliz@gnu.org>
parents: 99465
diff changeset
74 screen to come back to life; see @ref{Window Configurations}.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
75
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
76 @cindex multiple windows
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
77 Users create multiple windows so they can look at several buffers at
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
78 once. Lisp libraries use multiple windows for a variety of reasons, but
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
79 most often to display related information. In Rmail, for example, you
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
80 can move through a summary buffer in one window while the other window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
81 shows messages one at a time as they are reached.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
82
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
83 The meaning of ``window'' in Emacs is similar to what it means in the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
84 context of general-purpose window systems such as X, but not identical.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
85 The X Window System places X windows on the screen; Emacs uses one or
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
86 more X windows as frames, and subdivides them into
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
87 Emacs windows. When you use Emacs on a character-only terminal, Emacs
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
88 treats the whole terminal screen as one frame.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
89
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
90 @cindex terminal screen
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
91 @cindex screen of terminal
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
92 @cindex tiled windows
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
93 Most window systems support arbitrarily located overlapping windows.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
94 In contrast, Emacs windows are @dfn{tiled}; they never overlap, and
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
95 together they fill the whole screen or frame. Because of the way in
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
96 which Emacs creates new windows (@pxref{Splitting Windows}) and resizes
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
97 them (@pxref{Resizing Windows}), not all conceivable tilings of windows
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
98 on an Emacs frame are actually possible.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
99
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
100 @defun windowp object
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
101 This function returns @code{t} if @var{object} is a window.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
102 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
103
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
104 @node Splitting Windows
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
105 @section Splitting Windows
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
106 @cindex splitting windows
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
107 @cindex window splitting
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
108
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
109 The functions described below are the primitives used to split a window
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
110 into two windows. They do not accept a buffer as an argument. Rather,
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
111 the two ``halves'' of the split window initially display the same buffer
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
112 previously visible in the window that was split.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
113
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
114 @deffn Command split-window &optional window size horizontal
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
115 This function splits a new window out of @var{window}'s screen area. It
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
116 returns the new window. The default for @var{window} is the selected
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
117 window. When you split the selected window, it remains selected.
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
118
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
119 If @var{horizontal} is non-@code{nil}, then @var{window} splits into two
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
120 side by side windows. The original window keeps the leftmost @var{size}
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
121 columns, and gives the rest of the columns to the new window.
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
122 Otherwise, @var{window} splits into windows one above the other, the
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
123 original window keeps the upper @var{size} lines and gives the rest of
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
124 the lines to the new window. The original window @var{window} is
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
125 therefore the left-hand or upper of the two, and the new window is the
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
126 right-hand or lower.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
127
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
128 If @var{size} is omitted or @code{nil}, then @var{window} is divided
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
129 evenly into two parts. (If there is an odd line, it is allocated to
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
130 the new window.) When @code{split-window} is called interactively,
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
131 all its arguments are @code{nil}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
132
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
133 If splitting would result in making a window that is smaller than
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
134 @code{window-min-height} or @code{window-min-width} (@pxref{Resizing
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
135 Windows}), @code{split-window} signals an error and does not split the
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
136 window at all.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
137
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
138 The following example starts with one window on a screen that is 50
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
139 lines high by 80 columns wide; then it splits the window.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
140
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
141 @smallexample
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
142 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
143 (setq w (selected-window))
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
144 @result{} #<window 8 on windows.texi>
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
145 (window-edges) ; @r{Edges in order:}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
146 @result{} (0 0 80 50) ; @r{left--top--right--bottom}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
147 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
148
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
149 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
150 ;; @r{Returns window created}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
151 (setq w2 (split-window w 15))
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
152 @result{} #<window 28 on windows.texi>
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
153 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
154 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
155 (window-edges w2)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
156 @result{} (0 15 80 50) ; @r{Bottom window;}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
157 ; @r{top is line 15}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
158 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
159 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
160 (window-edges w)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
161 @result{} (0 0 80 15) ; @r{Top window}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
162 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
163 @end smallexample
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
164
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
165 The screen looks like this:
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
166
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
167 @smallexample
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
168 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
169 __________
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
170 | | line 0
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
171 | w |
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
172 |__________|
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
173 | | line 15
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
174 | w2 |
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
175 |__________|
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
176 line 50
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
177 column 0 column 80
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
178 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
179 @end smallexample
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
180
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
181 Next, split the top window horizontally:
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
182
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
183 @smallexample
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
184 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
185 (setq w3 (split-window w 35 t))
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
186 @result{} #<window 32 on windows.texi>
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
187 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
188 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
189 (window-edges w3)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
190 @result{} (35 0 80 15) ; @r{Left edge at column 35}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
191 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
192 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
193 (window-edges w)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
194 @result{} (0 0 35 15) ; @r{Right edge at column 35}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
195 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
196 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
197 (window-edges w2)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
198 @result{} (0 15 80 50) ; @r{Bottom window unchanged}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
199 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
200 @end smallexample
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
201
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
202 @need 3000
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
203 Now the screen looks like this:
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
204
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
205 @smallexample
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
206 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
207 column 35
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
208 __________
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
209 | | | line 0
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
210 | w | w3 |
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
211 |___|______|
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
212 | | line 15
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
213 | w2 |
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
214 |__________|
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
215 line 50
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
216 column 0 column 80
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
217 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
218 @end smallexample
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
219
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
220 Normally, Emacs indicates the border between two side-by-side windows
99465
3bf4c25d3b4b (Basic Windows, Splitting Windows)
Eli Zaretskii <eliz@gnu.org>
parents: 99441
diff changeset
221 with a scroll bar (@pxref{Scroll Bars}), or with @samp{|} characters. The
3bf4c25d3b4b (Basic Windows, Splitting Windows)
Eli Zaretskii <eliz@gnu.org>
parents: 99441
diff changeset
222 display table can specify alternative border characters; see @ref{Display
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
223 Tables}.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
224 @end deffn
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
225
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
226 @deffn Command split-window-vertically &optional size
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
227 This function splits the selected window into two windows, one above the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
228 other, leaving the upper of the two windows selected, with @var{size}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
229 lines. (If @var{size} is negative, then the lower of the two windows
98794
72fc90d94beb (Basic Windows, Splitting Windows): Fix whitespace and reword.
Martin Rudalics <rudalics@gmx.at>
parents: 92148
diff changeset
230 gets @minus{}@var{size} lines and the upper window gets the rest, but
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
231 the upper window is still the one selected.) However, if
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
232 @code{split-window-keep-point} (see below) is @code{nil}, then either
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
233 window can be selected.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
234
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
235 In other respects, this function is similar to @code{split-window}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
236 In particular, the upper window is the original one and the return
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
237 value is the new, lower window.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
238 @end deffn
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
239
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
240 @defopt split-window-keep-point
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
241 If this variable is non-@code{nil} (the default), then
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
242 @code{split-window-vertically} behaves as described above.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
243
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
244 If it is @code{nil}, then @code{split-window-vertically} adjusts point
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
245 in each of the two windows to avoid scrolling. (This is useful on
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
246 slow terminals.) It selects whichever window contains the screen line
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
247 that point was previously on.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
248
98794
72fc90d94beb (Basic Windows, Splitting Windows): Fix whitespace and reword.
Martin Rudalics <rudalics@gmx.at>
parents: 92148
diff changeset
249 This variable affects the behavior of @code{split-window-vertically}
72fc90d94beb (Basic Windows, Splitting Windows): Fix whitespace and reword.
Martin Rudalics <rudalics@gmx.at>
parents: 92148
diff changeset
250 only. It has no effect on the other functions described here.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
251 @end defopt
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
252
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
253 @deffn Command split-window-horizontally &optional size
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
254 This function splits the selected window into two windows
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
255 side-by-side, leaving the selected window on the left with @var{size}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
256 columns. If @var{size} is negative, the rightmost window gets
98794
72fc90d94beb (Basic Windows, Splitting Windows): Fix whitespace and reword.
Martin Rudalics <rudalics@gmx.at>
parents: 92148
diff changeset
257 @minus{}@var{size} columns, but the leftmost window still remains
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
258 selected.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
259
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
260 This function is basically an interface to @code{split-window}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
261 You could define a simplified version of the function like this:
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
262
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
263 @smallexample
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
264 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
265 (defun split-window-horizontally (&optional arg)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
266 "Split selected window into two windows, side by side..."
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
267 (interactive "P")
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
268 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
269 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
270 (let ((size (and arg (prefix-numeric-value arg))))
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
271 (and size (< size 0)
98794
72fc90d94beb (Basic Windows, Splitting Windows): Fix whitespace and reword.
Martin Rudalics <rudalics@gmx.at>
parents: 92148
diff changeset
272 (setq size (+ (window-width) size)))
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
273 (split-window nil size t)))
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
274 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
275 @end smallexample
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
276 @end deffn
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
277
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
278 @defun one-window-p &optional no-mini all-frames
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
279 This function returns non-@code{nil} if there is only one window. The
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
280 argument @var{no-mini}, if non-@code{nil}, means don't count the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
281 minibuffer even if it is active; otherwise, the minibuffer window is
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
282 counted when it is active.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
283
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
284 The argument @var{all-frames} specifies which frames to consider. Here
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
285 are the possible values and their meanings:
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
286
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
287 @table @asis
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
288 @item @code{nil}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
289 Count the windows in the selected frame, plus the minibuffer used
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
290 by that frame even if it lies in some other frame.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
291
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
292 @item @code{t}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
293 Count all windows in all existing frames.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
294
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
295 @item @code{visible}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
296 Count all windows in all visible frames.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
297
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
298 @item 0
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
299 Count all windows in all visible or iconified frames.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
300
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
301 @item anything else
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
302 Count precisely the windows in the selected frame, and no others.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
303 @end table
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
304 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
305
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
306 @node Deleting Windows
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
307 @section Deleting Windows
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
308 @cindex deleting windows
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
309
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
310 A window remains visible on its frame unless you @dfn{delete} it by
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
311 calling certain functions that delete windows. A deleted window cannot
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
312 appear on the screen, but continues to exist as a Lisp object until
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
313 there are no references to it. There is no way to cancel the deletion
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
314 of a window aside from restoring a saved window configuration
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
315 (@pxref{Window Configurations}). Restoring a window configuration also
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
316 deletes any windows that aren't part of that configuration.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
317
99465
3bf4c25d3b4b (Basic Windows, Splitting Windows)
Eli Zaretskii <eliz@gnu.org>
parents: 99441
diff changeset
318 When you delete a window, the space it took up is given to one of
3bf4c25d3b4b (Basic Windows, Splitting Windows)
Eli Zaretskii <eliz@gnu.org>
parents: 99441
diff changeset
319 its sibling windows adjacent to it.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
320
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
321 @c Emacs 19 feature
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
322 @defun window-live-p window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
323 This function returns @code{nil} if @var{window} is deleted, and
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
324 @code{t} otherwise.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
325
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
326 @strong{Warning:} Erroneous information or fatal errors may result from
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
327 using a deleted window as if it were live.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
328 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
329
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
330 @deffn Command delete-window &optional window
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
331 This function removes @var{window} from display and returns @code{nil}.
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
332 The default for @var{window} is the selected window. An error is
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
333 signaled if @var{window} is the only window on its frame.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
334 @end deffn
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
335
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
336 @deffn Command delete-other-windows &optional window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
337 This function makes @var{window} the only window on its frame, by
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
338 deleting the other windows in that frame. The default for @var{window}
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
339 is the selected window. The return value is @code{nil}.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
340 @end deffn
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
341
99128
1b8fa7deb470 (Deleting Windows): Update documentation of delete-windows-on.
Martin Rudalics <rudalics@gmx.at>
parents: 99029
diff changeset
342 @deffn Command delete-windows-on &optional buffer-or-name frame
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
343 This function deletes all windows showing @var{buffer-or-name}. If
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
344 there are no windows showing @var{buffer-or-name}, it does nothing. The
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
345 optional argument @var{buffer-or-name} may be a buffer or the name of an
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
346 existing buffer and defaults to the current buffer.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
347
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
348 @code{delete-windows-on} operates frame by frame. If a frame has
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
349 several windows showing different buffers, then those showing
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
350 @var{buffer-or-name} are removed, and the others expand to fill the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
351 space. If all windows in some frame are showing @var{buffer-or-name}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
352 (including the case where there is only one window), then the frame
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
353 winds up with a single window showing another buffer chosen with
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
354 @code{other-buffer} (@pxref{The Buffer List}). If, however, the window
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
355 showing @var{buffer-or-name} is dedicated to its buffer
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
356 (@pxref{Dedicated Windows}), and there are other frames left, that
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
357 window's frame is deleted.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
358
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
359 The optional argument @var{frame} specifies which frames to operate on.
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
360 This function does not use it in quite the same way as the other
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
361 functions which scan all windows; specifically, the values @code{t} and
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
362 @code{nil} have the opposite of their meanings in other functions. Here
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
363 are the full details:
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
364
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
365 @itemize @bullet
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
366 @item
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
367 If it is @code{nil}, operate on all frames.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
368 @item
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
369 If it is @code{t}, operate on the selected frame.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
370 @item
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
371 If it is @code{visible}, operate on all visible frames.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
372 @item
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
373 If it is 0, operate on all visible or iconified frames.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
374 @item
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
375 If it is a frame, operate on that frame.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
376 @end itemize
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
377
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
378 This function always returns @code{nil}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
379 @end deffn
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
380
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
381 @node Selecting Windows
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
382 @section Selecting Windows
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
383 @cindex selecting a window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
384
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
385 When a window is selected, the buffer in the window becomes the current
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
386 buffer, and the cursor will appear in it.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
387
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
388 @defun selected-window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
389 This function returns the selected window. This is the window in
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
390 which the cursor appears and to which many commands apply.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
391 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
392
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
393 @defun select-window window &optional norecord
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
394 This function makes @var{window} the selected window. The cursor then
99465
3bf4c25d3b4b (Basic Windows, Splitting Windows)
Eli Zaretskii <eliz@gnu.org>
parents: 99441
diff changeset
395 appears in @var{window} (after redisplay). Unless @var{window} was
3bf4c25d3b4b (Basic Windows, Splitting Windows)
Eli Zaretskii <eliz@gnu.org>
parents: 99441
diff changeset
396 already selected, @code{select-window} makes @var{window}'s buffer the
3bf4c25d3b4b (Basic Windows, Splitting Windows)
Eli Zaretskii <eliz@gnu.org>
parents: 99441
diff changeset
397 current buffer. The return value is @var{window}.
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
398
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
399 Normally, @var{window}'s selected buffer is moved to the front of the
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
400 buffer list (@pxref{The Buffer List}) and @var{window} becomes the most
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
401 recently selected window. But if @var{norecord} is non-@code{nil}, the
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
402 buffer list remains unchanged and @var{window} does not become the most
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
403 recently selected one.
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
404
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
405
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
406 @example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
407 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
408 (setq w (next-window))
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
409 (select-window w)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
410 @result{} #<window 65 on windows.texi>
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
411 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
412 @end example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
413 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
414
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
415 @defmac save-selected-window forms@dots{}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
416 This macro records the selected frame, as well as the selected window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
417 of each frame, executes @var{forms} in sequence, then restores the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
418 earlier selected frame and windows. It also saves and restores the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
419 current buffer. It returns the value of the last form in @var{forms}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
420
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
421 This macro does not save or restore anything about the sizes,
99465
3bf4c25d3b4b (Basic Windows, Splitting Windows)
Eli Zaretskii <eliz@gnu.org>
parents: 99441
diff changeset
422 arrangement or contents of windows; therefore, if @var{forms} change
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
423 them, the change persists. If the previously selected window of some
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
424 frame is no longer live at the time of exit from @var{forms}, that
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
425 frame's selected window is left alone. If the previously selected
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
426 window is no longer live, then whatever window is selected at the end of
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
427 @var{forms} remains selected. The current buffer is restored if and
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
428 only if it is still live when exiting @var{forms}.
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
429
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
430 This macro changes neither the ordering of recently selected windows nor
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
431 the buffer list.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
432 @end defmac
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
433
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
434 @defmac with-selected-window window forms@dots{}
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
435 This macro selects @var{window}, executes @var{forms} in sequence, then
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
436 restores the previously selected window and current buffer. The ordering
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
437 of recently selected windows and the buffer list remain unchanged unless
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
438 you deliberately change them within @var{forms}, for example, by calling
99465
3bf4c25d3b4b (Basic Windows, Splitting Windows)
Eli Zaretskii <eliz@gnu.org>
parents: 99441
diff changeset
439 @code{select-window} with argument @var{norecord} @code{nil} or omitted
3bf4c25d3b4b (Basic Windows, Splitting Windows)
Eli Zaretskii <eliz@gnu.org>
parents: 99441
diff changeset
440 there.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
441 @end defmac
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
442
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
443 @cindex finding windows
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
444 The following functions choose one of the windows on the screen,
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
445 offering various criteria for the choice.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
446
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
447 @defun get-lru-window &optional frame dedicated
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
448 This function returns the window least recently ``used'' (that is,
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
449 selected). If any full-width windows are present, it only considers
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
450 these.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
451
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
452 The selected window can be the least recently used window if it is the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
453 only window. A newly created window becomes the least recently used
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
454 window until it is selected. A minibuffer window is never a candidate.
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
455 A dedicated window (@pxref{Dedicated Windows}) is never a candidate
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
456 unless the optional argument @var{dedicated} is non-@code{nil}.
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
457
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
458 The optional argument @var{frame} specifies which windows are
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
459 considered.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
460
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
461 @itemize @bullet
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
462 @item
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
463 If it is @code{nil}, consider windows on the selected frame.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
464 @item
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
465 If it is @code{t}, consider windows on all frames.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
466 @item
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
467 If it is @code{visible}, consider windows on all visible frames.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
468 @item
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
469 If it is 0, consider windows on all visible or iconified frames.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
470 @item
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
471 If it is a frame, consider windows on that frame.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
472 @end itemize
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
473 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
474
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
475 @defun get-largest-window &optional frame dedicated
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
476 This function returns the window with the largest area (height times
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
477 width). If there are no side-by-side windows, then this is the window
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
478 with the most lines. A minibuffer window is never a candidate. A
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
479 dedicated window (@pxref{Dedicated Windows}) is never a candidate unless
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
480 the optional argument @var{dedicated} is non-@code{nil}.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
481
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
482 If there are two candidate windows of the same size, this function
99465
3bf4c25d3b4b (Basic Windows, Splitting Windows)
Eli Zaretskii <eliz@gnu.org>
parents: 99441
diff changeset
483 prefers the one that comes first in the cyclic ordering of windows,
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
484 starting from the selected window (@pxref{Cyclic Window Ordering}).
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
485
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
486 The optional argument @var{frame} specifies which set of windows to
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
487 consider, see @code{get-lru-window} above.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
488 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
489
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
490 @cindex window that satisfies a predicate
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
491 @cindex conditional selection of windows
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
492 @defun get-window-with-predicate predicate &optional minibuf all-frames default
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
493 This function returns a window satisfying @var{predicate}. It cycles
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
494 through all visible windows using @code{walk-windows} (@pxref{Cyclic
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
495 Window Ordering}), calling @var{predicate} on each one of them with that
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
496 window as its argument. The function returns the first window for which
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
497 @var{predicate} returns a non-@code{nil} value; if that never happens,
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
498 it returns @var{default} (which defaults to @code{nil}).
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
499
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
500 The optional arguments @var{minibuf} and @var{all-frames} specify the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
501 set of windows to include in the scan. See the description of
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
502 @code{next-window} in @ref{Cyclic Window Ordering}, for details.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
503 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
504
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
505 @node Cyclic Window Ordering
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
506 @comment node-name, next, previous, up
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
507 @section Cyclic Ordering of Windows
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
508 @cindex cyclic ordering of windows
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
509 @cindex ordering of windows, cyclic
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
510 @cindex window ordering, cyclic
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
511
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
512 When you use the command @kbd{C-x o} (@code{other-window}) to select
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
513 some other window, it moves through the windows on the screen in a
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
514 specific order. For any given configuration of windows, this order
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
515 never varies. It is called the @dfn{cyclic ordering of windows}.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
516
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
517 This ordering generally goes from top to bottom, and from left to
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
518 right. But it may go down first or go right first, depending on the
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
519 order in which windows were split.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
520
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
521 If the first split was vertical (into windows one above each other),
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
522 and then the subwindows were split horizontally, then the ordering is
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
523 left to right in the top of the frame, and then left to right in the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
524 next lower part of the frame, and so on. If the first split was
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
525 horizontal, the ordering is top to bottom in the left part, and so on.
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
526 In general, within each set of siblings at any level in the window tree
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
527 (@pxref{Window Tree}), the order is left to right, or top to bottom.
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
528
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
529 @deffn Command next-window &optional window minibuf all-frames
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
530 @cindex minibuffer window, and @code{next-window}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
531 This function returns the window following @var{window} in the cyclic
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
532 ordering of windows. This is the window @kbd{C-x o} selects if typed
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
533 when @var{window} is selected. The default for @var{window} is the
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
534 selected window.
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
535
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
536 The value of the optional argument @var{minibuf} specifies whether the
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
537 minibuffer is included in the window order. Normally, when
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
538 @var{minibuf} is @code{nil}, the minibuffer is included only if it is
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
539 currently ``active''; this matches the behavior of @kbd{C-x o}. (The
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
540 minibuffer window is active while the minibuffer is in use; see
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
541 @ref{Minibuffers}.)
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
542
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
543 If @var{minibuf} is @code{t}, the cyclic ordering includes the
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
544 minibuffer window even if it is not active. If @var{minibuf} is neither
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
545 @code{t} nor @code{nil}, the minibuffer window is not included even if
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
546 it is active.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
547
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
548 The optional argument @var{all-frames} specifies which frames to
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
549 consider. Here are the possible values and their meanings:
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
550
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
551 @table @asis
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
552 @item @code{nil}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
553 Consider all the windows in @var{window}'s frame, plus the minibuffer
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
554 used by that frame even if it lies in some other frame. If the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
555 minibuffer counts (as determined by @var{minibuf}), then all windows on
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
556 all frames that share that minibuffer count too.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
557
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
558 @item @code{t}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
559 Consider all windows in all existing frames.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
560
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
561 @item @code{visible}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
562 Consider all windows in all visible frames. (To get useful results, you
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
563 must ensure @var{window} is in a visible frame.)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
564
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
565 @item 0
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
566 Consider all windows in all visible or iconified frames.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
567
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
568 @item a frame
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
569 Consider all windows on that frame.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
570
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
571 @item anything else
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
572 Consider precisely the windows in @var{window}'s frame, and no others.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
573 @end table
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
574
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
575 This example assumes there are two windows, both displaying the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
576 buffer @samp{windows.texi}:
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
577
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
578 @example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
579 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
580 (selected-window)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
581 @result{} #<window 56 on windows.texi>
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
582 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
583 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
584 (next-window (selected-window))
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
585 @result{} #<window 52 on windows.texi>
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
586 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
587 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
588 (next-window (next-window (selected-window)))
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
589 @result{} #<window 56 on windows.texi>
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
590 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
591 @end example
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
592 @end deffn
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
593
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
594 @deffn Command previous-window &optional window minibuf all-frames
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
595 This function returns the window preceding @var{window} in the cyclic
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
596 ordering of windows. The other arguments specify which windows to
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
597 include in the cycle, as in @code{next-window}.
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
598 @end deffn
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
599
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
600 @deffn Command other-window count &optional all-frames
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
601 This function selects another window in the cyclic ordering of windows.
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
602 @var{count} specifies the number of windows to skip in the ordering,
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
603 starting with the selected window, before making the selection. If
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
604 @var{count} is a positive number, it skips @var{count} windows forwards.
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
605 @var{count} negative means skip @minus{}@var{count} windows backwards.
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
606 If @var{count} is zero, it does not skip any window, thus re-selecting
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
607 the selected window. In an interactive call, @var{count} is the numeric
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
608 prefix argument.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
609
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
610 The optional argument @var{all-frames} has the same meaning as in
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
611 @code{next-window}, but the @var{minibuf} argument of @code{next-window}
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
612 is always effectively @code{nil}. This function returns @code{nil}.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
613 @end deffn
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
614
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
615 @c Emacs 19 feature
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
616 @defun walk-windows proc &optional minibuf all-frames
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
617 This function cycles through all windows. It calls the function
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
618 @code{proc} once for each window, with the window as its sole
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
619 argument.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
620
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
621 The optional arguments @var{minibuf} and @var{all-frames} specify the
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
622 set of windows to include in the walk. See @code{next-window}, above,
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
623 for details.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
624 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
625
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
626 @defun window-list &optional frame minibuf window
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
627 This function returns a list of all windows on @var{frame}, starting
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
628 with @var{window}. The default for @var{frame} is the selected frame;
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
629 the default for @var{window} is the selected window.
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
630
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
631 The value of @var{minibuf} specifies if the minibuffer window shall be
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
632 included in the result list. If @var{minibuf} is @code{t}, the result
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
633 always includes the minibuffer window. If @var{minibuf} is @code{nil}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
634 or omitted, that includes the minibuffer window if it is active. If
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
635 @var{minibuf} is neither @code{nil} nor @code{t}, the result never
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
636 includes the minibuffer window.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
637 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
638
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
639 @node Buffers and Windows
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
640 @section Buffers and Windows
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
641 @cindex examining windows
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
642 @cindex windows, controlling precisely
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
643 @cindex buffers, controlled in windows
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
644
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
645 This section describes low-level functions to examine windows or to
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
646 display buffers in windows in a precisely controlled fashion.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
647 @iftex
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
648 See the following section for
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
649 @end iftex
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
650 @ifnottex
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
651 @xref{Displaying Buffers}, for
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
652 @end ifnottex
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
653 related functions that find a window to use and specify a buffer for it.
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
654 The functions described there are easier to use, but they employ
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
655 heuristics in choosing or creating a window; use the functions described
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
656 here when you need complete control.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
657
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
658 @defun set-window-buffer window buffer-or-name &optional keep-margins
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
659 This function makes @var{window} display @var{buffer-or-name} as its
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
660 contents. It returns @code{nil}. The default for @var{window} is the
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
661 selected window. The argument @var{buffer-or-name} must specify a
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
662 buffer or the name of an existing buffer.
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
663
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
664 @code{set-window-buffer} is the fundamental primitive for changing which
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
665 buffer is displayed in a window, and all ways of doing that call this
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
666 function.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
667
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
668 @example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
669 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
670 (set-window-buffer (selected-window) "foo")
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
671 @result{} nil
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
672 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
673 @end example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
674
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
675 Normally, displaying @var{buffer-or-name} in @var{window} resets the
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
676 window's position, display margins, fringe widths, and scroll bar
99465
3bf4c25d3b4b (Basic Windows, Splitting Windows)
Eli Zaretskii <eliz@gnu.org>
parents: 99441
diff changeset
677 settings based on the local variables of that buffer.
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
678 However, if @var{keep-margins} is non-@code{nil}, display margins and
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
679 fringe widths of @var{window} remain unchanged. @xref{Fringes}.
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
680
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
681 @code{set-window-buffer} signals an error when @var{window} is
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
682 @dfn{strongly} dedicated to its buffer (@pxref{Dedicated Windows}) and
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
683 does not already display @var{buffer-or-name}.
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
684
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
685 Note that this function runs @code{window-scroll-functions} before
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
686 running @code{window-configuration-change-hook}.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
687 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
688
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
689 @defvar buffer-display-count
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
690 This buffer-local variable records the number of times a buffer has been
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
691 displayed in a window. It is incremented each time
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
692 @code{set-window-buffer} is called for the buffer.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
693 @end defvar
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
694
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
695 @defun window-buffer &optional window
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
696 This function returns the buffer that @var{window} is displaying. The
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
697 default for @var{window} is the selected window.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
698
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
699 @example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
700 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
701 (window-buffer)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
702 @result{} #<buffer windows.texi>
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
703 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
704 @end example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
705 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
706
99128
1b8fa7deb470 (Deleting Windows): Update documentation of delete-windows-on.
Martin Rudalics <rudalics@gmx.at>
parents: 99029
diff changeset
707 @defun get-buffer-window &optional buffer-or-name all-frames
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
708 This function returns a window currently displaying
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
709 @var{buffer-or-name}, or @code{nil} if there is none. If there are
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
710 several such windows, then the function returns the first one in the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
711 cyclic ordering of windows, starting from the selected window.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
712 @xref{Cyclic Window Ordering}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
713
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
714 The argument @var{BUFFER-OR-NAME} may be a buffer or a buffer name and
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
715 defaults to the current buffer. The optional argument @var{all-frames}
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
716 specifies which windows to consider:
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
717
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
718 @itemize @bullet
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
719 @item
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
720 @code{nil} means consider windows on the selected frame.
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
721 @item
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
722 @code{t} means consider windows on all existing frames.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
723 @item
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
724 @code{visible} means consider windows on all visible frames.
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
725 @item
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
726 0 means consider windows on all visible or iconified frames.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
727 @item
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
728 A frame means consider windows on that frame only.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
729 @end itemize
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
730
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
731 Observe that the behavior of @code{get-buffer-window} may differ from
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
732 that of @code{next-window} (@pxref{Cyclic Window Ordering}) when
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
733 @var{all-frames} equals @code{nil} or any value not listed here.
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
734 Perhaps we will change @code{get-buffer-window} in the future to make it
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
735 compatible with the other functions.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
736 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
737
99128
1b8fa7deb470 (Deleting Windows): Update documentation of delete-windows-on.
Martin Rudalics <rudalics@gmx.at>
parents: 99029
diff changeset
738 @defun get-buffer-window-list &optional buffer-or-name minibuf all-frames
1b8fa7deb470 (Deleting Windows): Update documentation of delete-windows-on.
Martin Rudalics <rudalics@gmx.at>
parents: 99029
diff changeset
739 This function returns a list of all windows currently displaying
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
740 @var{buffer-or-name}. The argument @var{buffer-or-name} may be a buffer
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
741 or the name of an existing buffer and defaults to the current buffer.
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
742
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
743 The two remaining arguments work like the same-named arguments of
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
744 @code{next-window}; they are @emph{not} like the optional arguments of
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
745 @code{get-buffer-window}.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
746 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
747
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
748 @defvar buffer-display-time
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
749 This variable records the time at which a buffer was last made visible
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
750 in a window. It is always local in each buffer; each time
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
751 @code{set-window-buffer} is called, it sets this variable to
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
752 @code{(current-time)} in the specified buffer (@pxref{Time of Day}).
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
753 When a buffer is first created, @code{buffer-display-time} starts out
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
754 with the value @code{nil}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
755 @end defvar
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
756
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
757 @node Displaying Buffers
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
758 @section Displaying Buffers in Windows
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
759 @cindex switching to a buffer
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
760 @cindex displaying a buffer
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
761
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
762 In this section we describe convenient functions that choose a window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
763 automatically and use it to display a specified buffer. These functions
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
764 can also split an existing window in certain circumstances. We also
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
765 describe variables that parameterize the heuristics used for choosing a
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
766 window.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
767 @iftex
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
768 See the preceding section for
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
769 @end iftex
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
770 @ifnottex
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
771 @xref{Buffers and Windows}, for
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
772 @end ifnottex
98812
38749a93f5a4 (Displaying Buffers): Minor wording fix.
Eli Zaretskii <eliz@gnu.org>
parents: 98794
diff changeset
773 low-level primitives that give you more precise control. All of these
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
774 functions work by calling @code{set-window-buffer}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
775
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
776 Do not use the functions in this section in order to make a buffer
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
777 current so that a Lisp program can access or modify it; they are too
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
778 drastic for that purpose, since they change the display of buffers in
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
779 windows, which would be gratuitous and surprise the user. Instead, use
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
780 @code{set-buffer} and @code{save-current-buffer} (@pxref{Current
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
781 Buffer}), which designate buffers as current for programmed access
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
782 without affecting the display of buffers in windows.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
783
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
784 @deffn Command switch-to-buffer buffer-or-name &optional norecord
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
785 This function makes @var{buffer-or-name} the current buffer, and also
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
786 displays the buffer in the selected window. This means that a human can
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
787 see the buffer and subsequent keyboard commands will apply to it.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
788 Contrast this with @code{set-buffer}, which makes @var{buffer-or-name}
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
789 the current buffer but does not display it in the selected window;
99465
3bf4c25d3b4b (Basic Windows, Splitting Windows)
Eli Zaretskii <eliz@gnu.org>
parents: 99441
diff changeset
790 see @ref{Current Buffer}.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
791
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
792 If @var{buffer-or-name} is @code{nil}, @code{switch-to-buffer} chooses a
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
793 buffer using @code{other-buffer}. If @var{buffer-or-name} is a string
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
794 that does not identify an existing buffer, then a new buffer by that
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
795 name is created. The major mode for the new buffer is set according to
99474
ecad25300f20 Fix usage of `see @ref'.
Eli Zaretskii <eliz@gnu.org>
parents: 99465
diff changeset
796 the variable @code{default-major-mode}; see @ref{Auto Major Mode}.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
797
99441
910601b61dec (Displaying Buffers): For switch-to-buffer mention that
Martin Rudalics <rudalics@gmx.at>
parents: 99438
diff changeset
798 When @code{enable-recursive-minibuffers} is non-@code{nil} and the
910601b61dec (Displaying Buffers): For switch-to-buffer mention that
Martin Rudalics <rudalics@gmx.at>
parents: 99438
diff changeset
799 selected window is either the minibuffer window or is dedicated to its
910601b61dec (Displaying Buffers): For switch-to-buffer mention that
Martin Rudalics <rudalics@gmx.at>
parents: 99438
diff changeset
800 buffer (@pxref{Dedicated Windows}), @code{switch-to-buffer} calls
910601b61dec (Displaying Buffers): For switch-to-buffer mention that
Martin Rudalics <rudalics@gmx.at>
parents: 99438
diff changeset
801 @code{pop-to-buffer} (see below) to display the buffer in some other
910601b61dec (Displaying Buffers): For switch-to-buffer mention that
Martin Rudalics <rudalics@gmx.at>
parents: 99438
diff changeset
802 window.
910601b61dec (Displaying Buffers): For switch-to-buffer mention that
Martin Rudalics <rudalics@gmx.at>
parents: 99438
diff changeset
803
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
804 Normally the specified buffer is put at the front of the buffer list
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
805 (both the selected frame's buffer list and the frame-independent buffer
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
806 list). This affects the operation of @code{other-buffer}. However, if
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
807 @var{norecord} is non-@code{nil}, this is not done. @xref{The Buffer
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
808 List}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
809
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
810 The @code{switch-to-buffer} function is often used interactively, as
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
811 the binding of @kbd{C-x b}. It is also used frequently in programs. It
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
812 returns the buffer that it switched to.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
813 @end deffn
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
814
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
815 The next two functions are similar to @code{switch-to-buffer}, except
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
816 for the described features.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
817
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
818 @deffn Command switch-to-buffer-other-window buffer-or-name &optional norecord
99760
690624ab76e0 (Displaying Buffers, Vertical Scrolling)
Martin Rudalics <rudalics@gmx.at>
parents: 99693
diff changeset
819 This function makes the buffer specified by @var{buffer-or-name} current
690624ab76e0 (Displaying Buffers, Vertical Scrolling)
Martin Rudalics <rudalics@gmx.at>
parents: 99693
diff changeset
820 and displays it in a window not currently selected. It then selects
690624ab76e0 (Displaying Buffers, Vertical Scrolling)
Martin Rudalics <rudalics@gmx.at>
parents: 99693
diff changeset
821 that window. The handling of the buffer is the same as in
690624ab76e0 (Displaying Buffers, Vertical Scrolling)
Martin Rudalics <rudalics@gmx.at>
parents: 99693
diff changeset
822 @code{switch-to-buffer}.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
823
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
824 The currently selected window is absolutely never used to do the job.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
825 If it is the only window, then it is split to make a distinct window for
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
826 this purpose. If the selected window is already displaying the buffer,
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
827 then it continues to do so, but another window is nonetheless found to
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
828 display it in as well.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
829
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
830 This function updates the buffer list just like @code{switch-to-buffer}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
831 unless @var{norecord} is non-@code{nil}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
832 @end deffn
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
833
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
834 @deffn Command pop-to-buffer buffer-or-name &optional other-window norecord
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
835 This command makes @var{buffer-or-name} the current buffer and switches
99029
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
836 to it in some window, preferably not the window previously selected.
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
837 The ``popped-to'' window becomes the selected window. Its frame is
99474
ecad25300f20 Fix usage of `see @ref'.
Eli Zaretskii <eliz@gnu.org>
parents: 99465
diff changeset
838 given the X server's focus, if possible; see @ref{Input Focus}. The return
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
839 value is the buffer that was switched to.
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
840
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
841 If @var{buffer-or-name} is @code{nil}, that means to choose some other
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
842 buffer, but you don't specify which. If @var{buffer-or-name} is a
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
843 string that does not name an existing buffer, a buffer by that name is
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
844 created. The major mode for the new buffer is set according to the
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
845 variable @code{default-major-mode}. @xref{Auto Major Mode}.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
846
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
847 If the variable @code{pop-up-frames} is non-@code{nil},
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
848 @code{pop-to-buffer} looks for a window in any visible frame already
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
849 displaying the buffer; if there is one, it selects and returns that
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
850 window. If no such window exists, it creates a new frame and displays
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
851 the buffer in it.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
852
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
853 If @code{pop-up-frames} is @code{nil}, then @code{pop-to-buffer}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
854 operates entirely within the selected frame. (If the selected frame has
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
855 just a minibuffer, @code{pop-to-buffer} operates within the most
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
856 recently selected frame that was not just a minibuffer.)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
857
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
858 If the variable @code{pop-up-windows} is non-@code{nil}, windows may be
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
859 split to create a new window that is different from the original window.
99465
3bf4c25d3b4b (Basic Windows, Splitting Windows)
Eli Zaretskii <eliz@gnu.org>
parents: 99441
diff changeset
860 For details, see @ref{Choosing Window}.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
861
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
862 If @var{other-window} is non-@code{nil}, @code{pop-to-buffer} finds or
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
863 creates another window even if @var{buffer-or-name} is already visible
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
864 in the selected window. Thus @var{buffer-or-name} could end up
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
865 displayed in two windows. On the other hand, if @var{buffer-or-name} is
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
866 already displayed in the selected window and @var{other-window} is
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
867 @code{nil}, then the selected window is considered sufficient for
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
868 displaying @var{buffer-or-name}, so that nothing needs to be done.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
869
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
870 All the variables that affect @code{display-buffer} affect
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
871 @code{pop-to-buffer} as well. @xref{Choosing Window}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
872
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
873 This function updates the buffer list just like @code{switch-to-buffer}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
874 unless @var{norecord} is non-@code{nil}.
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
875 @end deffn
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
876
99128
1b8fa7deb470 (Deleting Windows): Update documentation of delete-windows-on.
Martin Rudalics <rudalics@gmx.at>
parents: 99029
diff changeset
877 @deffn Command replace-buffer-in-windows &optional buffer-or-name
98843
296e6dfba21e (Choosing Window, Displaying Buffers): Fix last changes.
Eli Zaretskii <eliz@gnu.org>
parents: 98835
diff changeset
878 This function replaces @var{buffer-or-name} in all windows displaying
296e6dfba21e (Choosing Window, Displaying Buffers): Fix last changes.
Eli Zaretskii <eliz@gnu.org>
parents: 98835
diff changeset
879 it with some other buffer. It uses @code{other-buffer} to choose the
296e6dfba21e (Choosing Window, Displaying Buffers): Fix last changes.
Eli Zaretskii <eliz@gnu.org>
parents: 98835
diff changeset
880 other buffer. In the usual applications of this function, you
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
881 don't care which other buffer is used; you just want to make sure that
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
882 @var{buffer-or-name} is no longer displayed.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
883
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
884 The argument @var{buffer-or-name} may be a buffer or the name of an
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
885 existing buffer and defaults to the current buffer.
99128
1b8fa7deb470 (Deleting Windows): Update documentation of delete-windows-on.
Martin Rudalics <rudalics@gmx.at>
parents: 99029
diff changeset
886
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
887 If a window displaying @var{buffer-or-name} is dedicated
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
888 (@pxref{Dedicated Windows}), and is not the only window on its frame,
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
889 that window is deleted. If that window is the only window on its frame
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
890 and there are other frames left, the window's frame is deleted too. If
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
891 there are no other frames left, some other buffer is displayed in that
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
892 window.
98835
4c36d8b3b766 (Choosing Window, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 98827
diff changeset
893
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
894 This function returns @code{nil}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
895 @end deffn
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
896
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
897 @node Choosing Window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
898 @section Choosing a Window for Display
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
899
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
900 This section describes the basic facility that chooses a window to
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
901 display a buffer in---@code{display-buffer}. Higher-level functions and
99465
3bf4c25d3b4b (Basic Windows, Splitting Windows)
Eli Zaretskii <eliz@gnu.org>
parents: 99441
diff changeset
902 commands, like @code{switch-to-buffer} and @code{pop-to-buffer}, use this
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
903 subroutine. Here we describe how to use @code{display-buffer} and how
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
904 to customize it.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
905
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
906 @deffn Command display-buffer buffer-or-name &optional not-this-window frame
99029
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
907 This command makes @var{buffer-or-name} appear in some window, but it
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
908 does not select that window and does not make the buffer specified by
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
909 @var{buffer-or-name} current. The identity of the selected window is
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
910 unaltered by this function. The argument @var{buffer-or-name} must be a
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
911 buffer or the name of an existing buffer.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
912
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
913 @var{not-this-window} non-@code{nil} means to display the specified
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
914 buffer in a window other than the selected one, even if it is already
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
915 displayed in the selected window. This can cause the buffer to appear
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
916 in two windows at once. Otherwise, if @var{buffer-or-name} is already
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
917 being displayed in any window, that is good enough, so this function
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
918 does nothing.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
919
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
920 @code{display-buffer} returns the window chosen to display
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
921 @var{buffer-or-name}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
922
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
923 If the optional argument @var{frame} is non-@code{nil}, it specifies
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
924 which frames to check when deciding whether the buffer is already
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
925 displayed. If the buffer is already displayed in some window on one of
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
926 these frames, @code{display-buffer} simply returns that window. Here
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
927 are the possible values of @var{frame}:
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
928
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
929 @itemize @bullet
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
930 @item
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
931 @code{nil} means consider windows on the selected frame.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
932 (Actually, the last non-minibuffer frame.)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
933 @item
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
934 @code{t} means consider windows on all frames.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
935 @item
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
936 @code{visible} means consider windows on all visible frames.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
937 @item
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
938 0 means consider windows on all visible or iconified frames.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
939 @item
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
940 A frame means consider windows on that frame only.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
941 @end itemize
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
942
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
943 Precisely how @code{display-buffer} finds or creates a window depends on
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
944 the variables described below.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
945 @end deffn
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
946
99029
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
947 @defopt display-buffer-reuse-frames
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
948 If this variable is non-@code{nil}, @code{display-buffer} searches
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
949 existing frames for a window displaying @var{buffer-or-name}. If the
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
950 buffer is already displayed in a window in some frame,
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
951 @code{display-buffer} makes the frame visible and raises it, to use that
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
952 window. If the buffer is not already displayed, or
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
953 @code{display-buffer-reuse-frames} is @code{nil}, the behavior of
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
954 @code{display-buffer} is determined by the variables described next.
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
955 @end defopt
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
956
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
957 @defopt pop-up-windows
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
958 This variable specifies whether @code{display-buffer} is allowed to
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
959 split (@pxref{Splitting Windows}) an existing window . If it is
99911
c69004518f91 (Choosing Window, Selecting Windows): Fix typos.
Chong Yidong <cyd@stupidchicken.com>
parents: 99760
diff changeset
960 non-@code{nil}, @code{display-buffer} tries to the split the largest
c69004518f91 (Choosing Window, Selecting Windows): Fix typos.
Chong Yidong <cyd@stupidchicken.com>
parents: 99760
diff changeset
961 or least recently used window on the selected frame. (If the selected
c69004518f91 (Choosing Window, Selecting Windows): Fix typos.
Chong Yidong <cyd@stupidchicken.com>
parents: 99760
diff changeset
962 frame is a minibuffer-only frame, it tries to split a window on
c69004518f91 (Choosing Window, Selecting Windows): Fix typos.
Chong Yidong <cyd@stupidchicken.com>
parents: 99760
diff changeset
963 another frame instead.) If @code{pop-up-windows} is @code{nil} or the
c69004518f91 (Choosing Window, Selecting Windows): Fix typos.
Chong Yidong <cyd@stupidchicken.com>
parents: 99760
diff changeset
964 variable @code{pop-up-frames} (see below) is non-@code{nil},
99029
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
965 @code{display-buffer} does not split any window.
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
966 @end defopt
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
967
98827
4a504448eb9c (Choosing Window): Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 98812
diff changeset
968 @defvar split-window-preferred-function
98812
38749a93f5a4 (Displaying Buffers): Minor wording fix.
Eli Zaretskii <eliz@gnu.org>
parents: 98794
diff changeset
969 This variable specifies how to split a window. Its value, if
38749a93f5a4 (Displaying Buffers): Minor wording fix.
Eli Zaretskii <eliz@gnu.org>
parents: 98794
diff changeset
970 non-@code{nil}, should be a function of one argument, which is a
38749a93f5a4 (Displaying Buffers): Minor wording fix.
Eli Zaretskii <eliz@gnu.org>
parents: 98794
diff changeset
971 window. If this variable specifies a function, @code{display-buffer}
38749a93f5a4 (Displaying Buffers): Minor wording fix.
Eli Zaretskii <eliz@gnu.org>
parents: 98794
diff changeset
972 will call it with one or more candidate windows when it looks for a
98827
4a504448eb9c (Choosing Window): Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 98812
diff changeset
973 window to split. If the argument window fits, the function is
98812
38749a93f5a4 (Displaying Buffers): Minor wording fix.
Eli Zaretskii <eliz@gnu.org>
parents: 98794
diff changeset
974 expected to split it and return a new window. If the function returns
99029
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
975 @code{nil}, the argument window will not be split.
98827
4a504448eb9c (Choosing Window): Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 98812
diff changeset
976
4a504448eb9c (Choosing Window): Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 98812
diff changeset
977 If the value of this variable is @code{nil}, @code{display-buffer}
99029
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
978 uses the two variables described next to decide whether and which
98827
4a504448eb9c (Choosing Window): Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 98812
diff changeset
979 window to split.
4a504448eb9c (Choosing Window): Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 98812
diff changeset
980 @end defvar
98812
38749a93f5a4 (Displaying Buffers): Minor wording fix.
Eli Zaretskii <eliz@gnu.org>
parents: 98794
diff changeset
981
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
982 @defopt split-height-threshold
99029
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
983 This variable specifies whether @code{display-buffer} may split a window
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
984 vertically, provided there are multiple windows. If the value is a
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
985 number, @code{display-buffer} splits a window only if it has at least
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
986 this many lines. If no window is tall enough, or if the value of this
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
987 variable is @code{nil}, @code{display-buffer} tries to split some window
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
988 horizontally, subject to restrictions of @code{split-width-threshold}
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
989 (see below). If splitting horizontally is impossible too,
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
990 @code{display-buffer} splits a window vertically only if it's the only
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
991 window on its frame and not the minibuffer window, and only if
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
992 @code{pop-up-windows} is non-@code{nil}.
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
993
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
994 A window whose height is fixed (@pxref{Resizing Windows}) cannot be
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
995 split vertically by @code{display-buffer}. Also, @code{display-buffer}
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
996 splits a window vertically only if it can accommodate two windows that
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
997 are both at least `window-min-height' lines tall. Moreover, if the
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
998 window that shall be split has a mode line, the window must be at least
99029
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
999 four lines tall in order to make sure that the new window can have a
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1000 mode line as well. If the original window doesn't have a mode line, a
99029
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1001 height of two lines suffices.
98812
38749a93f5a4 (Displaying Buffers): Minor wording fix.
Eli Zaretskii <eliz@gnu.org>
parents: 98794
diff changeset
1002 @end defopt
38749a93f5a4 (Displaying Buffers): Minor wording fix.
Eli Zaretskii <eliz@gnu.org>
parents: 98794
diff changeset
1003
38749a93f5a4 (Displaying Buffers): Minor wording fix.
Eli Zaretskii <eliz@gnu.org>
parents: 98794
diff changeset
1004 @defopt split-width-threshold
99029
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1005 This variable specifies whether @code{display-buffer} may split a window
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1006 horizontally. If the value is a number, @code{display-buffer} may split
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1007 a window if it has at least this many columns. If the value of this
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1008 variable is @code{nil}, @code{display-buffer} will not split any windows
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1009 horizontally. (It still might split some window vertically, though, see
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1010 above.)
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1011
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1012 A window whose width is fixed (@pxref{Resizing Windows}) cannot be split
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1013 horizontally by @code{display-buffer}. Also, @code{display-buffer}
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1014 splits a window horizontally only if it can accommodate two windows that
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1015 are both at least `window-min-width' columns wide.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1016 @end defopt
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1017
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1018 @defopt even-window-heights
98944
e3bf6a4e1aa6 More wording fixes from RMS.
Eli Zaretskii <eliz@gnu.org>
parents: 98928
diff changeset
1019 This variable specifies whether @code{display-buffer} should even out
99029
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1020 window heights if the buffer gets displayed in an existing window, above
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1021 or beneath another window. If @code{even-window-heights} is
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1022 non-@code{nil}, the default, window heights will be evened out. If
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1023 either of the involved window has fixed height (@pxref{Resizing
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1024 Windows}) or @code{even-window-heights} is @code{nil}, the original
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1025 window heights will be left alone.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1026 @end defopt
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1027
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1028 @c Emacs 19 feature
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1029 @defopt pop-up-frames
98944
e3bf6a4e1aa6 More wording fixes from RMS.
Eli Zaretskii <eliz@gnu.org>
parents: 98928
diff changeset
1030 This variable specifies whether @code{display-buffer} makes new frames.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1031 If it is non-@code{nil}, @code{display-buffer} looks for an existing
99029
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1032 window already displaying the desired buffer, on any visible frame. If
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1033 it finds one, it returns that window. Otherwise it makes a new frame,
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1034 unless the variable's value is @code{graphic-only} and the selected
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1035 frame is not on a graphic display. @xref{Frames}, for more information.
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1036
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1037 Note that the value of @code{pop-up-windows} does not matter if
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1038 @code{pop-up-frames} is non-@code{nil}. If @code{pop-up-frames} is
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1039 @code{nil}, then @code{display-buffer} either splits a window or reuses
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1040 one.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1041 @end defopt
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1042
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1043 @c Emacs 19 feature
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1044 @defopt pop-up-frame-function
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1045 This variable specifies how to make a new frame if @code{pop-up-frames}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1046 is non-@code{nil}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1047
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1048 Its value should be a function of no arguments. When
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1049 @code{display-buffer} makes a new frame, it does so by calling that
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1050 function, which should return a frame. The default value of the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1051 variable is a function that creates a frame using parameters from
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1052 @code{pop-up-frame-alist}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1053 @end defopt
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1054
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1055 @defopt pop-up-frame-alist
100846
d74b83c02d95 (Choosing Window): Say that pop-up-frame-alist
Martin Rudalics <rudalics@gmx.at>
parents: 100555
diff changeset
1056 This variable holds an alist specifying frame parameters used by the
d74b83c02d95 (Choosing Window): Say that pop-up-frame-alist
Martin Rudalics <rudalics@gmx.at>
parents: 100555
diff changeset
1057 default value of @code{pop-up-frame-function} for making new frames.
d74b83c02d95 (Choosing Window): Say that pop-up-frame-alist
Martin Rudalics <rudalics@gmx.at>
parents: 100555
diff changeset
1058 @xref{Frame Parameters}, for more information about frame parameters.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1059 @end defopt
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1060
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1061 @defopt special-display-buffer-names
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1062 A list of buffer names identifying buffers that should be displayed
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1063 specially. If the name of @var{buffer-or-name} is in this list,
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1064 @code{display-buffer} handles the buffer specially. By default, special
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1065 display means to give the buffer a dedicated frame.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1066
99029
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1067 If an element is a list, instead of a string, then the @sc{car} of that
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1068 list is the buffer name, and the rest of that list says how to create
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1069 the frame. There are two possibilities for the rest of that list (its
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1070 @sc{cdr}): It can be an alist, specifying frame parameters, or it can
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1071 contain a function and arguments to give to it. (The function's first
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1072 argument is always the buffer to be displayed; the arguments from the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1073 list come after that.)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1074
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1075 For example:
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1076
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1077 @example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1078 (("myfile" (minibuffer) (menu-bar-lines . 0)))
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1079 @end example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1080
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1081 @noindent
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1082 specifies to display a buffer named @samp{myfile} in a dedicated frame
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1083 with specified @code{minibuffer} and @code{menu-bar-lines} parameters.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1084
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1085 The list of frame parameters can also use the phony frame parameters
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1086 @code{same-frame} and @code{same-window}. If the specified frame
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1087 parameters include @code{(same-window . @var{value})} and @var{value}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1088 is non-@code{nil}, that means to display the buffer in the current
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1089 selected window. Otherwise, if they include @code{(same-frame .
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1090 @var{value})} and @var{value} is non-@code{nil}, that means to display
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1091 the buffer in a new window in the currently selected frame.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1092 @end defopt
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1093
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1094 @defopt special-display-regexps
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1095 A list of regular expressions specifying buffers that should be
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1096 displayed specially. If the buffer's name matches any of the regular
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1097 expressions in this list, @code{display-buffer} handles the buffer
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1098 specially. By default, special display means to give the buffer a
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1099 dedicated frame.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1100
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1101 If an element is a list, instead of a string, then the @sc{car} of the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1102 list is the regular expression, and the rest of the list says how to
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1103 create the frame. See @code{special-display-buffer-names} above.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1104 @end defopt
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1105
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1106 @defun special-display-p buffer-name
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1107 This function returns non-@code{nil} if displaying a buffer
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1108 named @var{buffer-name} with @code{display-buffer} would
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1109 create a special frame. The value is @code{t} if it would
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1110 use the default frame parameters, or else the specified list
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1111 of frame parameters.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1112 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1113
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1114 @defvar special-display-function
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1115 This variable holds the function to call to display a buffer specially.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1116 It receives the buffer as an argument, and should return the window in
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1117 which it is displayed. The default value of this variable is
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1118 @code{special-display-popup-frame}, see below.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1119 @end defvar
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1120
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1121 @defun special-display-popup-frame buffer &optional args
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1122 This function tries to make @var{buffer} visible in a frame of its own.
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1123 If @var{buffer} is already displayed in some window, it makes that
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1124 window's frame visible and raises it. Otherwise, it creates a frame
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1125 that is dedicated to @var{buffer}. The return value is the window used
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1126 to display @var{buffer}.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1127
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1128 If @var{args} is an alist, it specifies frame parameters for the new
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1129 frame. If @var{args} is a list whose @sc{car} is a symbol, then
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1130 @code{(car @var{args})} is called as a function to actually create and
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1131 set up the frame; it is called with @var{buffer} as first argument, and
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1132 @code{(cdr @var{args})} as additional arguments.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1133
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1134 This function always uses an existing window displaying @var{buffer},
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1135 whether or not it is in a frame of its own; but if you set up the above
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1136 variables in your init file, before @var{buffer} was created, then
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1137 presumably the window was previously made by this function.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1138 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1139
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1140 @defopt special-display-frame-alist
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1141 @anchor{Definition of special-display-frame-alist}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1142 This variable holds frame parameters for
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1143 @code{special-display-popup-frame} to use when it creates a frame.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1144 @end defopt
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1145
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1146 @defopt same-window-buffer-names
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1147 A list of buffer names for buffers that should be displayed in the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1148 selected window. If the buffer's name is in this list,
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1149 @code{display-buffer} handles the buffer by switching to it in the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1150 selected window.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1151 @end defopt
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1152
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1153 @defopt same-window-regexps
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1154 A list of regular expressions that specify buffers that should be
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1155 displayed in the selected window. If the buffer's name matches any of
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1156 the regular expressions in this list, @code{display-buffer} handles the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1157 buffer by switching to it in the selected window.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1158 @end defopt
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1159
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1160 @defun same-window-p buffer-name
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1161 This function returns @code{t} if displaying a buffer
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1162 named @var{buffer-name} with @code{display-buffer} would
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1163 put it in the selected window.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1164 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1165
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1166 @c Emacs 19 feature
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1167 @defvar display-buffer-function
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1168 This variable is the most flexible way to customize the behavior of
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1169 @code{display-buffer}. If it is non-@code{nil}, it should be a function
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1170 that @code{display-buffer} calls to do the work. The function should
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1171 accept two arguments, the first two arguments that @code{display-buffer}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1172 received. It should choose or create a window, display the specified
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1173 buffer in it, and then return the window.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1174
99029
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1175 This variable takes precedence over all the other options described
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1176 above.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1177 @end defvar
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1178
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1179 If all options described above fail to produce a suitable window,
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1180 @code{display-buffer} tries to reuse an existing window. As a last
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1181 resort, it will try to display @var{buffer-or-name} on a separate frame.
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1182 In that case, the value of @code{pop-up-frames} is disregarded.
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1183
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1184 @node Dedicated Windows
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1185 @section Dedicated Windows
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1186 @cindex dedicated window
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1187
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1188 Functions for displaying a buffer can be told to not use specific
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1189 windows by marking these window as @dfn{dedicated} to their buffers.
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1190 @code{display-buffer} (@pxref{Choosing Window}) never uses a dedicated
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1191 window for displaying another buffer in it. @code{get-lru-window} and
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1192 @code{get-largest-window} (@pxref{Selecting Windows}) do not consider
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1193 dedicated windows as candidates when their @var{dedicated} argument is
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1194 non-@code{nil}. The behavior of @code{set-window-buffer}
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1195 (@pxref{Buffers and Windows}) with respect to dedicated windows is
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1196 slightly different, see below.
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1197
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1198 When @code{delete-windows-on} (@pxref{Deleting Windows}) wants to delete
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1199 a dedicated window and that window is the only window on its frame, it
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1200 deletes the window's frame too, provided there are other frames left.
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1201 @code{replace-buffer-in-windows} (@pxref{Displaying Buffers}) tries to
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1202 delete all dedicated windows showing its buffer argument. When such a
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1203 window is the only window on its frame, that frame is deleted, provided
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1204 there are other frames left. If there are no more frames left, some
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1205 other buffer is displayed in the window, and the window is marked as
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1206 non-dedicated.
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1207
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1208 When you kill a buffer (@pxref{Killing Buffers}) displayed in a
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1209 dedicated window, any such window usually gets deleted too, since
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1210 @code{kill-buffer} calls @code{replace-buffer-in-windows} for cleaning
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1211 up windows. Burying a buffer (@pxref{The Buffer List}) deletes the
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1212 selected window if it is dedicated and shows that buffer. However, if
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1213 that window is the only window on its frame, another buffer is displayed
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1214 in it and the frame is iconified.
98835
4c36d8b3b766 (Choosing Window, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 98827
diff changeset
1215
4c36d8b3b766 (Choosing Window, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 98827
diff changeset
1216 @defun window-dedicated-p &optional window
99029
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1217 This function returns non-@code{nil} if @var{window} is dedicated to its
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1218 buffer and @code{nil} otherwise. More precisely, the return value is
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1219 the value assigned by the last call of @code{set-window-dedicated-p} for
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1220 @var{window} or @code{nil} if that function was never called with
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
1221 @var{window} as its argument. The default for @var{window} is the
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
1222 selected window.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1223 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1224
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1225 @defun set-window-dedicated-p window flag
99029
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1226 This function marks @var{window} as dedicated to its buffer if
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
1227 @var{flag} is non-@code{nil}, and non-dedicated otherwise.
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1228
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1229 As a special case, if @var{flag} is @code{t}, @var{window} becomes
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1230 @dfn{strongly} dedicated to its buffer. @code{set-window-buffer}
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1231 signals an error when the window it acts upon is strongly dedicated to
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1232 its buffer and does not already display the buffer it is asked to
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1233 display. In any other case, @code{set-window-buffer} will display
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1234 another buffer in that window. Other functions do not treat @code{t}
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1235 differently from any non-@code{nil} value.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1236 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1237
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1238 @node Window Point
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1239 @section Windows and Point
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1240 @cindex window position
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1241 @cindex window point
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1242 @cindex position in window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1243 @cindex point in window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1244
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1245 Each window has its own value of point (@pxref{Point}), independent of
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1246 the value of point in other windows displaying the same buffer. This
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1247 makes it useful to have multiple windows showing one buffer.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1248
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1249 @itemize @bullet
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1250 @item
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1251 The window point is established when a window is first created; it is
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1252 initialized from the buffer's point, or from the window point of another
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1253 window opened on the buffer if such a window exists.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1254
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1255 @item
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1256 Selecting a window sets the value of point in its buffer from the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1257 window's value of point. Conversely, deselecting a window sets the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1258 window's value of point from that of the buffer. Thus, when you switch
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1259 between windows that display a given buffer, the point value for the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1260 selected window is in effect in the buffer, while the point values for
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1261 the other windows are stored in those windows.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1262
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1263 @item
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1264 As long as the selected window displays the current buffer, the window's
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1265 point and the buffer's point always move together; they remain equal.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1266 @end itemize
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1267
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1268 @cindex cursor
99760
690624ab76e0 (Displaying Buffers, Vertical Scrolling)
Martin Rudalics <rudalics@gmx.at>
parents: 99693
diff changeset
1269 As far as the user is concerned, point is where the cursor is, and
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1270 when the user switches to another buffer, the cursor jumps to the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1271 position of point in that buffer.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1272
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1273 @defun window-point &optional window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1274 This function returns the current position of point in @var{window}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1275 For a nonselected window, this is the value point would have (in that
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
1276 window's buffer) if that window were selected. The default for
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
1277 @var{window} is the selected window.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1278
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1279 When @var{window} is the selected window and its buffer is also the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1280 current buffer, the value returned is the same as point in that buffer.
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1281 Strictly speaking, it would be more correct to return the ``top-level''
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1282 value of point, outside of any @code{save-excursion} forms. But that
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1283 value is hard to find.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1284 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1285
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1286 @defun set-window-point window position
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1287 This function positions point in @var{window} at position
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1288 @var{position} in @var{window}'s buffer. It returns @var{position}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1289
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1290 If @var{window} is selected, and its buffer is current,
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1291 this simply does @code{goto-char}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1292 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1293
99441
910601b61dec (Displaying Buffers): For switch-to-buffer mention that
Martin Rudalics <rudalics@gmx.at>
parents: 99438
diff changeset
1294 @defvar window-point-insertion-type
910601b61dec (Displaying Buffers): For switch-to-buffer mention that
Martin Rudalics <rudalics@gmx.at>
parents: 99438
diff changeset
1295 This variable specifies the marker insertion type (@pxref{Marker
910601b61dec (Displaying Buffers): For switch-to-buffer mention that
Martin Rudalics <rudalics@gmx.at>
parents: 99438
diff changeset
1296 Insertion Types}) of @code{window-point}. The default is @code{nil},
910601b61dec (Displaying Buffers): For switch-to-buffer mention that
Martin Rudalics <rudalics@gmx.at>
parents: 99438
diff changeset
1297 so @code{window-point} will stay behind text inserted there.
910601b61dec (Displaying Buffers): For switch-to-buffer mention that
Martin Rudalics <rudalics@gmx.at>
parents: 99438
diff changeset
1298 @end defvar
910601b61dec (Displaying Buffers): For switch-to-buffer mention that
Martin Rudalics <rudalics@gmx.at>
parents: 99438
diff changeset
1299
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1300 @node Window Start and End
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1301 @section The Window Start and End Positions
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1302 @cindex window start position
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1303
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1304 Each window maintains a marker used to keep track of a buffer position
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1305 that specifies where in the buffer display should start. This position
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1306 is called the @dfn{display-start} position of the window (or just the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1307 @dfn{start}). The character after this position is the one that appears
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1308 at the upper left corner of the window. It is usually, but not
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1309 inevitably, at the beginning of a text line.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1310
92148
f991f10f15ec Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 87649
diff changeset
1311 After switching windows or buffers, and in some other cases, if the
f991f10f15ec Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 87649
diff changeset
1312 window start is in the middle of a line, Emacs adjusts the window
f991f10f15ec Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 87649
diff changeset
1313 start to the start of a line. This prevents certain operations from
f991f10f15ec Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 87649
diff changeset
1314 leaving the window start at a meaningless point within a line. This
f991f10f15ec Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 87649
diff changeset
1315 feature may interfere with testing some Lisp code by executing it
f991f10f15ec Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 87649
diff changeset
1316 using the commands of Lisp mode, because they trigger this
f991f10f15ec Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 87649
diff changeset
1317 readjustment. To test such code, put it into a command and bind the
f991f10f15ec Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 87649
diff changeset
1318 command to a key.
f991f10f15ec Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 87649
diff changeset
1319
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1320 @defun window-start &optional window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1321 @cindex window top line
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1322 This function returns the display-start position of window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1323 @var{window}. If @var{window} is @code{nil}, the selected window is
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1324 used. For example,
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1325
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1326 @example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1327 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1328 (window-start)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1329 @result{} 7058
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1330 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1331 @end example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1332
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1333 When you create a window, or display a different buffer in it, the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1334 display-start position is set to a display-start position recently used
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1335 for the same buffer, or to @code{point-min} if the buffer doesn't have
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1336 any.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1337
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1338 Redisplay updates the window-start position (if you have not specified
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1339 it explicitly since the previous redisplay)---to make sure point appears
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1340 on the screen. Nothing except redisplay automatically changes the
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1341 window-start position; if you move point, do not expect the window-start
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1342 position to change in response until after the next redisplay.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1343
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1344 For a realistic example of using @code{window-start}, see the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1345 description of @code{count-lines}. @xref{Definition of count-lines}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1346 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1347
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1348 @cindex window end position
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1349 @defun window-end &optional window update
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1350 This function returns the position where display of its buffer ends in
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
1351 @var{window}. The default for @var{window} is the selected window.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1352
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1353 Simply changing the buffer text or moving point does not update the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1354 value that @code{window-end} returns. The value is updated only when
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1355 Emacs redisplays and redisplay completes without being preempted.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1356
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1357 If the last redisplay of @var{window} was preempted, and did not finish,
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1358 Emacs does not know the position of the end of display in that window.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1359 In that case, this function returns @code{nil}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1360
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1361 If @var{update} is non-@code{nil}, @code{window-end} always returns an
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1362 up-to-date value for where display ends, based on the current
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1363 @code{window-start} value. If a previously saved value of that position
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1364 is still valid, @code{window-end} returns that value; otherwise it
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1365 computes the correct value by scanning the buffer text.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1366
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1367 Even if @var{update} is non-@code{nil}, @code{window-end} does not
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1368 attempt to scroll the display if point has moved off the screen, the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1369 way real redisplay would do. It does not alter the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1370 @code{window-start} value. In effect, it reports where the displayed
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1371 text will end if scrolling is not required.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1372 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1373
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1374 @defun set-window-start window position &optional noforce
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1375 This function sets the display-start position of @var{window} to
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1376 @var{position} in @var{window}'s buffer. It returns @var{position}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1377
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1378 The display routines insist that the position of point be visible when a
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1379 buffer is displayed. Normally, they change the display-start position
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1380 (that is, scroll the window) whenever necessary to make point visible.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1381 However, if you specify the start position with this function using
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1382 @code{nil} for @var{noforce}, it means you want display to start at
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1383 @var{position} even if that would put the location of point off the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1384 screen. If this does place point off screen, the display routines move
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1385 point to the left margin on the middle line in the window.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1386
92148
f991f10f15ec Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 87649
diff changeset
1387 For example, if point @w{is 1} and you set the start of the window
f991f10f15ec Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 87649
diff changeset
1388 @w{to 37}, the start of the next line, point will be ``above'' the top
f991f10f15ec Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 87649
diff changeset
1389 of the window. The display routines will automatically move point if
f991f10f15ec Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 87649
diff changeset
1390 it is still 1 when redisplay occurs. Here is an example:
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1391
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1392 @example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1393 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1394 ;; @r{Here is what @samp{foo} looks like before executing}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1395 ;; @r{the @code{set-window-start} expression.}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1396 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1397
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1398 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1399 ---------- Buffer: foo ----------
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1400 @point{}This is the contents of buffer foo.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1401 2
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1402 3
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1403 4
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1404 5
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1405 6
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1406 ---------- Buffer: foo ----------
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1407 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1408
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1409 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1410 (set-window-start
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1411 (selected-window)
92148
f991f10f15ec Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 87649
diff changeset
1412 (save-excursion
f991f10f15ec Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 87649
diff changeset
1413 (goto-char 1)
f991f10f15ec Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 87649
diff changeset
1414 (forward-line 1)
f991f10f15ec Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 87649
diff changeset
1415 (point)))
f991f10f15ec Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 87649
diff changeset
1416 @result{} 37
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1417 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1418
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1419 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1420 ;; @r{Here is what @samp{foo} looks like after executing}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1421 ;; @r{the @code{set-window-start} expression.}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1422 ---------- Buffer: foo ----------
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1423 2
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1424 3
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1425 @point{}4
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1426 5
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1427 6
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1428 ---------- Buffer: foo ----------
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1429 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1430 @end example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1431
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1432 If @var{noforce} is non-@code{nil}, and @var{position} would place point
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1433 off screen at the next redisplay, then redisplay computes a new window-start
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1434 position that works well with point, and thus @var{position} is not used.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1435 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1436
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1437 @defun pos-visible-in-window-p &optional position window partially
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1438 This function returns non-@code{nil} if @var{position} is within the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1439 range of text currently visible on the screen in @var{window}. It
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1440 returns @code{nil} if @var{position} is scrolled vertically out of view.
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1441 Locations that are partially obscured are not considered visible unless
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1442 @var{partially} is non-@code{nil}. The argument @var{position} defaults
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1443 to the current position of point in @var{window}; @var{window}, to the
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1444 selected window. If @var{position} is @code{t}, that means to check the
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1445 last visible position in @var{window}.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1446
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1447 The @code{pos-visible-in-window-p} function considers only vertical
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1448 scrolling. If @var{position} is out of view only because @var{window}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1449 has been scrolled horizontally, @code{pos-visible-in-window-p} returns
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1450 non-@code{nil} anyway. @xref{Horizontal Scrolling}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1451
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1452 If @var{position} is visible, @code{pos-visible-in-window-p} returns
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1453 @code{t} if @var{partially} is @code{nil}; if @var{partially} is
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1454 non-@code{nil}, and the character following @var{position} is fully
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1455 visible, it returns a list of the form @code{(@var{x} @var{y})}, where
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1456 @var{x} and @var{y} are the pixel coordinates relative to the top left
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1457 corner of the window; otherwise it returns an extended list of the form
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1458 @code{(@var{x} @var{y} @var{rtop} @var{rbot} @var{rowh} @var{vpos})},
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1459 where @var{rtop} and @var{rbot} specify the number of off-window pixels
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1460 at the top and bottom of the row at @var{position}, @var{rowh} specifies
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1461 the visible height of that row, and @var{vpos} specifies the vertical
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1462 position (zero-based row number) of that row.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1463
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1464 Here is an example:
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1465
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1466 @example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1467 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1468 ;; @r{If point is off the screen now, recenter it now.}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1469 (or (pos-visible-in-window-p
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1470 (point) (selected-window))
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1471 (recenter 0))
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1472 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1473 @end example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1474 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1475
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1476 @defun window-line-height &optional line window
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
1477 This function returns the height of text line @var{line} in
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
1478 @var{window}. If @var{line} is one of @code{header-line} or
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
1479 @code{mode-line}, @code{window-line-height} returns information about
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
1480 the corresponding line of the window. Otherwise, @var{line} is a text
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
1481 line number starting from 0. A negative number counts from the end of
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
1482 the window. The default for @var{line} is the current line in
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
1483 @var{window}; the default for @var{window} is the selected window.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1484
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1485 If the display is not up to date, @code{window-line-height} returns
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1486 @code{nil}. In that case, @code{pos-visible-in-window-p} may be used
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1487 to obtain related information.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1488
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1489 If there is no line corresponding to the specified @var{line},
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1490 @code{window-line-height} returns @code{nil}. Otherwise, it returns
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1491 a list @code{(@var{height} @var{vpos} @var{ypos} @var{offbot})},
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1492 where @var{height} is the height in pixels of the visible part of the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1493 line, @var{vpos} and @var{ypos} are the vertical position in lines and
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1494 pixels of the line relative to the top of the first text line, and
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1495 @var{offbot} is the number of off-window pixels at the bottom of the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1496 text line. If there are off-window pixels at the top of the (first)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1497 text line, @var{ypos} is negative.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1498 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1499
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1500 @node Textual Scrolling
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1501 @section Textual Scrolling
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1502 @cindex textual scrolling
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1503 @cindex scrolling textually
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1504
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1505 @dfn{Textual scrolling} means moving the text up or down through a
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1506 window. It works by changing the value of the window's display-start
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1507 location. It may also change the value of @code{window-point} to keep
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1508 point on the screen.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1509
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1510 Textual scrolling was formerly called ``vertical scrolling,'' but we
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1511 changed its name to distinguish it from the new vertical fractional
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1512 scrolling feature (@pxref{Vertical Scrolling}).
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1513
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1514 In the commands @code{scroll-up} and @code{scroll-down}, the directions
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1515 ``up'' and ``down'' refer to the motion of the text in the buffer at which
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1516 you are looking through the window. Imagine that the text is
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1517 written on a long roll of paper and that the scrolling commands move the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1518 paper up and down. Thus, if you are looking at text in the middle of a
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1519 buffer and repeatedly call @code{scroll-down}, you will eventually see
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1520 the beginning of the buffer.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1521
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1522 Some people have urged that the opposite convention be used: they
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1523 imagine that the window moves over text that remains in place. Then
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1524 ``down'' commands would take you to the end of the buffer. This view is
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1525 more consistent with the actual relationship between windows and the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1526 text in the buffer, but it is less like what the user sees. The
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1527 position of a window on the terminal does not move, and short scrolling
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1528 commands clearly move the text up or down on the screen. We have chosen
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1529 names that fit the user's point of view.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1530
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1531 The textual scrolling functions (aside from
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1532 @code{scroll-other-window}) have unpredictable results if the current
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1533 buffer is different from the buffer that is displayed in the selected
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1534 window. @xref{Current Buffer}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1535
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1536 If the window contains a row which is taller than the height of the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1537 window (for example in the presence of a large image), the scroll
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1538 functions will adjust the window vscroll to scroll the partially
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1539 visible row. To disable this feature, Lisp code may bind the variable
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1540 `auto-window-vscroll' to @code{nil} (@pxref{Vertical Scrolling}).
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1541
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1542 @deffn Command scroll-up &optional count
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1543 This function scrolls the text in the selected window upward
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1544 @var{count} lines. If @var{count} is negative, scrolling is actually
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1545 downward.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1546
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1547 If @var{count} is @code{nil} (or omitted), then the length of scroll
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1548 is @code{next-screen-context-lines} lines less than the usable height of
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1549 the window (not counting its mode line).
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1550
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1551 @code{scroll-up} returns @code{nil}, unless it gets an error
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1552 because it can't scroll any further.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1553 @end deffn
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1554
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1555 @deffn Command scroll-down &optional count
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1556 This function scrolls the text in the selected window downward
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1557 @var{count} lines. If @var{count} is negative, scrolling is actually
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1558 upward.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1559
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1560 If @var{count} is omitted or @code{nil}, then the length of the scroll
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1561 is @code{next-screen-context-lines} lines less than the usable height of
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1562 the window (not counting its mode line).
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1563
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1564 @code{scroll-down} returns @code{nil}, unless it gets an error because
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1565 it can't scroll any further.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1566 @end deffn
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1567
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1568 @deffn Command scroll-other-window &optional count
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1569 This function scrolls the text in another window upward @var{count}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1570 lines. Negative values of @var{count}, or @code{nil}, are handled
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1571 as in @code{scroll-up}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1572
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1573 You can specify which buffer to scroll by setting the variable
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1574 @code{other-window-scroll-buffer} to a buffer. If that buffer isn't
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1575 already displayed, @code{scroll-other-window} displays it in some
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1576 window.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1577
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1578 When the selected window is the minibuffer, the next window is normally
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1579 the one at the top left corner. You can specify a different window to
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1580 scroll, when the minibuffer is selected, by setting the variable
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1581 @code{minibuffer-scroll-window}. This variable has no effect when any
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1582 other window is selected. When it is non-@code{nil} and the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1583 minibuffer is selected, it takes precedence over
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1584 @code{other-window-scroll-buffer}. @xref{Definition of
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1585 minibuffer-scroll-window}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1586
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1587 When the minibuffer is active, it is the next window if the selected
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1588 window is the one at the bottom right corner. In this case,
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1589 @code{scroll-other-window} attempts to scroll the minibuffer. If the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1590 minibuffer contains just one line, it has nowhere to scroll to, so the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1591 line reappears after the echo area momentarily displays the message
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1592 @samp{Beginning of buffer}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1593 @end deffn
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1594
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1595 @c Emacs 19 feature
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1596 @defvar other-window-scroll-buffer
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1597 If this variable is non-@code{nil}, it tells @code{scroll-other-window}
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1598 which buffer's window to scroll.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1599 @end defvar
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1600
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1601 @defopt scroll-margin
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1602 This option specifies the size of the scroll margin---a minimum number
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1603 of lines between point and the top or bottom of a window. Whenever
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1604 point gets within this many lines of the top or bottom of the window,
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1605 redisplay scrolls the text automatically (if possible) to move point
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1606 out of the margin, closer to the center of the window.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1607 @end defopt
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1608
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1609 @defopt scroll-conservatively
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1610 This variable controls how scrolling is done automatically when point
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1611 moves off the screen (or into the scroll margin). If the value is a
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1612 positive integer @var{n}, then redisplay scrolls the text up to
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1613 @var{n} lines in either direction, if that will bring point back into
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1614 proper view. This behavior is called @dfn{conservative scrolling}.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1615 Otherwise, scrolling happens in the usual way, under the control of
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1616 other variables such as @code{scroll-up-aggressively} and
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1617 @code{scroll-down-aggressively}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1618
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1619 The default value is zero, which means that conservative scrolling
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1620 never happens.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1621 @end defopt
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1622
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1623 @defopt scroll-down-aggressively
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1624 The value of this variable should be either @code{nil} or a fraction
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1625 @var{f} between 0 and 1. If it is a fraction, that specifies where on
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1626 the screen to put point when scrolling down. More precisely, when a
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1627 window scrolls down because point is above the window start, the new
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1628 start position is chosen to put point @var{f} part of the window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1629 height from the top. The larger @var{f}, the more aggressive the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1630 scrolling.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1631
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1632 A value of @code{nil} is equivalent to .5, since its effect is to center
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1633 point. This variable automatically becomes buffer-local when set in any
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1634 fashion.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1635 @end defopt
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1636
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1637 @defopt scroll-up-aggressively
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1638 Likewise, for scrolling up. The value, @var{f}, specifies how far
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1639 point should be placed from the bottom of the window; thus, as with
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1640 @code{scroll-up-aggressively}, a larger value scrolls more aggressively.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1641 @end defopt
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1642
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1643 @defopt scroll-step
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1644 This variable is an older variant of @code{scroll-conservatively}. The
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1645 difference is that it if its value is @var{n}, that permits scrolling
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1646 only by precisely @var{n} lines, not a smaller number. This feature
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1647 does not work with @code{scroll-margin}. The default value is zero.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1648 @end defopt
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1649
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1650 @defopt scroll-preserve-screen-position
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1651 If this option is @code{t}, scrolling which would move the current
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1652 point position out of the window chooses the new position of point
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1653 so that the vertical position of the cursor is unchanged, if possible.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1654
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1655 If it is non-@code{nil} and not @code{t}, then the scrolling functions
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1656 always preserve the vertical position of point, if possible.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1657 @end defopt
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1658
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1659 @defopt next-screen-context-lines
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1660 The value of this variable is the number of lines of continuity to
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1661 retain when scrolling by full screens. For example, @code{scroll-up}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1662 with an argument of @code{nil} scrolls so that this many lines at the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1663 bottom of the window appear instead at the top. The default value is
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1664 @code{2}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1665 @end defopt
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1666
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1667 @deffn Command recenter &optional count
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1668 @cindex centering point
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1669 This function scrolls the text in the selected window so that point is
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1670 displayed at a specified vertical position within the window. It does
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1671 not ``move point'' with respect to the text.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1672
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1673 If @var{count} is a nonnegative number, that puts the line containing
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1674 point @var{count} lines down from the top of the window. If
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1675 @var{count} is a negative number, then it counts upward from the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1676 bottom of the window, so that @minus{}1 stands for the last usable
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1677 line in the window. If @var{count} is a non-@code{nil} list, then it
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1678 stands for the line in the middle of the window.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1679
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1680 If @var{count} is @code{nil}, @code{recenter} puts the line containing
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1681 point in the middle of the window, then clears and redisplays the entire
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1682 selected frame.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1683
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1684 When @code{recenter} is called interactively, @var{count} is the raw
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1685 prefix argument. Thus, typing @kbd{C-u} as the prefix sets the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1686 @var{count} to a non-@code{nil} list, while typing @kbd{C-u 4} sets
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1687 @var{count} to 4, which positions the current line four lines from the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1688 top.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1689
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1690 With an argument of zero, @code{recenter} positions the current line at
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1691 the top of the window. This action is so handy that some people make a
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1692 separate key binding to do this. For example,
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1693
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1694 @example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1695 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1696 (defun line-to-top-of-window ()
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1697 "Scroll current line to top of window.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1698 Replaces three keystroke sequence C-u 0 C-l."
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1699 (interactive)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1700 (recenter 0))
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1701
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1702 (global-set-key [kp-multiply] 'line-to-top-of-window)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1703 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1704 @end example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1705 @end deffn
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1706
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1707 @node Vertical Scrolling
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1708 @section Vertical Fractional Scrolling
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1709 @cindex vertical fractional scrolling
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1710 @cindex vertical scroll position
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1711
99760
690624ab76e0 (Displaying Buffers, Vertical Scrolling)
Martin Rudalics <rudalics@gmx.at>
parents: 99693
diff changeset
1712 @dfn{Vertical fractional scrolling} means shifting text in a window
690624ab76e0 (Displaying Buffers, Vertical Scrolling)
Martin Rudalics <rudalics@gmx.at>
parents: 99693
diff changeset
1713 up or down by a specified multiple or fraction of a line. Each window
690624ab76e0 (Displaying Buffers, Vertical Scrolling)
Martin Rudalics <rudalics@gmx.at>
parents: 99693
diff changeset
1714 has a @dfn{vertical scroll position}, which is a number, never less than
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1715 zero. It specifies how far to raise the contents of the window.
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1716 Raising the window contents generally makes all or part of some lines
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1717 disappear off the top, and all or part of some other lines appear at the
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1718 bottom. The usual value is zero.
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1719
99760
690624ab76e0 (Displaying Buffers, Vertical Scrolling)
Martin Rudalics <rudalics@gmx.at>
parents: 99693
diff changeset
1720 The vertical scroll position is measured in units of the normal line
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1721 height, which is the height of the default font. Thus, if the value is
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1722 .5, that means the window contents are scrolled up half the normal line
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1723 height. If it is 3.3, that means the window contents are scrolled up
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1724 somewhat over three times the normal line height.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1725
99760
690624ab76e0 (Displaying Buffers, Vertical Scrolling)
Martin Rudalics <rudalics@gmx.at>
parents: 99693
diff changeset
1726 What fraction of a line the vertical scrolling covers, or how many
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1727 lines, depends on what the lines contain. A value of .5 could scroll a
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1728 line whose height is very short off the screen, while a value of 3.3
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1729 could scroll just part of the way through a tall line or an image.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1730
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1731 @defun window-vscroll &optional window pixels-p
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1732 This function returns the current vertical scroll position of
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
1733 @var{window}. The default for @var{window} is the selected window.
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
1734 If @var{pixels-p} is non-@code{nil}, the return value is measured in
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1735 pixels, rather than in units of the normal line height.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1736
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1737 @example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1738 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1739 (window-vscroll)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1740 @result{} 0
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1741 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1742 @end example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1743 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1744
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1745 @defun set-window-vscroll window lines &optional pixels-p
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1746 This function sets @var{window}'s vertical scroll position to
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1747 @var{lines}. If @var{window} is @code{nil}, the selected window is
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1748 used. The argument @var{lines} should be zero or positive; if not, it
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1749 is taken as zero.
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1750
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1751
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1752 The actual vertical scroll position must always correspond
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1753 to an integral number of pixels, so the value you specify
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1754 is rounded accordingly.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1755
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1756 The return value is the result of this rounding.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1757
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1758 @example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1759 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1760 (set-window-vscroll (selected-window) 1.2)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1761 @result{} 1.13
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1762 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1763 @end example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1764
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1765 If @var{pixels-p} is non-@code{nil}, @var{lines} specifies a number of
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1766 pixels. In this case, the return value is @var{lines}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1767 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1768
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1769 @defvar auto-window-vscroll
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1770 If this variable is non-@code{nil}, the line-move, scroll-up, and
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1771 scroll-down functions will automatically modify the vertical scroll
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1772 position to scroll through display rows that are taller that the height
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1773 of the window, for example in the presence of large images.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1774 @end defvar
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1775
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1776 @node Horizontal Scrolling
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1777 @section Horizontal Scrolling
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1778 @cindex horizontal scrolling
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1779
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1780 @dfn{Horizontal scrolling} means shifting the image in the window left
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1781 or right by a specified multiple of the normal character width. Each
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1782 window has a @dfn{horizontal scroll position}, which is a number, never
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1783 less than zero. It specifies how far to shift the contents left.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1784 Shifting the window contents left generally makes all or part of some
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1785 characters disappear off the left, and all or part of some other
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1786 characters appear at the right. The usual value is zero.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1787
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1788 The horizontal scroll position is measured in units of the normal
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1789 character width, which is the width of space in the default font. Thus,
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1790 if the value is 5, that means the window contents are scrolled left by 5
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1791 times the normal character width. How many characters actually
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1792 disappear off to the left depends on their width, and could vary from
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1793 line to line.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1794
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1795 Because we read from side to side in the ``inner loop,'' and from top
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1796 to bottom in the ``outer loop,'' the effect of horizontal scrolling is
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1797 not like that of textual or vertical scrolling. Textual scrolling
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1798 involves selection of a portion of text to display, and vertical
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1799 scrolling moves the window contents contiguously; but horizontal
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1800 scrolling causes part of @emph{each line} to go off screen.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1801
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1802 Usually, no horizontal scrolling is in effect; then the leftmost
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1803 column is at the left edge of the window. In this state, scrolling to
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1804 the right is meaningless, since there is no data to the left of the edge
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1805 to be revealed by it; so this is not allowed. Scrolling to the left is
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1806 allowed; it scrolls the first columns of text off the edge of the window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1807 and can reveal additional columns on the right that were truncated
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1808 before. Once a window has a nonzero amount of leftward horizontal
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1809 scrolling, you can scroll it back to the right, but only so far as to
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1810 reduce the net horizontal scroll to zero. There is no limit to how far
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1811 left you can scroll, but eventually all the text will disappear off the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1812 left edge.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1813
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1814 @vindex auto-hscroll-mode
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1815 If @code{auto-hscroll-mode} is set, redisplay automatically alters
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1816 the horizontal scrolling of a window as necessary to ensure that point
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1817 is always visible. However, you can still set the horizontal
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1818 scrolling value explicitly. The value you specify serves as a lower
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1819 bound for automatic scrolling, i.e. automatic scrolling will not
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1820 scroll a window to a column less than the specified one.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1821
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1822 @deffn Command scroll-left &optional count set-minimum
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1823 This function scrolls the selected window @var{count} columns to the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1824 left (or to the right if @var{count} is negative). The default
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1825 for @var{count} is the window width, minus 2.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1826
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1827 The return value is the total amount of leftward horizontal scrolling in
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1828 effect after the change---just like the value returned by
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1829 @code{window-hscroll} (below).
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1830
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1831 Once you scroll a window as far right as it can go, back to its normal
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1832 position where the total leftward scrolling is zero, attempts to scroll
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1833 any farther right have no effect.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1834
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1835 If @var{set-minimum} is non-@code{nil}, the new scroll amount becomes
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1836 the lower bound for automatic scrolling; that is, automatic scrolling
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1837 will not scroll a window to a column less than the value returned by
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1838 this function. Interactive calls pass non-@code{nil} for
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1839 @var{set-minimum}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1840 @end deffn
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1841
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1842 @deffn Command scroll-right &optional count set-minimum
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1843 This function scrolls the selected window @var{count} columns to the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1844 right (or to the left if @var{count} is negative). The default
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1845 for @var{count} is the window width, minus 2. Aside from the direction
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1846 of scrolling, this works just like @code{scroll-left}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1847 @end deffn
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1848
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1849 @defun window-hscroll &optional window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1850 This function returns the total leftward horizontal scrolling of
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1851 @var{window}---the number of columns by which the text in @var{window}
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
1852 is scrolled left past the left margin. The default for
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
1853 @var{window} is the selected window.
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1854
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1855 The return value is never negative. It is zero when no horizontal
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1856 scrolling has been done in @var{window} (which is usually the case).
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1857
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1858
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1859 @example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1860 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1861 (window-hscroll)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1862 @result{} 0
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1863 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1864 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1865 (scroll-left 5)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1866 @result{} 5
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1867 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1868 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1869 (window-hscroll)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1870 @result{} 5
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1871 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1872 @end example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1873 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1874
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1875 @defun set-window-hscroll window columns
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1876 This function sets horizontal scrolling of @var{window}. The value of
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1877 @var{columns} specifies the amount of scrolling, in terms of columns
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1878 from the left margin. The argument @var{columns} should be zero or
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1879 positive; if not, it is taken as zero. Fractional values of
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1880 @var{columns} are not supported at present.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1881
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1882 Note that @code{set-window-hscroll} may appear not to work if you test
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1883 it by evaluating a call with @kbd{M-:} in a simple way. What happens
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1884 is that the function sets the horizontal scroll value and returns, but
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1885 then redisplay adjusts the horizontal scrolling to make point visible,
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1886 and this overrides what the function did. You can observe the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1887 function's effect if you call it while point is sufficiently far from
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1888 the left margin that it will remain visible.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1889
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1890 The value returned is @var{columns}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1891
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1892 @example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1893 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1894 (set-window-hscroll (selected-window) 10)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1895 @result{} 10
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1896 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1897 @end example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1898 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1899
99760
690624ab76e0 (Displaying Buffers, Vertical Scrolling)
Martin Rudalics <rudalics@gmx.at>
parents: 99693
diff changeset
1900 Here is how you can determine whether a given position @var{position}
690624ab76e0 (Displaying Buffers, Vertical Scrolling)
Martin Rudalics <rudalics@gmx.at>
parents: 99693
diff changeset
1901 is off the screen due to horizontal scrolling:
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1902
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1903 @example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1904 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1905 (defun hscroll-on-screen (window position)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1906 (save-excursion
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1907 (goto-char position)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1908 (and
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1909 (>= (- (current-column) (window-hscroll window)) 0)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1910 (< (- (current-column) (window-hscroll window))
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1911 (window-width window)))))
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1912 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1913 @end example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1914
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1915 @node Size of Window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1916 @section The Size of a Window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1917 @cindex window size
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1918 @cindex size of window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1919
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1920 An Emacs window is rectangular, and its size information consists of
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1921 the height (the number of lines) and the width (the number of character
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1922 positions in each line). The mode line is included in the height. But
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1923 the width does not count the scroll bar or the column of @samp{|}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1924 characters that separates side-by-side windows.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1925
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1926 The following three functions return size information about a window:
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1927
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1928 @defun window-height &optional window
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1929 This function returns the number of lines in @var{window}, including its
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1930 mode line and header line, if any. If @var{window} fills its entire
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1931 frame except for the echo area, this is typically one less than the
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
1932 value of @code{frame-height} on that frame. The default for
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
1933 @var{window} is the selected window.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1934
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1935 @example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1936 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1937 (window-height)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1938 @result{} 23
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1939 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1940 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1941 (split-window-vertically)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1942 @result{} #<window 4 on windows.texi>
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1943 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1944 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1945 (window-height)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1946 @result{} 11
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1947 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1948 @end example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1949 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1950
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1951 @defun window-body-height &optional window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1952 Like @code{window-height} but the value does not include the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1953 mode line (if any) or the header line (if any).
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1954 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1955
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1956 @defun window-width &optional window
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
1957 This function returns the number of columns in @var{window}. The
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
1958 default for @var{window} is the selected window.
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1959
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1960 The return value does not include the window's scroll bar or the column
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1961 of @samp{|} characters that separates side-by-side windows. Moreover,
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1962 the return value does not include the space used for displaying fringes
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1963 and margins. Hence you cannot, in general, compare the return values of
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1964 @code{window-width} and @code{frame-width} for equality to determine
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1965 whether a window is a wide as the containing frame. Use the function
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1966 @code{window-full-width-p}, see below, instead.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1967
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1968 @example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1969 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1970 (window-width)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1971 @result{} 80
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1972 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1973 @end example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1974 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1975
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1976 @defun window-full-width-p &optional window
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
1977 This function returns non-@code{nil} if @var{window} is as wide as the
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
1978 frame that contains it; otherwise @code{nil}. The default for
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
1979 @var{window} is the selected window.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1980 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1981
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1982 @defun window-edges &optional window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1983 This function returns a list of the edge coordinates of @var{window}.
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
1984 The default for @var{window} is the selected window.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1985
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1986 The order of the list is @code{(@var{left} @var{top} @var{right}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1987 @var{bottom})}, all elements relative to 0, 0 at the top left corner of
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1988 the frame. The element @var{right} of the value is one more than the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1989 rightmost column used by @var{window}, and @var{bottom} is one more than
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1990 the bottommost row used by @var{window} and its mode-line.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1991
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1992 The edges include the space used by the window's scroll bar, display
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1993 margins, fringes, header line, and mode line, if it has them. Also,
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1994 if the window has a neighbor on the right, its right edge value
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1995 includes the width of the separator line between the window and that
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1996 neighbor. Since the width of the window does not include this
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1997 separator, the width does not usually equal the difference between the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1998 right and left edges.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1999 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2000
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2001 @defun window-inside-edges &optional window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2002 This is similar to @code{window-edges}, but the edge values
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2003 it returns include only the text area of the window. They
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2004 do not include the header line, mode line, scroll bar or
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2005 vertical separator, fringes, or display margins.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2006 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2007
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2008 Here are the results obtained on a typical 24-line terminal with just
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2009 one window, with menu bar enabled:
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2010
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2011 @example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2012 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2013 (window-edges (selected-window))
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2014 @result{} (0 1 80 23)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2015 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2016 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2017 (window-inside-edges (selected-window))
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2018 @result{} (0 1 80 22)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2019 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2020 @end example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2021
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2022 @noindent
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2023 The bottom edge is at line 23 because the last line is the echo area.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2024 The bottom inside edge is at line 22, which is the window's mode line.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2025
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2026 If @var{window} is at the upper left corner of its frame, and there is
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2027 no menu bar, then @var{bottom} returned by @code{window-edges} is the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2028 same as the value of @code{(window-height)}, @var{right} is almost the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2029 same as the value of @code{(window-width)}, and @var{top} and
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2030 @var{left} are zero. For example, the edges of the following window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2031 are @w{@samp{0 0 8 5}}. Assuming that the frame has more than 8
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2032 columns, the last column of the window (column 7) holds a border
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2033 rather than text. The last row (row 4) holds the mode line, shown
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2034 here with @samp{xxxxxxxxx}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2035
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2036 @example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2037 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2038 0
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2039 _______
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2040 0 | |
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2041 | |
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2042 | |
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2043 | |
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2044 xxxxxxxxx 4
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2045
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2046 7
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2047 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2048 @end example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2049
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2050 In the following example, let's suppose that the frame is 7
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2051 columns wide. Then the edges of the left window are @w{@samp{0 0 4 3}}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2052 and the edges of the right window are @w{@samp{4 0 7 3}}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2053 The inside edges of the left window are @w{@samp{0 0 3 2}},
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2054 and the inside edges of the right window are @w{@samp{4 0 7 2}},
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2055
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2056 @example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2057 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2058 ___ ___
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2059 | | |
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2060 | | |
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2061 xxxxxxxxx
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2062
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2063 0 34 7
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2064 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2065 @end example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2066
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2067 @defun window-pixel-edges &optional window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2068 This function is like @code{window-edges} except that, on a graphical
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2069 display, the edge values are measured in pixels instead of in
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2070 character lines and columns.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2071 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2072
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2073 @defun window-inside-pixel-edges &optional window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2074 This function is like @code{window-inside-edges} except that, on a
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2075 graphical display, the edge values are measured in pixels instead of
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2076 in character lines and columns.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2077 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2078
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2079 @node Resizing Windows
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2080 @section Changing the Size of a Window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2081 @cindex window resizing
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2082 @cindex resize window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2083 @cindex changing window size
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2084 @cindex window size, changing
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2085
99760
690624ab76e0 (Displaying Buffers, Vertical Scrolling)
Martin Rudalics <rudalics@gmx.at>
parents: 99693
diff changeset
2086 The window size functions fall into two classes: high-level commands
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2087 that change the size of windows and low-level functions that access
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2088 window size. Emacs does not permit overlapping windows or gaps between
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2089 windows, so resizing a window always affects at least one other window.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2090
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2091 @deffn Command enlarge-window size &optional horizontal
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2092 This function makes the selected window @var{size} lines taller by
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2093 stealing lines from windows above or below. In a first round, it takes
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2094 lines from one window at a time until that window is
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2095 @code{window-min-height} lines tall, then takes from another. If, at
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2096 the end of the first round, the selected window is still not tall
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2097 enough, @code{enlarge-window} starts a second round, where it deletes
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2098 windows above or below the selected one.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2099
98894
1e370d7d742a (Resizing Windows): Remove var{} around window in
Martin Rudalics <rudalics@gmx.at>
parents: 98843
diff changeset
2100 If @var{horizontal} is non-@code{nil}, this function makes the window
1e370d7d742a (Resizing Windows): Remove var{} around window in
Martin Rudalics <rudalics@gmx.at>
parents: 98843
diff changeset
2101 @var{size} columns wider, stealing columns instead of lines. If a
1e370d7d742a (Resizing Windows): Remove var{} around window in
Martin Rudalics <rudalics@gmx.at>
parents: 98843
diff changeset
2102 window from which columns are stolen shrinks below
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2103 @code{window-min-width} columns, that window disappears.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2104
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2105 If the requested size would exceed that of the window's frame, then the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2106 function makes the window occupy the entire height (or width) of the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2107 frame.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2108
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2109 If there are various other windows from which lines or columns can be
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2110 stolen, and some of them specify fixed size (using
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2111 @code{window-size-fixed}, see below), they are left untouched while
99465
3bf4c25d3b4b (Basic Windows, Splitting Windows)
Eli Zaretskii <eliz@gnu.org>
parents: 99441
diff changeset
2112 other windows are ``robbed.'' If it would be necessary to alter the
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2113 size of a fixed-size window, @code{enlarge-window} gets an error
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2114 instead.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2115
98960
3240f5341524 (Resizing Windows): Minor wording fix.
Martin Rudalics <rudalics@gmx.at>
parents: 98944
diff changeset
2116 If @var{size} is negative, this function shrinks the selected window by
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2117 @minus{}@var{size} lines or columns. If that makes the window smaller
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2118 than the minimum size (@code{window-min-height} and
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2119 @code{window-min-width}), then @code{enlarge-window} deletes the window.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2120
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2121 @code{enlarge-window} returns @code{nil}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2122 @end deffn
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2123
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2124 @deffn Command enlarge-window-horizontally columns
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2125 This function makes the selected window @var{columns} wider.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2126 It could be defined as follows:
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2127
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2128 @example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2129 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2130 (defun enlarge-window-horizontally (columns)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2131 (interactive "p")
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2132 (enlarge-window columns t))
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2133 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2134 @end example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2135 @end deffn
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2136
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2137 @deffn Command shrink-window size &optional horizontal
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2138 This function is like @code{enlarge-window} but negates the argument
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2139 @var{size}, making the selected window smaller by giving lines (or
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2140 columns) to the other windows. If the window shrinks below
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2141 @code{window-min-height} or @code{window-min-width}, then it disappears.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2142
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2143 If @var{size} is negative, the window is enlarged by @minus{}@var{size}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2144 lines or columns.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2145 @end deffn
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2146
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2147 @deffn Command shrink-window-horizontally columns
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2148 This function makes the selected window @var{columns} narrower.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2149 It could be defined as follows:
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2150
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2151 @example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2152 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2153 (defun shrink-window-horizontally (columns)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2154 (interactive "p")
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2155 (shrink-window columns t))
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2156 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2157 @end example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2158 @end deffn
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2159
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2160 @defun adjust-window-trailing-edge window delta horizontal
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2161 This function makes the selected window @var{delta} lines taller or
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2162 @var{delta} columns wider, by moving the bottom or right edge. This
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2163 function does not delete other windows; if it cannot make the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2164 requested size adjustment, it signals an error. On success, this
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2165 function returns @code{nil}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2166 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2167
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2168 @defun fit-window-to-buffer &optional window max-height min-height
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2169 This function makes @var{window} the right height to display its
100555
66984afb4693 (Windows): Rewrite description of
Martin Rudalics <rudalics@gmx.at>
parents: 99911
diff changeset
2170 contents exactly. The default for @var{window} is the selected window.
66984afb4693 (Windows): Rewrite description of
Martin Rudalics <rudalics@gmx.at>
parents: 99911
diff changeset
2171
66984afb4693 (Windows): Rewrite description of
Martin Rudalics <rudalics@gmx.at>
parents: 99911
diff changeset
2172 The optional argument @var{max-height} specifies the maximum height the
66984afb4693 (Windows): Rewrite description of
Martin Rudalics <rudalics@gmx.at>
parents: 99911
diff changeset
2173 window is allowed to be; @code{nil} means use the maximum permissible
66984afb4693 (Windows): Rewrite description of
Martin Rudalics <rudalics@gmx.at>
parents: 99911
diff changeset
2174 height of a window on @var{window}'s frame. The optional argument
66984afb4693 (Windows): Rewrite description of
Martin Rudalics <rudalics@gmx.at>
parents: 99911
diff changeset
2175 @var{min-height} specifies the minimum height for the window; @code{nil}
66984afb4693 (Windows): Rewrite description of
Martin Rudalics <rudalics@gmx.at>
parents: 99911
diff changeset
2176 means use @code{window-min-height}. All these height values include the
66984afb4693 (Windows): Rewrite description of
Martin Rudalics <rudalics@gmx.at>
parents: 99911
diff changeset
2177 mode line and/or header line.
66984afb4693 (Windows): Rewrite description of
Martin Rudalics <rudalics@gmx.at>
parents: 99911
diff changeset
2178
66984afb4693 (Windows): Rewrite description of
Martin Rudalics <rudalics@gmx.at>
parents: 99911
diff changeset
2179 This function can delete windows when their height shrinks below
66984afb4693 (Windows): Rewrite description of
Martin Rudalics <rudalics@gmx.at>
parents: 99911
diff changeset
2180 @var{min-height}. It returns non-@code{nil} if it orderly resized
66984afb4693 (Windows): Rewrite description of
Martin Rudalics <rudalics@gmx.at>
parents: 99911
diff changeset
2181 @var{window}, and @code{nil} otherwise.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2182 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2183
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2184 @deffn Command shrink-window-if-larger-than-buffer &optional window
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2185 This command shrinks @var{window} vertically to be as small as possible
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2186 while still showing the full contents of its buffer---but not less than
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
2187 @code{window-min-height} lines. The default for @var{window} is
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
2188 the selected window.
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2189
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2190 However, this command does nothing if the window is already too small to
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2191 display the whole text of the buffer, or if part of the contents are
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2192 currently scrolled off screen, or if the window is not the full width of
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2193 its frame, or if the window is the only window in its frame.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2194
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2195 This command returns non-@code{nil} if it actually shrank the window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2196 and @code{nil} otherwise.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2197 @end deffn
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2198
99029
da79c29252c4 (Displaying Buffers): Reword documentation of pop-to-buffer.
Martin Rudalics <rudalics@gmx.at>
parents: 98960
diff changeset
2199 @cindex fixed-size window
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2200 @defvar window-size-fixed
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2201 If this variable is non-@code{nil}, in a given buffer, then the size of
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2202 any window displaying that buffer remains fixed unless you either
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2203 explicitly change it or Emacs has no other choice.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2204
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2205 If the value is @code{height}, then only the window's height is fixed;
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2206 if the value is @code{width}, then only the window's width is fixed.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2207 Any other non-@code{nil} value fixes both the width and the height.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2208
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2209 This variable automatically becomes buffer-local when set.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2210
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2211 Explicit size-change functions such as @code{enlarge-window}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2212 get an error if they would have to change a window size which is fixed.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2213 Therefore, when you want to change the size of such a window,
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2214 you should bind @code{window-size-fixed} to @code{nil}, like this:
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2215
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2216 @example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2217 (let ((window-size-fixed nil))
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2218 (enlarge-window 10))
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2219 @end example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2220
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2221 Deleting an adjacent window or changing the frame size may change the
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2222 size of a fixed-size window, if there is no other alternative.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2223 @end defvar
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2224
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2225 @cindex minimum window size
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2226 The following two variables constrain the window-structure-changing
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2227 functions to a minimum height and width.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2228
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2229 @defopt window-min-height
98944
e3bf6a4e1aa6 More wording fixes from RMS.
Eli Zaretskii <eliz@gnu.org>
parents: 98928
diff changeset
2230 The value of this variable specifies how short a window may become
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2231 before it is automatically deleted. Making a window smaller than
98894
1e370d7d742a (Resizing Windows): Remove var{} around window in
Martin Rudalics <rudalics@gmx.at>
parents: 98843
diff changeset
2232 @code{window-min-height} automatically deletes it, and no window may be
1e370d7d742a (Resizing Windows): Remove var{} around window in
Martin Rudalics <rudalics@gmx.at>
parents: 98843
diff changeset
2233 created shorter than this. The value is measured in line units. When
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2234 the window wants a mode line and/or a header line, they are counted as
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
2235 one line each. The default value is @code{4}. A value less than
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
2236 @code{1} is ignored.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2237 @end defopt
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2238
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2239 @defopt window-min-width
98944
e3bf6a4e1aa6 More wording fixes from RMS.
Eli Zaretskii <eliz@gnu.org>
parents: 98928
diff changeset
2240 The value of this variable specifies how narrow a window may become
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2241 before it is automatically deleted. Making a window smaller than
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2242 @code{window-min-width} automatically deletes it, and no window may be
98894
1e370d7d742a (Resizing Windows): Remove var{} around window in
Martin Rudalics <rudalics@gmx.at>
parents: 98843
diff changeset
2243 created narrower than this. The value is measured in characters and
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2244 includes any fringes or the scroll bar. The default value is @code{10}.
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2245 A value less than @code{2} is ignored.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2246 @end defopt
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2247
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2248 @cindex balancing window sizes
99465
3bf4c25d3b4b (Basic Windows, Splitting Windows)
Eli Zaretskii <eliz@gnu.org>
parents: 99441
diff changeset
2249 Emacs provides two functions to balance windows, that is, to even out
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2250 the sizes of windows on the same frame. The minibuffer window and
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2251 fixed-size windows are not resized by these functions.
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2252
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2253 @deffn Command balance-windows &optional window-or-frame
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2254 This function balances windows in a way that gives more space to
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2255 full-width and/or full-height windows. If @var{window-or-frame}
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2256 specifies a frame, it balances all windows on that frame. If
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2257 @var{window-or-frame} specifies a window, it balances this window and
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2258 its ``siblings'' only. Think of a sibling as the other (original or
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2259 new) window with respect to the present one, involved in the process of
99474
ecad25300f20 Fix usage of `see @ref'.
Eli Zaretskii <eliz@gnu.org>
parents: 99465
diff changeset
2260 splitting; see @ref{Splitting Windows}. Since a sibling may have been
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2261 split again, a window can have more than one sibling.
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2262 @end deffn
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2263
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2264 @deffn Command balance-windows-area
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2265 This function attempts to give all windows on the selected frame
99465
3bf4c25d3b4b (Basic Windows, Splitting Windows)
Eli Zaretskii <eliz@gnu.org>
parents: 99441
diff changeset
2266 approximately the same share of the screen area. This means that
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2267 full-width or full-height windows are not given more space than other
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2268 windows.
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2269 @end deffn
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2270
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2271 @node Coordinates and Windows
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2272 @section Coordinates and Windows
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2273
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2274 This section describes how to relate screen coordinates to windows.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2275
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2276 @defun window-at x y &optional frame
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2277 This function returns the window containing the specified cursor
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2278 position in the frame @var{frame}. The coordinates @var{x} and @var{y}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2279 are measured in characters and count from the top left corner of the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2280 frame. If they are out of range, @code{window-at} returns @code{nil}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2281
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2282 If you omit @var{frame}, the selected frame is used.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2283 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2284
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2285 @defun coordinates-in-window-p coordinates window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2286 This function checks whether a particular frame position falls within
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2287 the window @var{window}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2288
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2289 The argument @var{coordinates} is a cons cell of the form @code{(@var{x}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2290 . @var{y})}. The coordinates @var{x} and @var{y} are measured in
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2291 characters, and count from the top left corner of the screen or frame.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2292
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2293 The value returned by @code{coordinates-in-window-p} is non-@code{nil}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2294 if the coordinates are inside @var{window}. The value also indicates
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2295 what part of the window the position is in, as follows:
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2296
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2297 @table @code
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2298 @item (@var{relx} . @var{rely})
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2299 The coordinates are inside @var{window}. The numbers @var{relx} and
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2300 @var{rely} are the equivalent window-relative coordinates for the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2301 specified position, counting from 0 at the top left corner of the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2302 window.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2303
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2304 @item mode-line
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2305 The coordinates are in the mode line of @var{window}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2306
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2307 @item header-line
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2308 The coordinates are in the header line of @var{window}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2309
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2310 @item vertical-line
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2311 The coordinates are in the vertical line between @var{window} and its
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2312 neighbor to the right. This value occurs only if the window doesn't
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2313 have a scroll bar; positions in a scroll bar are considered outside the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2314 window for these purposes.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2315
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2316 @item left-fringe
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2317 @itemx right-fringe
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2318 The coordinates are in the left or right fringe of the window.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2319
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2320 @item left-margin
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2321 @itemx right-margin
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2322 The coordinates are in the left or right margin of the window.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2323
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2324 @item nil
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2325 The coordinates are not in any part of @var{window}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2326 @end table
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2327
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2328 The function @code{coordinates-in-window-p} does not require a frame as
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2329 argument because it always uses the frame that @var{window} is on.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2330 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2331
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2332 @node Window Tree
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2333 @section The Window Tree
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2334 @cindex window tree
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2335
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2336 A @dfn{window tree} specifies the layout, size, and relationship
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2337 between all windows in one frame.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2338
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2339 @defun window-tree &optional frame
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2340 This function returns the window tree for frame @var{frame}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2341 If @var{frame} is omitted, the selected frame is used.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2342
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2343 The return value is a list of the form @code{(@var{root} @var{mini})},
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2344 where @var{root} represents the window tree of the frame's
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2345 root window, and @var{mini} is the frame's minibuffer window.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2346
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2347 If the root window is not split, @var{root} is the root window itself.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2348 Otherwise, @var{root} is a list @code{(@var{dir} @var{edges} @var{w1}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2349 @var{w2} ...)} where @var{dir} is @code{nil} for a horizontal split,
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2350 and @code{t} for a vertical split, @var{edges} gives the combined size and
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2351 position of the subwindows in the split, and the rest of the elements
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2352 are the subwindows in the split. Each of the subwindows may again be
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2353 a window or a list representing a window split, and so on. The
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2354 @var{edges} element is a list @code{(@var{left}@var{ top}@var{ right}@var{ bottom})}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2355 similar to the value returned by @code{window-edges}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2356 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2357
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2358 @node Window Configurations
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2359 @section Window Configurations
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2360 @cindex window configurations
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2361 @cindex saving window information
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2362
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2363 A @dfn{window configuration} records the entire layout of one
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2364 frame---all windows, their sizes, which buffers they contain, how those
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2365 buffers are scrolled, and their values of point and the mark; also their
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2366 fringes, margins, and scroll bar settings. It also includes the value
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2367 of @code{minibuffer-scroll-window}. As a special exception, the window
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2368 configuration does not record the value of point in the selected window
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2369 for the current buffer. Also, the window configuration does not record
99474
ecad25300f20 Fix usage of `see @ref'.
Eli Zaretskii <eliz@gnu.org>
parents: 99465
diff changeset
2370 the values of window parameters; see @ref{Window Parameters}.
99465
3bf4c25d3b4b (Basic Windows, Splitting Windows)
Eli Zaretskii <eliz@gnu.org>
parents: 99441
diff changeset
2371
3bf4c25d3b4b (Basic Windows, Splitting Windows)
Eli Zaretskii <eliz@gnu.org>
parents: 99441
diff changeset
2372 You can bring back an entire frame layout by restoring a previously
3bf4c25d3b4b (Basic Windows, Splitting Windows)
Eli Zaretskii <eliz@gnu.org>
parents: 99441
diff changeset
2373 saved window configuration. If you want to record the layout of all
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2374 frames instead of just one, use a frame configuration instead of a
99474
ecad25300f20 Fix usage of `see @ref'.
Eli Zaretskii <eliz@gnu.org>
parents: 99465
diff changeset
2375 window configuration; see @ref{Frame Configurations}.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2376
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2377 @defun current-window-configuration &optional frame
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2378 This function returns a new object representing @var{frame}'s current
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
2379 window configuration. The default for @var{frame} is the selected
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
2380 frame.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2381 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2382
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2383 @defun set-window-configuration configuration
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2384 This function restores the configuration of windows and buffers as
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2385 specified by @var{configuration}, for the frame that @var{configuration}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2386 was created for.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2387
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2388 The argument @var{configuration} must be a value that was previously
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2389 returned by @code{current-window-configuration}. The configuration is
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2390 restored in the frame from which @var{configuration} was made, whether
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2391 that frame is selected or not. This always counts as a window size
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2392 change and triggers execution of the @code{window-size-change-functions}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2393 (@pxref{Window Hooks}), because @code{set-window-configuration} doesn't
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2394 know how to tell whether the new configuration actually differs from the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2395 old one.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2396
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2397 If the frame which @var{configuration} was saved from is dead, all this
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2398 function does is restore the three variables @code{window-min-height},
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2399 @code{window-min-width} and @code{minibuffer-scroll-window}. In this
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2400 case, the function returns @code{nil}. Otherwise, it returns @code{t}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2401
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2402 Here is a way of using this function to get the same effect
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2403 as @code{save-window-excursion}:
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2404
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2405 @example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2406 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2407 (let ((config (current-window-configuration)))
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2408 (unwind-protect
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2409 (progn (split-window-vertically nil)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2410 @dots{})
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2411 (set-window-configuration config)))
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2412 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2413 @end example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2414 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2415
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2416 @defspec save-window-excursion forms@dots{}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2417 This special form records the window configuration, executes @var{forms}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2418 in sequence, then restores the earlier window configuration. The window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2419 configuration includes, for each window, the value of point and the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2420 portion of the buffer that is visible. It also includes the choice of
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2421 selected window. However, it does not include the value of point in
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2422 the current buffer; use @code{save-excursion} also, if you wish to
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2423 preserve that.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2424
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2425 Don't use this construct when @code{save-selected-window} is sufficient.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2426
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2427 Exit from @code{save-window-excursion} always triggers execution of
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2428 @code{window-size-change-functions}. (It doesn't know how to tell
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2429 whether the restored configuration actually differs from the one in
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2430 effect at the end of the @var{forms}.)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2431
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2432 The return value is the value of the final form in @var{forms}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2433 For example:
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2434
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2435 @example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2436 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2437 (split-window)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2438 @result{} #<window 25 on control.texi>
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2439 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2440 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2441 (setq w (selected-window))
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2442 @result{} #<window 19 on control.texi>
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2443 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2444 @group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2445 (save-window-excursion
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2446 (delete-other-windows w)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2447 (switch-to-buffer "foo")
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2448 'do-something)
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2449 @result{} do-something
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2450 ;; @r{The screen is now split again.}
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2451 @end group
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2452 @end example
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2453 @end defspec
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2454
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2455 @defun window-configuration-p object
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2456 This function returns @code{t} if @var{object} is a window configuration.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2457 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2458
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2459 @defun compare-window-configurations config1 config2
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2460 This function compares two window configurations as regards the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2461 structure of windows, but ignores the values of point and mark and the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2462 saved scrolling positions---it can return @code{t} even if those
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2463 aspects differ.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2464
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2465 The function @code{equal} can also compare two window configurations; it
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2466 regards configurations as unequal if they differ in any respect, even a
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2467 saved point or mark.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2468 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2469
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2470 @defun window-configuration-frame config
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2471 This function returns the frame for which the window configuration
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2472 @var{config} was made.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2473 @end defun
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2474
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2475 Other primitives to look inside of window configurations would make
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2476 sense, but are not implemented because we did not need them. See the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2477 file @file{winner.el} for some more operations on windows
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2478 configurations.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2479
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2480 @node Window Parameters
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2481 @section Window Parameters
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2482 @cindex window parameters
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2483
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2484 This sections describes how window parameters can be used to associate
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2485 additional information with windows.
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2486
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2487 @defun window-parameter window parameter
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
2488 This function returns @var{window}'s value for @var{parameter}. The
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
2489 default for @var{window} is the selected window. If @var{window}
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
2490 has no setting for @var{parameter}, this function returns @code{nil}.
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2491 @end defun
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2492
99465
3bf4c25d3b4b (Basic Windows, Splitting Windows)
Eli Zaretskii <eliz@gnu.org>
parents: 99441
diff changeset
2493 @defun window-parameters &optional window
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2494 This function returns all parameters of @var{window} and their values.
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
2495 The default for @var{window} is the selected window. The return value
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
2496 is an association list of elements of the form @code{(@var{parameter}
99465
3bf4c25d3b4b (Basic Windows, Splitting Windows)
Eli Zaretskii <eliz@gnu.org>
parents: 99441
diff changeset
2497 . @var{value})}.
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2498 @end defun
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2499
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2500 @defun set-window-parameter window parameter value
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2501 This function sets @var{window}'s value of @var{parameter} to
99613
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
2502 @var{value} and returns @var{value}. The default for @var{window}
785924da433d (Splitting Windows, Deleting Windows)
Martin Rudalics <rudalics@gmx.at>
parents: 99474
diff changeset
2503 is the selected window.
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2504 @end defun
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2505
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2506 Currently, window parameters are not saved in window configurations and
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2507 consequently not restored by @code{set-window-configuration}. Hence,
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2508 any change of a parameter introduced via @code{set-window-parameter} can
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2509 be undone only by invoking @code{set-window-parameter} for the same
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2510 parameter again. Since @code{save-window-excursion} relies on window
99465
3bf4c25d3b4b (Basic Windows, Splitting Windows)
Eli Zaretskii <eliz@gnu.org>
parents: 99441
diff changeset
2511 configurations (@pxref{Window Configurations}), window parameters are
3bf4c25d3b4b (Basic Windows, Splitting Windows)
Eli Zaretskii <eliz@gnu.org>
parents: 99441
diff changeset
2512 not saved and restored by that special form, either.
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2513
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2514 @node Window Hooks
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2515 @section Hooks for Window Scrolling and Changes
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2516 @cindex hooks for window operations
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2517
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2518 This section describes how a Lisp program can take action whenever a
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2519 window displays a different part of its buffer or a different buffer.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2520 There are three actions that can change this: scrolling the window,
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2521 switching buffers in the window, and changing the size of the window.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2522 The first two actions run @code{window-scroll-functions}; the last runs
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2523 @code{window-size-change-functions}.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2524
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2525 @defvar window-scroll-functions
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2526 This variable holds a list of functions that Emacs should call before
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2527 redisplaying a window with scrolling. Displaying a different buffer in
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2528 the window also runs these functions.
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2529
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2530 This variable is not a normal hook, because each function is called with
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2531 two arguments: the window, and its new display-start position.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2532
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2533 These functions must be careful in using @code{window-end}
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2534 (@pxref{Window Start and End}); if you need an up-to-date value, you
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2535 must use the @var{update} argument to ensure you get it.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2536
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2537 @strong{Warning:} don't use this feature to alter the way the window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2538 is scrolled. It's not designed for that, and such use probably won't
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2539 work.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2540 @end defvar
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2541
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2542 @defvar window-size-change-functions
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2543 This variable holds a list of functions to be called if the size of any
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2544 window changes for any reason. The functions are called just once per
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2545 redisplay, and just once for each frame on which size changes have
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2546 occurred.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2547
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2548 Each function receives the frame as its sole argument. There is no
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2549 direct way to find out which windows on that frame have changed size, or
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2550 precisely how. However, if a size-change function records, at each
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2551 call, the existing windows and their sizes, it can also compare the
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2552 present sizes and the previous sizes.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2553
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2554 Creating or deleting windows counts as a size change, and therefore
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2555 causes these functions to be called. Changing the frame size also
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2556 counts, because it changes the sizes of the existing windows.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2557
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2558 It is not a good idea to use @code{save-window-excursion} (@pxref{Window
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2559 Configurations}) in these functions, because that always counts as a
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2560 size change, and it would cause these functions to be called over and
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2561 over. In most cases, @code{save-selected-window} (@pxref{Selecting
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2562 Windows}) is what you need here.
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2563 @end defvar
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2564
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2565 @defvar window-configuration-change-hook
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2566 A normal hook that is run every time you change the window configuration
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2567 of an existing frame. This includes splitting or deleting windows,
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2568 changing the sizes of windows, or displaying a different buffer in a
99438
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2569 window.
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2570
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2571 The buffer-local part of this hook is run once per each window on the
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2572 affected frame, with the relevant window selected and its buffer
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2573 current. The global part is run once for the modified frame, with that
5743d4e279a5 (Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents: 99128
diff changeset
2574 frame selected.
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2575 @end defvar
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2576
99693
3c7c38bba785 (Window Hooks): Remove *-end-trigger-functions vars, which are
Chong Yidong <cyd@stupidchicken.com>
parents: 99613
diff changeset
2577 In addition, you can use @code{jit-lock-register} to register a Font
3c7c38bba785 (Window Hooks): Remove *-end-trigger-functions vars, which are
Chong Yidong <cyd@stupidchicken.com>
parents: 99613
diff changeset
2578 Lock fontification function, which will be called whenever part of the
3c7c38bba785 (Window Hooks): Remove *-end-trigger-functions vars, which are
Chong Yidong <cyd@stupidchicken.com>
parents: 99613
diff changeset
2579 buffer needs to be refontified (usually because it has been changed).
3c7c38bba785 (Window Hooks): Remove *-end-trigger-functions vars, which are
Chong Yidong <cyd@stupidchicken.com>
parents: 99613
diff changeset
2580 @xref{Other Font Lock Variables}.
3c7c38bba785 (Window Hooks): Remove *-end-trigger-functions vars, which are
Chong Yidong <cyd@stupidchicken.com>
parents: 99613
diff changeset
2581
84112
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2582 @ignore
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2583 arch-tag: 3f6c36e8-df49-4986-b757-417feed88be3
7087f74a4f1d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2584 @end ignore