Mercurial > emacs
annotate doc/lispref/windows.texi @ 102802:4f534a4fed53
Regenerate.
author | Chong Yidong <cyd@stupidchicken.com> |
---|---|
date | Tue, 31 Mar 2009 00:19:56 +0000 |
parents | cb5d2387102c |
children | a9330f5194ee |
rev | line source |
---|---|
84112 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2001, | |
100974 | 4 @c 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc. |
84112 | 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 | 7 @node Windows, Frames, Buffers, Top |
8 @chapter Windows | |
9 | |
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 | 14 |
15 @menu | |
16 * Basic Windows:: Basic information on using windows. | |
17 * Splitting Windows:: Splitting one window into two windows. | |
18 * Deleting Windows:: Deleting a window gives its space to other windows. | |
19 * Selecting Windows:: The selected window is the one that you edit in. | |
20 * Cyclic Window Ordering:: Moving around the existing windows. | |
21 * Buffers and Windows:: Each window displays the contents of a buffer. | |
22 * Displaying Buffers:: Higher-level functions for displaying a buffer | |
23 and choosing a window for it. | |
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 | 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 | 30 * Textual Scrolling:: Moving text up and down through the window. |
31 * Vertical Scrolling:: Moving the contents up and down on the window. | |
32 * Horizontal Scrolling:: Moving the contents sideways on the window. | |
33 * Size of Window:: Accessing the size of a window. | |
34 * Resizing Windows:: Changing the size of a window. | |
35 * Coordinates and Windows:: Converting coordinates to windows. | |
36 * Window Tree:: The layout and sizes of all windows in a frame. | |
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 | 39 * Window Hooks:: Hooks for scrolling, window size changes, |
40 redisplay going past a certain point, | |
41 or window configuration changes. | |
42 @end menu | |
43 | |
44 @node Basic Windows | |
45 @section Basic Concepts of Emacs Windows | |
46 @cindex window | |
47 @cindex selected window | |
48 | |
49 A @dfn{window} in Emacs is the physical area of the screen in which a | |
50 buffer is displayed. The term is also used to refer to a Lisp object that | |
51 represents that screen area in Emacs Lisp. It should be | |
52 clear from the context which is meant. | |
53 | |
99474 | 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 | 59 |
60 In each frame, at any time, one and only one window is designated as | |
61 @dfn{selected within the frame}. The frame's cursor appears in that | |
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 | 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 | 67 been used); see @ref{Current Buffer}. |
84112 | 68 |
69 For practical purposes, a window exists only while it is displayed in | |
70 a frame. Once removed from the frame, the window is effectively deleted | |
71 and should not be used, @emph{even though there may still be references | |
99474 | 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 | 74 screen to come back to life; see @ref{Window Configurations}. |
84112 | 75 |
76 @cindex multiple windows | |
77 Users create multiple windows so they can look at several buffers at | |
78 once. Lisp libraries use multiple windows for a variety of reasons, but | |
79 most often to display related information. In Rmail, for example, you | |
80 can move through a summary buffer in one window while the other window | |
81 shows messages one at a time as they are reached. | |
82 | |
83 The meaning of ``window'' in Emacs is similar to what it means in the | |
84 context of general-purpose window systems such as X, but not identical. | |
85 The X Window System places X windows on the screen; Emacs uses one or | |
86 more X windows as frames, and subdivides them into | |
87 Emacs windows. When you use Emacs on a character-only terminal, Emacs | |
88 treats the whole terminal screen as one frame. | |
89 | |
90 @cindex terminal screen | |
91 @cindex screen of terminal | |
92 @cindex tiled windows | |
93 Most window systems support arbitrarily located overlapping windows. | |
94 In contrast, Emacs windows are @dfn{tiled}; they never overlap, and | |
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 | 99 |
100 @defun windowp object | |
101 This function returns @code{t} if @var{object} is a window. | |
102 @end defun | |
103 | |
104 @node Splitting Windows | |
105 @section Splitting Windows | |
106 @cindex splitting windows | |
107 @cindex window splitting | |
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 | 112 previously visible in the window that was split. |
113 | |
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 | 127 |
128 If @var{size} is omitted or @code{nil}, then @var{window} is divided | |
129 evenly into two parts. (If there is an odd line, it is allocated to | |
130 the new window.) When @code{split-window} is called interactively, | |
131 all its arguments are @code{nil}. | |
132 | |
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 | 137 |
138 The following example starts with one window on a screen that is 50 | |
139 lines high by 80 columns wide; then it splits the window. | |
140 | |
141 @smallexample | |
142 @group | |
143 (setq w (selected-window)) | |
144 @result{} #<window 8 on windows.texi> | |
145 (window-edges) ; @r{Edges in order:} | |
146 @result{} (0 0 80 50) ; @r{left--top--right--bottom} | |
147 @end group | |
148 | |
149 @group | |
150 ;; @r{Returns window created} | |
151 (setq w2 (split-window w 15)) | |
152 @result{} #<window 28 on windows.texi> | |
153 @end group | |
154 @group | |
155 (window-edges w2) | |
156 @result{} (0 15 80 50) ; @r{Bottom window;} | |
157 ; @r{top is line 15} | |
158 @end group | |
159 @group | |
160 (window-edges w) | |
161 @result{} (0 0 80 15) ; @r{Top window} | |
162 @end group | |
163 @end smallexample | |
164 | |
165 The screen looks like this: | |
166 | |
167 @smallexample | |
168 @group | |
169 __________ | |
170 | | line 0 | |
171 | w | | |
172 |__________| | |
173 | | line 15 | |
174 | w2 | | |
175 |__________| | |
176 line 50 | |
177 column 0 column 80 | |
178 @end group | |
179 @end smallexample | |
180 | |
181 Next, split the top window horizontally: | |
182 | |
183 @smallexample | |
184 @group | |
185 (setq w3 (split-window w 35 t)) | |
186 @result{} #<window 32 on windows.texi> | |
187 @end group | |
188 @group | |
189 (window-edges w3) | |
190 @result{} (35 0 80 15) ; @r{Left edge at column 35} | |
191 @end group | |
192 @group | |
193 (window-edges w) | |
194 @result{} (0 0 35 15) ; @r{Right edge at column 35} | |
195 @end group | |
196 @group | |
197 (window-edges w2) | |
198 @result{} (0 15 80 50) ; @r{Bottom window unchanged} | |
199 @end group | |
200 @end smallexample | |
201 | |
202 @need 3000 | |
203 Now the screen looks like this: | |
204 | |
205 @smallexample | |
206 @group | |
207 column 35 | |
208 __________ | |
209 | | | line 0 | |
210 | w | w3 | | |
211 |___|______| | |
212 | | line 15 | |
213 | w2 | | |
214 |__________| | |
215 line 50 | |
216 column 0 column 80 | |
217 @end group | |
218 @end smallexample | |
219 | |
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 | 224 @end deffn |
225 | |
226 @deffn Command split-window-vertically &optional size | |
227 This function splits the selected window into two windows, one above the | |
228 other, leaving the upper of the two windows selected, with @var{size} | |
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 | 231 the upper window is still the one selected.) However, if |
232 @code{split-window-keep-point} (see below) is @code{nil}, then either | |
233 window can be selected. | |
234 | |
235 In other respects, this function is similar to @code{split-window}. | |
236 In particular, the upper window is the original one and the return | |
237 value is the new, lower window. | |
238 @end deffn | |
239 | |
240 @defopt split-window-keep-point | |
241 If this variable is non-@code{nil} (the default), then | |
242 @code{split-window-vertically} behaves as described above. | |
243 | |
244 If it is @code{nil}, then @code{split-window-vertically} adjusts point | |
245 in each of the two windows to avoid scrolling. (This is useful on | |
246 slow terminals.) It selects whichever window contains the screen line | |
247 that point was previously on. | |
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 | 251 @end defopt |
252 | |
253 @deffn Command split-window-horizontally &optional size | |
254 This function splits the selected window into two windows | |
255 side-by-side, leaving the selected window on the left with @var{size} | |
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 | 258 selected. |
259 | |
260 This function is basically an interface to @code{split-window}. | |
261 You could define a simplified version of the function like this: | |
262 | |
263 @smallexample | |
264 @group | |
265 (defun split-window-horizontally (&optional arg) | |
266 "Split selected window into two windows, side by side..." | |
267 (interactive "P") | |
268 @end group | |
269 @group | |
270 (let ((size (and arg (prefix-numeric-value arg)))) | |
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 | 273 (split-window nil size t))) |
274 @end group | |
275 @end smallexample | |
276 @end deffn | |
277 | |
278 @defun one-window-p &optional no-mini all-frames | |
279 This function returns non-@code{nil} if there is only one window. The | |
280 argument @var{no-mini}, if non-@code{nil}, means don't count the | |
281 minibuffer even if it is active; otherwise, the minibuffer window is | |
282 counted when it is active. | |
283 | |
284 The argument @var{all-frames} specifies which frames to consider. Here | |
285 are the possible values and their meanings: | |
286 | |
287 @table @asis | |
288 @item @code{nil} | |
289 Count the windows in the selected frame, plus the minibuffer used | |
290 by that frame even if it lies in some other frame. | |
291 | |
292 @item @code{t} | |
293 Count all windows in all existing frames. | |
294 | |
295 @item @code{visible} | |
296 Count all windows in all visible frames. | |
297 | |
298 @item 0 | |
299 Count all windows in all visible or iconified frames. | |
300 | |
301 @item anything else | |
302 Count precisely the windows in the selected frame, and no others. | |
303 @end table | |
304 @end defun | |
305 | |
306 @node Deleting Windows | |
307 @section Deleting Windows | |
308 @cindex deleting windows | |
309 | |
310 A window remains visible on its frame unless you @dfn{delete} it by | |
311 calling certain functions that delete windows. A deleted window cannot | |
312 appear on the screen, but continues to exist as a Lisp object until | |
313 there are no references to it. There is no way to cancel the deletion | |
314 of a window aside from restoring a saved window configuration | |
315 (@pxref{Window Configurations}). Restoring a window configuration also | |
316 deletes any windows that aren't part of that configuration. | |
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 | 320 |
321 @c Emacs 19 feature | |
322 @defun window-live-p window | |
323 This function returns @code{nil} if @var{window} is deleted, and | |
324 @code{t} otherwise. | |
325 | |
326 @strong{Warning:} Erroneous information or fatal errors may result from | |
327 using a deleted window as if it were live. | |
328 @end defun | |
329 | |
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 | 334 @end deffn |
335 | |
336 @deffn Command delete-other-windows &optional window | |
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 | 340 @end deffn |
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 | 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 | 347 |
348 @code{delete-windows-on} operates frame by frame. If a frame has | |
349 several windows showing different buffers, then those showing | |
350 @var{buffer-or-name} are removed, and the others expand to fill the | |
351 space. If all windows in some frame are showing @var{buffer-or-name} | |
352 (including the case where there is only one window), then the frame | |
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 | 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 | 364 |
365 @itemize @bullet | |
366 @item | |
367 If it is @code{nil}, operate on all frames. | |
368 @item | |
369 If it is @code{t}, operate on the selected frame. | |
370 @item | |
371 If it is @code{visible}, operate on all visible frames. | |
372 @item | |
373 If it is 0, operate on all visible or iconified frames. | |
374 @item | |
375 If it is a frame, operate on that frame. | |
376 @end itemize | |
377 | |
378 This function always returns @code{nil}. | |
379 @end deffn | |
380 | |
381 @node Selecting Windows | |
382 @section Selecting Windows | |
383 @cindex selecting a window | |
384 | |
385 When a window is selected, the buffer in the window becomes the current | |
386 buffer, and the cursor will appear in it. | |
387 | |
388 @defun selected-window | |
389 This function returns the selected window. This is the window in | |
390 which the cursor appears and to which many commands apply. | |
391 @end defun | |
392 | |
393 @defun select-window window &optional norecord | |
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 | 405 |
406 @example | |
407 @group | |
408 (setq w (next-window)) | |
409 (select-window w) | |
410 @result{} #<window 65 on windows.texi> | |
411 @end group | |
412 @end example | |
413 @end defun | |
414 | |
415 @defmac save-selected-window forms@dots{} | |
416 This macro records the selected frame, as well as the selected window | |
417 of each frame, executes @var{forms} in sequence, then restores the | |
418 earlier selected frame and windows. It also saves and restores the | |
419 current buffer. It returns the value of the last form in @var{forms}. | |
420 | |
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 | 432 @end defmac |
433 | |
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 | 441 @end defmac |
442 | |
443 @cindex finding windows | |
444 The following functions choose one of the windows on the screen, | |
445 offering various criteria for the choice. | |
446 | |
447 @defun get-lru-window &optional frame dedicated | |
448 This function returns the window least recently ``used'' (that is, | |
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 | 451 |
452 The selected window can be the least recently used window if it is the | |
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 | 460 |
461 @itemize @bullet | |
462 @item | |
463 If it is @code{nil}, consider windows on the selected frame. | |
464 @item | |
465 If it is @code{t}, consider windows on all frames. | |
466 @item | |
467 If it is @code{visible}, consider windows on all visible frames. | |
468 @item | |
469 If it is 0, consider windows on all visible or iconified frames. | |
470 @item | |
471 If it is a frame, consider windows on that frame. | |
472 @end itemize | |
473 @end defun | |
474 | |
475 @defun get-largest-window &optional frame dedicated | |
476 This function returns the window with the largest area (height times | |
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 | 481 |
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 | 488 @end defun |
489 | |
490 @cindex window that satisfies a predicate | |
491 @cindex conditional selection of windows | |
492 @defun get-window-with-predicate predicate &optional minibuf all-frames default | |
493 This function returns a window satisfying @var{predicate}. It cycles | |
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 | 499 |
500 The optional arguments @var{minibuf} and @var{all-frames} specify the | |
501 set of windows to include in the scan. See the description of | |
502 @code{next-window} in @ref{Cyclic Window Ordering}, for details. | |
503 @end defun | |
504 | |
505 @node Cyclic Window Ordering | |
506 @comment node-name, next, previous, up | |
507 @section Cyclic Ordering of Windows | |
508 @cindex cyclic ordering of windows | |
509 @cindex ordering of windows, cyclic | |
510 @cindex window ordering, cyclic | |
511 | |
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 | 516 |
517 This ordering generally goes from top to bottom, and from left to | |
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 | 520 |
521 If the first split was vertical (into windows one above each other), | |
522 and then the subwindows were split horizontally, then the ordering is | |
523 left to right in the top of the frame, and then left to right in the | |
524 next lower part of the frame, and so on. If the first split was | |
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 | 530 @cindex minibuffer window, and @code{next-window} |
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 | 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 | 550 |
551 @table @asis | |
552 @item @code{nil} | |
553 Consider all the windows in @var{window}'s frame, plus the minibuffer | |
554 used by that frame even if it lies in some other frame. If the | |
555 minibuffer counts (as determined by @var{minibuf}), then all windows on | |
556 all frames that share that minibuffer count too. | |
557 | |
558 @item @code{t} | |
559 Consider all windows in all existing frames. | |
560 | |
561 @item @code{visible} | |
562 Consider all windows in all visible frames. (To get useful results, you | |
563 must ensure @var{window} is in a visible frame.) | |
564 | |
565 @item 0 | |
566 Consider all windows in all visible or iconified frames. | |
567 | |
568 @item a frame | |
569 Consider all windows on that frame. | |
570 | |
571 @item anything else | |
572 Consider precisely the windows in @var{window}'s frame, and no others. | |
573 @end table | |
574 | |
575 This example assumes there are two windows, both displaying the | |
576 buffer @samp{windows.texi}: | |
577 | |
578 @example | |
579 @group | |
580 (selected-window) | |
581 @result{} #<window 56 on windows.texi> | |
582 @end group | |
583 @group | |
584 (next-window (selected-window)) | |
585 @result{} #<window 52 on windows.texi> | |
586 @end group | |
587 @group | |
588 (next-window (next-window (selected-window))) | |
589 @result{} #<window 56 on windows.texi> | |
590 @end group | |
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 | 595 This function returns the window preceding @var{window} in the cyclic |
596 ordering of windows. The other arguments specify which windows to | |
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 | 599 |
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 | 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 | 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 | 613 @end deffn |
614 | |
615 @c Emacs 19 feature | |
616 @defun walk-windows proc &optional minibuf all-frames | |
617 This function cycles through all windows. It calls the function | |
618 @code{proc} once for each window, with the window as its sole | |
619 argument. | |
620 | |
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 | 623 for details. |
624 @end defun | |
625 | |
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 | 632 included in the result list. If @var{minibuf} is @code{t}, the result |
633 always includes the minibuffer window. If @var{minibuf} is @code{nil} | |
634 or omitted, that includes the minibuffer window if it is active. If | |
635 @var{minibuf} is neither @code{nil} nor @code{t}, the result never | |
636 includes the minibuffer window. | |
637 @end defun | |
638 | |
639 @node Buffers and Windows | |
640 @section Buffers and Windows | |
641 @cindex examining windows | |
642 @cindex windows, controlling precisely | |
643 @cindex buffers, controlled in windows | |
644 | |
645 This section describes low-level functions to examine windows or to | |
646 display buffers in windows in a precisely controlled fashion. | |
647 @iftex | |
648 See the following section for | |
649 @end iftex | |
650 @ifnottex | |
651 @xref{Displaying Buffers}, for | |
652 @end ifnottex | |
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 | 657 |
658 @defun set-window-buffer window buffer-or-name &optional keep-margins | |
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 | 667 |
668 @example | |
669 @group | |
670 (set-window-buffer (selected-window) "foo") | |
671 @result{} nil | |
672 @end group | |
673 @end example | |
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 | 687 @end defun |
688 | |
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 | 691 displayed in a window. It is incremented each time |
692 @code{set-window-buffer} is called for the buffer. | |
693 @end defvar | |
694 | |
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 | 698 |
699 @example | |
700 @group | |
701 (window-buffer) | |
702 @result{} #<buffer windows.texi> | |
703 @end group | |
704 @end example | |
705 @end defun | |
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 | 708 This function returns a window currently displaying |
709 @var{buffer-or-name}, or @code{nil} if there is none. If there are | |
710 several such windows, then the function returns the first one in the | |
711 cyclic ordering of windows, starting from the selected window. | |
712 @xref{Cyclic Window Ordering}. | |
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 | 717 |
718 @itemize @bullet | |
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 | 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 | 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 | 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 | 736 @end defun |
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 | 746 @end defun |
747 | |
748 @defvar buffer-display-time | |
749 This variable records the time at which a buffer was last made visible | |
750 in a window. It is always local in each buffer; each time | |
751 @code{set-window-buffer} is called, it sets this variable to | |
752 @code{(current-time)} in the specified buffer (@pxref{Time of Day}). | |
753 When a buffer is first created, @code{buffer-display-time} starts out | |
754 with the value @code{nil}. | |
755 @end defvar | |
756 | |
757 @node Displaying Buffers | |
758 @section Displaying Buffers in Windows | |
759 @cindex switching to a buffer | |
760 @cindex displaying a buffer | |
761 | |
762 In this section we describe convenient functions that choose a window | |
763 automatically and use it to display a specified buffer. These functions | |
764 can also split an existing window in certain circumstances. We also | |
765 describe variables that parameterize the heuristics used for choosing a | |
766 window. | |
767 @iftex | |
768 See the preceding section for | |
769 @end iftex | |
770 @ifnottex | |
771 @xref{Buffers and Windows}, for | |
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 | 774 functions work by calling @code{set-window-buffer}. |
775 | |
776 Do not use the functions in this section in order to make a buffer | |
777 current so that a Lisp program can access or modify it; they are too | |
778 drastic for that purpose, since they change the display of buffers in | |
779 windows, which would be gratuitous and surprise the user. Instead, use | |
780 @code{set-buffer} and @code{save-current-buffer} (@pxref{Current | |
781 Buffer}), which designate buffers as current for programmed access | |
782 without affecting the display of buffers in windows. | |
783 | |
784 @deffn Command switch-to-buffer buffer-or-name &optional norecord | |
785 This function makes @var{buffer-or-name} the current buffer, and also | |
786 displays the buffer in the selected window. This means that a human can | |
787 see the buffer and subsequent keyboard commands will apply to it. | |
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 | 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 | 796 the variable @code{default-major-mode}; see @ref{Auto Major Mode}. |
84112 | 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 | 804 Normally the specified buffer is put at the front of the buffer list |
805 (both the selected frame's buffer list and the frame-independent buffer | |
806 list). This affects the operation of @code{other-buffer}. However, if | |
807 @var{norecord} is non-@code{nil}, this is not done. @xref{The Buffer | |
808 List}. | |
809 | |
810 The @code{switch-to-buffer} function is often used interactively, as | |
811 the binding of @kbd{C-x b}. It is also used frequently in programs. It | |
812 returns the buffer that it switched to. | |
813 @end deffn | |
814 | |
815 The next two functions are similar to @code{switch-to-buffer}, except | |
816 for the described features. | |
817 | |
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 | 823 |
824 The currently selected window is absolutely never used to do the job. | |
825 If it is the only window, then it is split to make a distinct window for | |
826 this purpose. If the selected window is already displaying the buffer, | |
827 then it continues to do so, but another window is nonetheless found to | |
828 display it in as well. | |
829 | |
830 This function updates the buffer list just like @code{switch-to-buffer} | |
831 unless @var{norecord} is non-@code{nil}. | |
832 @end deffn | |
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 | 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 | 846 |
847 If the variable @code{pop-up-frames} is non-@code{nil}, | |
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 | 852 |
853 If @code{pop-up-frames} is @code{nil}, then @code{pop-to-buffer} | |
854 operates entirely within the selected frame. (If the selected frame has | |
855 just a minibuffer, @code{pop-to-buffer} operates within the most | |
856 recently selected frame that was not just a minibuffer.) | |
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 | 861 |
862 If @var{other-window} is non-@code{nil}, @code{pop-to-buffer} finds or | |
863 creates another window even if @var{buffer-or-name} is already visible | |
864 in the selected window. Thus @var{buffer-or-name} could end up | |
865 displayed in two windows. On the other hand, if @var{buffer-or-name} is | |
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 | 869 |
870 All the variables that affect @code{display-buffer} affect | |
871 @code{pop-to-buffer} as well. @xref{Choosing Window}. | |
872 | |
873 This function updates the buffer list just like @code{switch-to-buffer} | |
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 | 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 | 881 don't care which other buffer is used; you just want to make sure that |
882 @var{buffer-or-name} is no longer displayed. | |
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 | 894 This function returns @code{nil}. |
895 @end deffn | |
896 | |
897 @node Choosing Window | |
898 @section Choosing a Window for Display | |
899 | |
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 | 905 |
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 | 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 | 919 |
920 @code{display-buffer} returns the window chosen to display | |
921 @var{buffer-or-name}. | |
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 | 928 |
929 @itemize @bullet | |
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 | 932 (Actually, the last non-minibuffer frame.) |
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 | 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 | 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 | 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 | 941 @end itemize |
942 | |
943 Precisely how @code{display-buffer} finds or creates a window depends on | |
944 the variables described below. | |
945 @end deffn | |
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 | 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 | 1016 @end defopt |
1017 | |
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 | 1026 @end defopt |
1027 | |
1028 @c Emacs 19 feature | |
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 | 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 | 1041 @end defopt |
1042 | |
1043 @c Emacs 19 feature | |
1044 @defopt pop-up-frame-function | |
1045 This variable specifies how to make a new frame if @code{pop-up-frames} | |
1046 is non-@code{nil}. | |
1047 | |
1048 Its value should be a function of no arguments. When | |
1049 @code{display-buffer} makes a new frame, it does so by calling that | |
1050 function, which should return a frame. The default value of the | |
1051 variable is a function that creates a frame using parameters from | |
1052 @code{pop-up-frame-alist}. | |
1053 @end defopt | |
1054 | |
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 | 1059 @end defopt |
1060 | |
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 | 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 | 1071 contain a function and arguments to give to it. (The function's first |
1072 argument is always the buffer to be displayed; the arguments from the | |
1073 list come after that.) | |
1074 | |
1075 For example: | |
1076 | |
1077 @example | |
1078 (("myfile" (minibuffer) (menu-bar-lines . 0))) | |
1079 @end example | |
1080 | |
1081 @noindent | |
1082 specifies to display a buffer named @samp{myfile} in a dedicated frame | |
1083 with specified @code{minibuffer} and @code{menu-bar-lines} parameters. | |
1084 | |
1085 The list of frame parameters can also use the phony frame parameters | |
1086 @code{same-frame} and @code{same-window}. If the specified frame | |
1087 parameters include @code{(same-window . @var{value})} and @var{value} | |
1088 is non-@code{nil}, that means to display the buffer in the current | |
1089 selected window. Otherwise, if they include @code{(same-frame . | |
1090 @var{value})} and @var{value} is non-@code{nil}, that means to display | |
1091 the buffer in a new window in the currently selected frame. | |
1092 @end defopt | |
1093 | |
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 | 1096 displayed specially. If the buffer's name matches any of the regular |
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 | 1100 |
1101 If an element is a list, instead of a string, then the @sc{car} of the | |
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 | 1104 @end defopt |
1105 | |
1106 @defun special-display-p buffer-name | |
1107 This function returns non-@code{nil} if displaying a buffer | |
1108 named @var{buffer-name} with @code{display-buffer} would | |
1109 create a special frame. The value is @code{t} if it would | |
1110 use the default frame parameters, or else the specified list | |
1111 of frame parameters. | |
1112 @end defun | |
1113 | |
1114 @defvar special-display-function | |
1115 This variable holds the function to call to display a buffer specially. | |
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 | 1119 @end defvar |
1120 | |
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 | 1127 |
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 | 1133 |
1134 This function always uses an existing window displaying @var{buffer}, | |
1135 whether or not it is in a frame of its own; but if you set up the above | |
1136 variables in your init file, before @var{buffer} was created, then | |
1137 presumably the window was previously made by this function. | |
1138 @end defun | |
1139 | |
1140 @defopt special-display-frame-alist | |
1141 @anchor{Definition of special-display-frame-alist} | |
1142 This variable holds frame parameters for | |
1143 @code{special-display-popup-frame} to use when it creates a frame. | |
1144 @end defopt | |
1145 | |
1146 @defopt same-window-buffer-names | |
1147 A list of buffer names for buffers that should be displayed in the | |
1148 selected window. If the buffer's name is in this list, | |
1149 @code{display-buffer} handles the buffer by switching to it in the | |
1150 selected window. | |
1151 @end defopt | |
1152 | |
1153 @defopt same-window-regexps | |
1154 A list of regular expressions that specify buffers that should be | |
1155 displayed in the selected window. If the buffer's name matches any of | |
1156 the regular expressions in this list, @code{display-buffer} handles the | |
1157 buffer by switching to it in the selected window. | |
1158 @end defopt | |
1159 | |
1160 @defun same-window-p buffer-name | |
1161 This function returns @code{t} if displaying a buffer | |
1162 named @var{buffer-name} with @code{display-buffer} would | |
1163 put it in the selected window. | |
1164 @end defun | |
1165 | |
1166 @c Emacs 19 feature | |
1167 @defvar display-buffer-function | |
1168 This variable is the most flexible way to customize the behavior of | |
1169 @code{display-buffer}. If it is non-@code{nil}, it should be a function | |
1170 that @code{display-buffer} calls to do the work. The function should | |
1171 accept two arguments, the first two arguments that @code{display-buffer} | |
1172 received. It should choose or create a window, display the specified | |
1173 buffer in it, and then return the window. | |
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 | 1177 @end defvar |
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 | 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 | 1223 @end defun |
1224 | |
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 | 1236 @end defun |
1237 | |
1238 @node Window Point | |
1239 @section Windows and Point | |
1240 @cindex window position | |
1241 @cindex window point | |
1242 @cindex position in window | |
1243 @cindex point in window | |
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 | 1248 |
1249 @itemize @bullet | |
1250 @item | |
1251 The window point is established when a window is first created; it is | |
1252 initialized from the buffer's point, or from the window point of another | |
1253 window opened on the buffer if such a window exists. | |
1254 | |
1255 @item | |
1256 Selecting a window sets the value of point in its buffer from the | |
1257 window's value of point. Conversely, deselecting a window sets the | |
1258 window's value of point from that of the buffer. Thus, when you switch | |
1259 between windows that display a given buffer, the point value for the | |
1260 selected window is in effect in the buffer, while the point values for | |
1261 the other windows are stored in those windows. | |
1262 | |
1263 @item | |
1264 As long as the selected window displays the current buffer, the window's | |
1265 point and the buffer's point always move together; they remain equal. | |
1266 @end itemize | |
1267 | |
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 | 1270 when the user switches to another buffer, the cursor jumps to the |
1271 position of point in that buffer. | |
1272 | |
1273 @defun window-point &optional window | |
1274 This function returns the current position of point in @var{window}. | |
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 | 1278 |
1279 When @var{window} is the selected window and its buffer is also the | |
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 | 1284 @end defun |
1285 | |
1286 @defun set-window-point window position | |
1287 This function positions point in @var{window} at position | |
1288 @var{position} in @var{window}'s buffer. It returns @var{position}. | |
1289 | |
1290 If @var{window} is selected, and its buffer is current, | |
1291 this simply does @code{goto-char}. | |
1292 @end defun | |
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 | 1302 @cindex window start position |
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 | 1305 that specifies where in the buffer display should start. This position |
1306 is called the @dfn{display-start} position of the window (or just the | |
1307 @dfn{start}). The character after this position is the one that appears | |
1308 at the upper left corner of the window. It is usually, but not | |
1309 inevitably, at the beginning of a text line. | |
1310 | |
92148 | 1311 After switching windows or buffers, and in some other cases, if the |
1312 window start is in the middle of a line, Emacs adjusts the window | |
1313 start to the start of a line. This prevents certain operations from | |
1314 leaving the window start at a meaningless point within a line. This | |
1315 feature may interfere with testing some Lisp code by executing it | |
1316 using the commands of Lisp mode, because they trigger this | |
1317 readjustment. To test such code, put it into a command and bind the | |
1318 command to a key. | |
1319 | |
84112 | 1320 @defun window-start &optional window |
1321 @cindex window top line | |
1322 This function returns the display-start position of window | |
1323 @var{window}. If @var{window} is @code{nil}, the selected window is | |
1324 used. For example, | |
1325 | |
1326 @example | |
1327 @group | |
1328 (window-start) | |
1329 @result{} 7058 | |
1330 @end group | |
1331 @end example | |
1332 | |
1333 When you create a window, or display a different buffer in it, the | |
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 | 1337 |
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 | 1343 |
1344 For a realistic example of using @code{window-start}, see the | |
1345 description of @code{count-lines}. @xref{Definition of count-lines}. | |
1346 @end defun | |
1347 | |
99438
5743d4e279a5
(Windows): Update entries.
Martin Rudalics <rudalics@gmx.at>
parents:
99128
diff
changeset
|
1348 @cindex window end position |
84112 | 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 | 1352 |
1353 Simply changing the buffer text or moving point does not update the | |
1354 value that @code{window-end} returns. The value is updated only when | |
1355 Emacs redisplays and redisplay completes without being preempted. | |
1356 | |
1357 If the last redisplay of @var{window} was preempted, and did not finish, | |
1358 Emacs does not know the position of the end of display in that window. | |
1359 In that case, this function returns @code{nil}. | |
1360 | |
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 | 1366 |
1367 Even if @var{update} is non-@code{nil}, @code{window-end} does not | |
1368 attempt to scroll the display if point has moved off the screen, the | |
1369 way real redisplay would do. It does not alter the | |
1370 @code{window-start} value. In effect, it reports where the displayed | |
1371 text will end if scrolling is not required. | |
1372 @end defun | |
1373 | |
1374 @defun set-window-start window position &optional noforce | |
1375 This function sets the display-start position of @var{window} to | |
1376 @var{position} in @var{window}'s buffer. It returns @var{position}. | |
1377 | |
1378 The display routines insist that the position of point be visible when a | |
1379 buffer is displayed. Normally, they change the display-start position | |
1380 (that is, scroll the window) whenever necessary to make point visible. | |
1381 However, if you specify the start position with this function using | |
1382 @code{nil} for @var{noforce}, it means you want display to start at | |
1383 @var{position} even if that would put the location of point off the | |
1384 screen. If this does place point off screen, the display routines move | |
1385 point to the left margin on the middle line in the window. | |
1386 | |
92148 | 1387 For example, if point @w{is 1} and you set the start of the window |
1388 @w{to 37}, the start of the next line, point will be ``above'' the top | |
1389 of the window. The display routines will automatically move point if | |
1390 it is still 1 when redisplay occurs. Here is an example: | |
84112 | 1391 |
1392 @example | |
1393 @group | |
1394 ;; @r{Here is what @samp{foo} looks like before executing} | |
1395 ;; @r{the @code{set-window-start} expression.} | |
1396 @end group | |
1397 | |
1398 @group | |
1399 ---------- Buffer: foo ---------- | |
1400 @point{}This is the contents of buffer foo. | |
1401 2 | |
1402 3 | |
1403 4 | |
1404 5 | |
1405 6 | |
1406 ---------- Buffer: foo ---------- | |
1407 @end group | |
1408 | |
1409 @group | |
1410 (set-window-start | |
1411 (selected-window) | |
92148 | 1412 (save-excursion |
1413 (goto-char 1) | |
1414 (forward-line 1) | |
1415 (point))) | |
1416 @result{} 37 | |
84112 | 1417 @end group |
1418 | |
1419 @group | |
1420 ;; @r{Here is what @samp{foo} looks like after executing} | |
1421 ;; @r{the @code{set-window-start} expression.} | |
1422 ---------- Buffer: foo ---------- | |
1423 2 | |
1424 3 | |
1425 @point{}4 | |
1426 5 | |
1427 6 | |
1428 ---------- Buffer: foo ---------- | |
1429 @end group | |
1430 @end example | |
1431 | |
1432 If @var{noforce} is non-@code{nil}, and @var{position} would place point | |
1433 off screen at the next redisplay, then redisplay computes a new window-start | |
1434 position that works well with point, and thus @var{position} is not used. | |
1435 @end defun | |
1436 | |
1437 @defun pos-visible-in-window-p &optional position window partially | |
1438 This function returns non-@code{nil} if @var{position} is within the | |
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 | 1446 |
1447 The @code{pos-visible-in-window-p} function considers only vertical | |
1448 scrolling. If @var{position} is out of view only because @var{window} | |
1449 has been scrolled horizontally, @code{pos-visible-in-window-p} returns | |
1450 non-@code{nil} anyway. @xref{Horizontal Scrolling}. | |
1451 | |
1452 If @var{position} is visible, @code{pos-visible-in-window-p} returns | |
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 | 1455 visible, it returns a list of the form @code{(@var{x} @var{y})}, where |
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 | 1463 |
1464 Here is an example: | |
1465 | |
1466 @example | |
1467 @group | |
1468 ;; @r{If point is off the screen now, recenter it now.} | |
1469 (or (pos-visible-in-window-p | |
1470 (point) (selected-window)) | |
1471 (recenter 0)) | |
1472 @end group | |
1473 @end example | |
1474 @end defun | |
1475 | |
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 | 1484 |
1485 If the display is not up to date, @code{window-line-height} returns | |
1486 @code{nil}. In that case, @code{pos-visible-in-window-p} may be used | |
1487 to obtain related information. | |
1488 | |
1489 If there is no line corresponding to the specified @var{line}, | |
1490 @code{window-line-height} returns @code{nil}. Otherwise, it returns | |
1491 a list @code{(@var{height} @var{vpos} @var{ypos} @var{offbot})}, | |
1492 where @var{height} is the height in pixels of the visible part of the | |
1493 line, @var{vpos} and @var{ypos} are the vertical position in lines and | |
1494 pixels of the line relative to the top of the first text line, and | |
1495 @var{offbot} is the number of off-window pixels at the bottom of the | |
1496 text line. If there are off-window pixels at the top of the (first) | |
1497 text line, @var{ypos} is negative. | |
1498 @end defun | |
1499 | |
1500 @node Textual Scrolling | |
1501 @section Textual Scrolling | |
1502 @cindex textual scrolling | |
1503 @cindex scrolling textually | |
1504 | |
1505 @dfn{Textual scrolling} means moving the text up or down through a | |
1506 window. It works by changing the value of the window's display-start | |
1507 location. It may also change the value of @code{window-point} to keep | |
1508 point on the screen. | |
1509 | |
1510 Textual scrolling was formerly called ``vertical scrolling,'' but we | |
1511 changed its name to distinguish it from the new vertical fractional | |
1512 scrolling feature (@pxref{Vertical Scrolling}). | |
1513 | |
1514 In the commands @code{scroll-up} and @code{scroll-down}, the directions | |
1515 ``up'' and ``down'' refer to the motion of the text in the buffer at which | |
1516 you are looking through the window. Imagine that the text is | |
1517 written on a long roll of paper and that the scrolling commands move the | |
1518 paper up and down. Thus, if you are looking at text in the middle of a | |
1519 buffer and repeatedly call @code{scroll-down}, you will eventually see | |
1520 the beginning of the buffer. | |
1521 | |
1522 Some people have urged that the opposite convention be used: they | |
1523 imagine that the window moves over text that remains in place. Then | |
1524 ``down'' commands would take you to the end of the buffer. This view is | |
1525 more consistent with the actual relationship between windows and the | |
1526 text in the buffer, but it is less like what the user sees. The | |
1527 position of a window on the terminal does not move, and short scrolling | |
1528 commands clearly move the text up or down on the screen. We have chosen | |
1529 names that fit the user's point of view. | |
1530 | |
1531 The textual scrolling functions (aside from | |
1532 @code{scroll-other-window}) have unpredictable results if the current | |
1533 buffer is different from the buffer that is displayed in the selected | |
1534 window. @xref{Current Buffer}. | |
1535 | |
1536 If the window contains a row which is taller than the height of the | |
1537 window (for example in the presence of a large image), the scroll | |
1538 functions will adjust the window vscroll to scroll the partially | |
1539 visible row. To disable this feature, Lisp code may bind the variable | |
1540 `auto-window-vscroll' to @code{nil} (@pxref{Vertical Scrolling}). | |
1541 | |
1542 @deffn Command scroll-up &optional count | |
1543 This function scrolls the text in the selected window upward | |
1544 @var{count} lines. If @var{count} is negative, scrolling is actually | |
1545 downward. | |
1546 | |
1547 If @var{count} is @code{nil} (or omitted), then the length of scroll | |
1548 is @code{next-screen-context-lines} lines less than the usable height of | |
1549 the window (not counting its mode line). | |
1550 | |
1551 @code{scroll-up} returns @code{nil}, unless it gets an error | |
1552 because it can't scroll any further. | |
1553 @end deffn | |
1554 | |
1555 @deffn Command scroll-down &optional count | |
1556 This function scrolls the text in the selected window downward | |
1557 @var{count} lines. If @var{count} is negative, scrolling is actually | |
1558 upward. | |
1559 | |
1560 If @var{count} is omitted or @code{nil}, then the length of the scroll | |
1561 is @code{next-screen-context-lines} lines less than the usable height of | |
1562 the window (not counting its mode line). | |
1563 | |
1564 @code{scroll-down} returns @code{nil}, unless it gets an error because | |
1565 it can't scroll any further. | |
1566 @end deffn | |
1567 | |
1568 @deffn Command scroll-other-window &optional count | |
1569 This function scrolls the text in another window upward @var{count} | |
1570 lines. Negative values of @var{count}, or @code{nil}, are handled | |
1571 as in @code{scroll-up}. | |
1572 | |
1573 You can specify which buffer to scroll by setting the variable | |
1574 @code{other-window-scroll-buffer} to a buffer. If that buffer isn't | |
1575 already displayed, @code{scroll-other-window} displays it in some | |
1576 window. | |
1577 | |
1578 When the selected window is the minibuffer, the next window is normally | |
1579 the one at the top left corner. You can specify a different window to | |
1580 scroll, when the minibuffer is selected, by setting the variable | |
1581 @code{minibuffer-scroll-window}. This variable has no effect when any | |
1582 other window is selected. When it is non-@code{nil} and the | |
1583 minibuffer is selected, it takes precedence over | |
1584 @code{other-window-scroll-buffer}. @xref{Definition of | |
1585 minibuffer-scroll-window}. | |
1586 | |
1587 When the minibuffer is active, it is the next window if the selected | |
1588 window is the one at the bottom right corner. In this case, | |
1589 @code{scroll-other-window} attempts to scroll the minibuffer. If the | |
1590 minibuffer contains just one line, it has nowhere to scroll to, so the | |
1591 line reappears after the echo area momentarily displays the message | |
1592 @samp{Beginning of buffer}. | |
1593 @end deffn | |
1594 | |
1595 @c Emacs 19 feature | |
1596 @defvar other-window-scroll-buffer | |
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 | 1599 @end defvar |
1600 | |
1601 @defopt scroll-margin | |
1602 This option specifies the size of the scroll margin---a minimum number | |
1603 of lines between point and the top or bottom of a window. Whenever | |
1604 point gets within this many lines of the top or bottom of the window, | |
1605 redisplay scrolls the text automatically (if possible) to move point | |
1606 out of the margin, closer to the center of the window. | |
1607 @end defopt | |
1608 | |
1609 @defopt scroll-conservatively | |
1610 This variable controls how scrolling is done automatically when point | |
1611 moves off the screen (or into the scroll margin). If the value is a | |
1612 positive integer @var{n}, then redisplay scrolls the text up to | |
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 | 1615 Otherwise, scrolling happens in the usual way, under the control of |
1616 other variables such as @code{scroll-up-aggressively} and | |
1617 @code{scroll-down-aggressively}. | |
1618 | |
1619 The default value is zero, which means that conservative scrolling | |
1620 never happens. | |
1621 @end defopt | |
1622 | |
1623 @defopt scroll-down-aggressively | |
1624 The value of this variable should be either @code{nil} or a fraction | |
1625 @var{f} between 0 and 1. If it is a fraction, that specifies where on | |
1626 the screen to put point when scrolling down. More precisely, when a | |
1627 window scrolls down because point is above the window start, the new | |
1628 start position is chosen to put point @var{f} part of the window | |
1629 height from the top. The larger @var{f}, the more aggressive the | |
1630 scrolling. | |
1631 | |
1632 A value of @code{nil} is equivalent to .5, since its effect is to center | |
1633 point. This variable automatically becomes buffer-local when set in any | |
1634 fashion. | |
1635 @end defopt | |
1636 | |
1637 @defopt scroll-up-aggressively | |
1638 Likewise, for scrolling up. The value, @var{f}, specifies how far | |
1639 point should be placed from the bottom of the window; thus, as with | |
1640 @code{scroll-up-aggressively}, a larger value scrolls more aggressively. | |
1641 @end defopt | |
1642 | |
1643 @defopt scroll-step | |
1644 This variable is an older variant of @code{scroll-conservatively}. The | |
1645 difference is that it if its value is @var{n}, that permits scrolling | |
1646 only by precisely @var{n} lines, not a smaller number. This feature | |
1647 does not work with @code{scroll-margin}. The default value is zero. | |
1648 @end defopt | |
1649 | |
1650 @defopt scroll-preserve-screen-position | |
1651 If this option is @code{t}, scrolling which would move the current | |
1652 point position out of the window chooses the new position of point | |
1653 so that the vertical position of the cursor is unchanged, if possible. | |
1654 | |
1655 If it is non-@code{nil} and not @code{t}, then the scrolling functions | |
1656 always preserve the vertical position of point, if possible. | |
1657 @end defopt | |
1658 | |
1659 @defopt next-screen-context-lines | |
1660 The value of this variable is the number of lines of continuity to | |
1661 retain when scrolling by full screens. For example, @code{scroll-up} | |
1662 with an argument of @code{nil} scrolls so that this many lines at the | |
1663 bottom of the window appear instead at the top. The default value is | |
1664 @code{2}. | |
1665 @end defopt | |
1666 | |
1667 @deffn Command recenter &optional count | |
1668 @cindex centering point | |
1669 This function scrolls the text in the selected window so that point is | |
1670 displayed at a specified vertical position within the window. It does | |
1671 not ``move point'' with respect to the text. | |
1672 | |
1673 If @var{count} is a nonnegative number, that puts the line containing | |
1674 point @var{count} lines down from the top of the window. If | |
1675 @var{count} is a negative number, then it counts upward from the | |
1676 bottom of the window, so that @minus{}1 stands for the last usable | |
1677 line in the window. If @var{count} is a non-@code{nil} list, then it | |
1678 stands for the line in the middle of the window. | |
1679 | |
1680 If @var{count} is @code{nil}, @code{recenter} puts the line containing | |
1681 point in the middle of the window, then clears and redisplays the entire | |
1682 selected frame. | |
1683 | |
1684 When @code{recenter} is called interactively, @var{count} is the raw | |
1685 prefix argument. Thus, typing @kbd{C-u} as the prefix sets the | |
1686 @var{count} to a non-@code{nil} list, while typing @kbd{C-u 4} sets | |
1687 @var{count} to 4, which positions the current line four lines from the | |
1688 top. | |
1689 | |
1690 With an argument of zero, @code{recenter} positions the current line at | |
1691 the top of the window. This action is so handy that some people make a | |
1692 separate key binding to do this. For example, | |
1693 | |
1694 @example | |
1695 @group | |
1696 (defun line-to-top-of-window () | |
1697 "Scroll current line to top of window. | |
1698 Replaces three keystroke sequence C-u 0 C-l." | |
1699 (interactive) | |
1700 (recenter 0)) | |
1701 | |
1702 (global-set-key [kp-multiply] 'line-to-top-of-window) | |
1703 @end group | |
1704 @end example | |
1705 @end deffn | |
1706 | |
1707 @node Vertical Scrolling | |
1708 @section Vertical Fractional Scrolling | |
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 | 1721 height, which is the height of the default font. Thus, if the value is |
1722 .5, that means the window contents are scrolled up half the normal line | |
1723 height. If it is 3.3, that means the window contents are scrolled up | |
1724 somewhat over three times the normal line height. | |
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 | 1727 lines, depends on what the lines contain. A value of .5 could scroll a |
1728 line whose height is very short off the screen, while a value of 3.3 | |
1729 could scroll just part of the way through a tall line or an image. | |
1730 | |
1731 @defun window-vscroll &optional window pixels-p | |
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 | 1736 |
1737 @example | |
1738 @group | |
1739 (window-vscroll) | |
1740 @result{} 0 | |
1741 @end group | |
1742 @end example | |
1743 @end defun | |
1744 | |
1745 @defun set-window-vscroll window lines &optional pixels-p | |
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 | 1751 |
1752 The actual vertical scroll position must always correspond | |
1753 to an integral number of pixels, so the value you specify | |
1754 is rounded accordingly. | |
1755 | |
1756 The return value is the result of this rounding. | |
1757 | |
1758 @example | |
1759 @group | |
1760 (set-window-vscroll (selected-window) 1.2) | |
1761 @result{} 1.13 | |
1762 @end group | |
1763 @end example | |
1764 | |
1765 If @var{pixels-p} is non-@code{nil}, @var{lines} specifies a number of | |
1766 pixels. In this case, the return value is @var{lines}. | |
1767 @end defun | |
1768 | |
1769 @defvar auto-window-vscroll | |
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 | 1774 @end defvar |
1775 | |
1776 @node Horizontal Scrolling | |
1777 @section Horizontal Scrolling | |
1778 @cindex horizontal scrolling | |
1779 | |
1780 @dfn{Horizontal scrolling} means shifting the image in the window left | |
1781 or right by a specified multiple of the normal character width. Each | |
1782 window has a @dfn{horizontal scroll position}, which is a number, never | |
1783 less than zero. It specifies how far to shift the contents left. | |
1784 Shifting the window contents left generally makes all or part of some | |
1785 characters disappear off the left, and all or part of some other | |
1786 characters appear at the right. The usual value is zero. | |
1787 | |
1788 The horizontal scroll position is measured in units of the normal | |
1789 character width, which is the width of space in the default font. Thus, | |
1790 if the value is 5, that means the window contents are scrolled left by 5 | |
1791 times the normal character width. How many characters actually | |
1792 disappear off to the left depends on their width, and could vary from | |
1793 line to line. | |
1794 | |
1795 Because we read from side to side in the ``inner loop,'' and from top | |
1796 to bottom in the ``outer loop,'' the effect of horizontal scrolling is | |
1797 not like that of textual or vertical scrolling. Textual scrolling | |
1798 involves selection of a portion of text to display, and vertical | |
1799 scrolling moves the window contents contiguously; but horizontal | |
1800 scrolling causes part of @emph{each line} to go off screen. | |
1801 | |
1802 Usually, no horizontal scrolling is in effect; then the leftmost | |
1803 column is at the left edge of the window. In this state, scrolling to | |
1804 the right is meaningless, since there is no data to the left of the edge | |
1805 to be revealed by it; so this is not allowed. Scrolling to the left is | |
1806 allowed; it scrolls the first columns of text off the edge of the window | |
1807 and can reveal additional columns on the right that were truncated | |
1808 before. Once a window has a nonzero amount of leftward horizontal | |
1809 scrolling, you can scroll it back to the right, but only so far as to | |
1810 reduce the net horizontal scroll to zero. There is no limit to how far | |
1811 left you can scroll, but eventually all the text will disappear off the | |
1812 left edge. | |
1813 | |
1814 @vindex auto-hscroll-mode | |
1815 If @code{auto-hscroll-mode} is set, redisplay automatically alters | |
1816 the horizontal scrolling of a window as necessary to ensure that point | |
1817 is always visible. However, you can still set the horizontal | |
1818 scrolling value explicitly. The value you specify serves as a lower | |
1819 bound for automatic scrolling, i.e. automatic scrolling will not | |
1820 scroll a window to a column less than the specified one. | |
1821 | |
1822 @deffn Command scroll-left &optional count set-minimum | |
1823 This function scrolls the selected window @var{count} columns to the | |
1824 left (or to the right if @var{count} is negative). The default | |
1825 for @var{count} is the window width, minus 2. | |
1826 | |
1827 The return value is the total amount of leftward horizontal scrolling in | |
1828 effect after the change---just like the value returned by | |
1829 @code{window-hscroll} (below). | |
1830 | |
1831 Once you scroll a window as far right as it can go, back to its normal | |
1832 position where the total leftward scrolling is zero, attempts to scroll | |
1833 any farther right have no effect. | |
1834 | |
1835 If @var{set-minimum} is non-@code{nil}, the new scroll amount becomes | |
1836 the lower bound for automatic scrolling; that is, automatic scrolling | |
1837 will not scroll a window to a column less than the value returned by | |
1838 this function. Interactive calls pass non-@code{nil} for | |
1839 @var{set-minimum}. | |
1840 @end deffn | |
1841 | |
1842 @deffn Command scroll-right &optional count set-minimum | |
1843 This function scrolls the selected window @var{count} columns to the | |
1844 right (or to the left if @var{count} is negative). The default | |
1845 for @var{count} is the window width, minus 2. Aside from the direction | |
1846 of scrolling, this works just like @code{scroll-left}. | |
1847 @end deffn | |
1848 | |
1849 @defun window-hscroll &optional window | |
1850 This function returns the total leftward horizontal scrolling of | |
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 | 1858 |
1859 @example | |
1860 @group | |
1861 (window-hscroll) | |
1862 @result{} 0 | |
1863 @end group | |
1864 @group | |
1865 (scroll-left 5) | |
1866 @result{} 5 | |
1867 @end group | |
1868 @group | |
1869 (window-hscroll) | |
1870 @result{} 5 | |
1871 @end group | |
1872 @end example | |
1873 @end defun | |
1874 | |
1875 @defun set-window-hscroll window columns | |
1876 This function sets horizontal scrolling of @var{window}. The value of | |
1877 @var{columns} specifies the amount of scrolling, in terms of columns | |
1878 from the left margin. The argument @var{columns} should be zero or | |
1879 positive; if not, it is taken as zero. Fractional values of | |
1880 @var{columns} are not supported at present. | |
1881 | |
1882 Note that @code{set-window-hscroll} may appear not to work if you test | |
1883 it by evaluating a call with @kbd{M-:} in a simple way. What happens | |
1884 is that the function sets the horizontal scroll value and returns, but | |
1885 then redisplay adjusts the horizontal scrolling to make point visible, | |
1886 and this overrides what the function did. You can observe the | |
1887 function's effect if you call it while point is sufficiently far from | |
1888 the left margin that it will remain visible. | |
1889 | |
1890 The value returned is @var{columns}. | |
1891 | |
1892 @example | |
1893 @group | |
1894 (set-window-hscroll (selected-window) 10) | |
1895 @result{} 10 | |
1896 @end group | |
1897 @end example | |
1898 @end defun | |
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 | 1902 |
1903 @example | |
1904 @group | |
1905 (defun hscroll-on-screen (window position) | |
1906 (save-excursion | |
1907 (goto-char position) | |
1908 (and | |
1909 (>= (- (current-column) (window-hscroll window)) 0) | |
1910 (< (- (current-column) (window-hscroll window)) | |
1911 (window-width window))))) | |
1912 @end group | |
1913 @end example | |
1914 | |
1915 @node Size of Window | |
1916 @section The Size of a Window | |
1917 @cindex window size | |
1918 @cindex size of window | |
1919 | |
1920 An Emacs window is rectangular, and its size information consists of | |
1921 the height (the number of lines) and the width (the number of character | |
1922 positions in each line). The mode line is included in the height. But | |
1923 the width does not count the scroll bar or the column of @samp{|} | |
1924 characters that separates side-by-side windows. | |
1925 | |
1926 The following three functions return size information about a window: | |
1927 | |
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 | 1934 |
1935 @example | |
1936 @group | |
1937 (window-height) | |
1938 @result{} 23 | |
1939 @end group | |
1940 @group | |
1941 (split-window-vertically) | |
1942 @result{} #<window 4 on windows.texi> | |
1943 @end group | |
1944 @group | |
1945 (window-height) | |
1946 @result{} 11 | |
1947 @end group | |
1948 @end example | |
1949 @end defun | |
1950 | |
1951 @defun window-body-height &optional window | |
1952 Like @code{window-height} but the value does not include the | |
1953 mode line (if any) or the header line (if any). | |
1954 @end defun | |
1955 | |
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 | 1967 |
1968 @example | |
1969 @group | |
1970 (window-width) | |
1971 @result{} 80 | |
1972 @end group | |
1973 @end example | |
1974 @end defun | |
1975 | |
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 | 1980 @end defun |
1981 | |
1982 @defun window-edges &optional window | |
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 | 1985 |
1986 The order of the list is @code{(@var{left} @var{top} @var{right} | |
1987 @var{bottom})}, all elements relative to 0, 0 at the top left corner of | |
1988 the frame. The element @var{right} of the value is one more than the | |
1989 rightmost column used by @var{window}, and @var{bottom} is one more than | |
1990 the bottommost row used by @var{window} and its mode-line. | |
1991 | |
1992 The edges include the space used by the window's scroll bar, display | |
1993 margins, fringes, header line, and mode line, if it has them. Also, | |
1994 if the window has a neighbor on the right, its right edge value | |
1995 includes the width of the separator line between the window and that | |
1996 neighbor. Since the width of the window does not include this | |
1997 separator, the width does not usually equal the difference between the | |
1998 right and left edges. | |
1999 @end defun | |
2000 | |
2001 @defun window-inside-edges &optional window | |
2002 This is similar to @code{window-edges}, but the edge values | |
2003 it returns include only the text area of the window. They | |
2004 do not include the header line, mode line, scroll bar or | |
2005 vertical separator, fringes, or display margins. | |
2006 @end defun | |
2007 | |
2008 Here are the results obtained on a typical 24-line terminal with just | |
2009 one window, with menu bar enabled: | |
2010 | |
2011 @example | |
2012 @group | |
2013 (window-edges (selected-window)) | |
2014 @result{} (0 1 80 23) | |
2015 @end group | |
2016 @group | |
2017 (window-inside-edges (selected-window)) | |
2018 @result{} (0 1 80 22) | |
2019 @end group | |
2020 @end example | |
2021 | |
2022 @noindent | |
2023 The bottom edge is at line 23 because the last line is the echo area. | |
2024 The bottom inside edge is at line 22, which is the window's mode line. | |
2025 | |
2026 If @var{window} is at the upper left corner of its frame, and there is | |
2027 no menu bar, then @var{bottom} returned by @code{window-edges} is the | |
2028 same as the value of @code{(window-height)}, @var{right} is almost the | |
2029 same as the value of @code{(window-width)}, and @var{top} and | |
2030 @var{left} are zero. For example, the edges of the following window | |
2031 are @w{@samp{0 0 8 5}}. Assuming that the frame has more than 8 | |
2032 columns, the last column of the window (column 7) holds a border | |
2033 rather than text. The last row (row 4) holds the mode line, shown | |
2034 here with @samp{xxxxxxxxx}. | |
2035 | |
2036 @example | |
2037 @group | |
2038 0 | |
2039 _______ | |
2040 0 | | | |
2041 | | | |
2042 | | | |
2043 | | | |
2044 xxxxxxxxx 4 | |
2045 | |
2046 7 | |
2047 @end group | |
2048 @end example | |
2049 | |
2050 In the following example, let's suppose that the frame is 7 | |
2051 columns wide. Then the edges of the left window are @w{@samp{0 0 4 3}} | |
2052 and the edges of the right window are @w{@samp{4 0 7 3}}. | |
2053 The inside edges of the left window are @w{@samp{0 0 3 2}}, | |
2054 and the inside edges of the right window are @w{@samp{4 0 7 2}}, | |
2055 | |
2056 @example | |
2057 @group | |
2058 ___ ___ | |
2059 | | | | |
2060 | | | | |
2061 xxxxxxxxx | |
2062 | |
2063 0 34 7 | |
2064 @end group | |
2065 @end example | |
2066 | |
2067 @defun window-pixel-edges &optional window | |
2068 This function is like @code{window-edges} except that, on a graphical | |
2069 display, the edge values are measured in pixels instead of in | |
2070 character lines and columns. | |
2071 @end defun | |
2072 | |
2073 @defun window-inside-pixel-edges &optional window | |
2074 This function is like @code{window-inside-edges} except that, on a | |
2075 graphical display, the edge values are measured in pixels instead of | |
2076 in character lines and columns. | |
2077 @end defun | |
2078 | |
2079 @node Resizing Windows | |
2080 @section Changing the Size of a Window | |
2081 @cindex window resizing | |
2082 @cindex resize window | |
2083 @cindex changing window size | |
2084 @cindex window size, changing | |
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 | 2087 that change the size of windows and low-level functions that access |
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 | 2090 |
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 | 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 | 2103 @code{window-min-width} columns, that window disappears. |
2104 | |
2105 If the requested size would exceed that of the window's frame, then the | |
2106 function makes the window occupy the entire height (or width) of the | |
2107 frame. | |
2108 | |
2109 If there are various other windows from which lines or columns can be | |
2110 stolen, and some of them specify fixed size (using | |
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 | 2113 size of a fixed-size window, @code{enlarge-window} gets an error |
2114 instead. | |
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 | 2117 @minus{}@var{size} lines or columns. If that makes the window smaller |
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 | 2120 |
2121 @code{enlarge-window} returns @code{nil}. | |
2122 @end deffn | |
2123 | |
2124 @deffn Command enlarge-window-horizontally columns | |
2125 This function makes the selected window @var{columns} wider. | |
2126 It could be defined as follows: | |
2127 | |
2128 @example | |
2129 @group | |
2130 (defun enlarge-window-horizontally (columns) | |
2131 (interactive "p") | |
2132 (enlarge-window columns t)) | |
2133 @end group | |
2134 @end example | |
2135 @end deffn | |
2136 | |
2137 @deffn Command shrink-window size &optional horizontal | |
2138 This function is like @code{enlarge-window} but negates the argument | |
2139 @var{size}, making the selected window smaller by giving lines (or | |
2140 columns) to the other windows. If the window shrinks below | |
2141 @code{window-min-height} or @code{window-min-width}, then it disappears. | |
2142 | |
2143 If @var{size} is negative, the window is enlarged by @minus{}@var{size} | |
2144 lines or columns. | |
2145 @end deffn | |
2146 | |
2147 @deffn Command shrink-window-horizontally columns | |
2148 This function makes the selected window @var{columns} narrower. | |
2149 It could be defined as follows: | |
2150 | |
2151 @example | |
2152 @group | |
2153 (defun shrink-window-horizontally (columns) | |
2154 (interactive "p") | |
2155 (shrink-window columns t)) | |
2156 @end group | |
2157 @end example | |
2158 @end deffn | |
2159 | |
2160 @defun adjust-window-trailing-edge window delta horizontal | |
2161 This function makes the selected window @var{delta} lines taller or | |
2162 @var{delta} columns wider, by moving the bottom or right edge. This | |
2163 function does not delete other windows; if it cannot make the | |
2164 requested size adjustment, it signals an error. On success, this | |
2165 function returns @code{nil}. | |
2166 @end defun | |
2167 | |
2168 @defun fit-window-to-buffer &optional window max-height min-height | |
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 | 2182 @end defun |
2183 | |
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 | 2191 display the whole text of the buffer, or if part of the contents are |
2192 currently scrolled off screen, or if the window is not the full width of | |
2193 its frame, or if the window is the only window in its frame. | |
2194 | |
2195 This command returns non-@code{nil} if it actually shrank the window | |
2196 and @code{nil} otherwise. | |
2197 @end deffn | |
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 | 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 | 2204 |
2205 If the value is @code{height}, then only the window's height is fixed; | |
2206 if the value is @code{width}, then only the window's width is fixed. | |
2207 Any other non-@code{nil} value fixes both the width and the height. | |
2208 | |
2209 This variable automatically becomes buffer-local when set. | |
2210 | |
2211 Explicit size-change functions such as @code{enlarge-window} | |
2212 get an error if they would have to change a window size which is fixed. | |
2213 Therefore, when you want to change the size of such a window, | |
2214 you should bind @code{window-size-fixed} to @code{nil}, like this: | |
2215 | |
2216 @example | |
2217 (let ((window-size-fixed nil)) | |
2218 (enlarge-window 10)) | |
2219 @end example | |
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 | 2223 @end defvar |
2224 | |
2225 @cindex minimum window size | |
2226 The following two variables constrain the window-structure-changing | |
2227 functions to a minimum height and width. | |
2228 | |
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 | 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 | 2237 @end defopt |
2238 | |
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 | 2241 before it is automatically deleted. Making a window smaller than |
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 | 2246 @end defopt |
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 | 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 | 2271 @node Coordinates and Windows |
2272 @section Coordinates and Windows | |
2273 | |
2274 This section describes how to relate screen coordinates to windows. | |
2275 | |
2276 @defun window-at x y &optional frame | |
2277 This function returns the window containing the specified cursor | |
2278 position in the frame @var{frame}. The coordinates @var{x} and @var{y} | |
2279 are measured in characters and count from the top left corner of the | |
2280 frame. If they are out of range, @code{window-at} returns @code{nil}. | |
2281 | |
2282 If you omit @var{frame}, the selected frame is used. | |
2283 @end defun | |
2284 | |
2285 @defun coordinates-in-window-p coordinates window | |
2286 This function checks whether a particular frame position falls within | |
2287 the window @var{window}. | |
2288 | |
2289 The argument @var{coordinates} is a cons cell of the form @code{(@var{x} | |
2290 . @var{y})}. The coordinates @var{x} and @var{y} are measured in | |
2291 characters, and count from the top left corner of the screen or frame. | |
2292 | |
2293 The value returned by @code{coordinates-in-window-p} is non-@code{nil} | |
2294 if the coordinates are inside @var{window}. The value also indicates | |
2295 what part of the window the position is in, as follows: | |
2296 | |
2297 @table @code | |
2298 @item (@var{relx} . @var{rely}) | |
2299 The coordinates are inside @var{window}. The numbers @var{relx} and | |
2300 @var{rely} are the equivalent window-relative coordinates for the | |
2301 specified position, counting from 0 at the top left corner of the | |
2302 window. | |
2303 | |
2304 @item mode-line | |
2305 The coordinates are in the mode line of @var{window}. | |
2306 | |
2307 @item header-line | |
2308 The coordinates are in the header line of @var{window}. | |
2309 | |
2310 @item vertical-line | |
2311 The coordinates are in the vertical line between @var{window} and its | |
2312 neighbor to the right. This value occurs only if the window doesn't | |
2313 have a scroll bar; positions in a scroll bar are considered outside the | |
2314 window for these purposes. | |
2315 | |
2316 @item left-fringe | |
2317 @itemx right-fringe | |
2318 The coordinates are in the left or right fringe of the window. | |
2319 | |
2320 @item left-margin | |
2321 @itemx right-margin | |
2322 The coordinates are in the left or right margin of the window. | |
2323 | |
2324 @item nil | |
2325 The coordinates are not in any part of @var{window}. | |
2326 @end table | |
2327 | |
2328 The function @code{coordinates-in-window-p} does not require a frame as | |
2329 argument because it always uses the frame that @var{window} is on. | |
2330 @end defun | |
2331 | |
2332 @node Window Tree | |
2333 @section The Window Tree | |
2334 @cindex window tree | |
2335 | |
2336 A @dfn{window tree} specifies the layout, size, and relationship | |
2337 between all windows in one frame. | |
2338 | |
2339 @defun window-tree &optional frame | |
2340 This function returns the window tree for frame @var{frame}. | |
2341 If @var{frame} is omitted, the selected frame is used. | |
2342 | |
2343 The return value is a list of the form @code{(@var{root} @var{mini})}, | |
2344 where @var{root} represents the window tree of the frame's | |
2345 root window, and @var{mini} is the frame's minibuffer window. | |
2346 | |
2347 If the root window is not split, @var{root} is the root window itself. | |
2348 Otherwise, @var{root} is a list @code{(@var{dir} @var{edges} @var{w1} | |
2349 @var{w2} ...)} where @var{dir} is @code{nil} for a horizontal split, | |
2350 and @code{t} for a vertical split, @var{edges} gives the combined size and | |
2351 position of the subwindows in the split, and the rest of the elements | |
2352 are the subwindows in the split. Each of the subwindows may again be | |
2353 a window or a list representing a window split, and so on. The | |
2354 @var{edges} element is a list @code{(@var{left}@var{ top}@var{ right}@var{ bottom})} | |
2355 similar to the value returned by @code{window-edges}. | |
2356 @end defun | |
2357 | |
2358 @node Window Configurations | |
2359 @section Window Configurations | |
2360 @cindex window configurations | |
2361 @cindex saving window information | |
2362 | |
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 | 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 | 2375 window configuration; see @ref{Frame Configurations}. |
84112 | 2376 |
2377 @defun current-window-configuration &optional frame | |
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 | 2381 @end defun |
2382 | |
2383 @defun set-window-configuration configuration | |
2384 This function restores the configuration of windows and buffers as | |
2385 specified by @var{configuration}, for the frame that @var{configuration} | |
2386 was created for. | |
2387 | |
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 | 2390 restored in the frame from which @var{configuration} was made, whether |
2391 that frame is selected or not. This always counts as a window size | |
2392 change and triggers execution of the @code{window-size-change-functions} | |
2393 (@pxref{Window Hooks}), because @code{set-window-configuration} doesn't | |
2394 know how to tell whether the new configuration actually differs from the | |
2395 old one. | |
2396 | |
2397 If the frame which @var{configuration} was saved from is dead, all this | |
2398 function does is restore the three variables @code{window-min-height}, | |
2399 @code{window-min-width} and @code{minibuffer-scroll-window}. In this | |
2400 case, the function returns @code{nil}. Otherwise, it returns @code{t}. | |
2401 | |
2402 Here is a way of using this function to get the same effect | |
2403 as @code{save-window-excursion}: | |
2404 | |
2405 @example | |
2406 @group | |
2407 (let ((config (current-window-configuration))) | |
2408 (unwind-protect | |
2409 (progn (split-window-vertically nil) | |
2410 @dots{}) | |
2411 (set-window-configuration config))) | |
2412 @end group | |
2413 @end example | |
2414 @end defun | |
2415 | |
2416 @defspec save-window-excursion forms@dots{} | |
2417 This special form records the window configuration, executes @var{forms} | |
2418 in sequence, then restores the earlier window configuration. The window | |
2419 configuration includes, for each window, the value of point and the | |
2420 portion of the buffer that is visible. It also includes the choice of | |
2421 selected window. However, it does not include the value of point in | |
2422 the current buffer; use @code{save-excursion} also, if you wish to | |
2423 preserve that. | |
2424 | |
2425 Don't use this construct when @code{save-selected-window} is sufficient. | |
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 | 2428 @code{window-size-change-functions}. (It doesn't know how to tell |
2429 whether the restored configuration actually differs from the one in | |
2430 effect at the end of the @var{forms}.) | |
2431 | |
2432 The return value is the value of the final form in @var{forms}. | |
2433 For example: | |
2434 | |
2435 @example | |
2436 @group | |
2437 (split-window) | |
2438 @result{} #<window 25 on control.texi> | |
2439 @end group | |
2440 @group | |
2441 (setq w (selected-window)) | |
2442 @result{} #<window 19 on control.texi> | |
2443 @end group | |
2444 @group | |
2445 (save-window-excursion | |
2446 (delete-other-windows w) | |
2447 (switch-to-buffer "foo") | |
2448 'do-something) | |
2449 @result{} do-something | |
2450 ;; @r{The screen is now split again.} | |
2451 @end group | |
2452 @end example | |
2453 @end defspec | |
2454 | |
2455 @defun window-configuration-p object | |
2456 This function returns @code{t} if @var{object} is a window configuration. | |
2457 @end defun | |
2458 | |
2459 @defun compare-window-configurations config1 config2 | |
2460 This function compares two window configurations as regards the | |
2461 structure of windows, but ignores the values of point and mark and the | |
2462 saved scrolling positions---it can return @code{t} even if those | |
2463 aspects differ. | |
2464 | |
2465 The function @code{equal} can also compare two window configurations; it | |
2466 regards configurations as unequal if they differ in any respect, even a | |
2467 saved point or mark. | |
2468 @end defun | |
2469 | |
2470 @defun window-configuration-frame config | |
2471 This function returns the frame for which the window configuration | |
2472 @var{config} was made. | |
2473 @end defun | |
2474 | |
2475 Other primitives to look inside of window configurations would make | |
2476 sense, but are not implemented because we did not need them. See the | |
2477 file @file{winner.el} for some more operations on windows | |
2478 configurations. | |
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 | 2514 @node Window Hooks |
2515 @section Hooks for Window Scrolling and Changes | |
2516 @cindex hooks for window operations | |
2517 | |
2518 This section describes how a Lisp program can take action whenever a | |
2519 window displays a different part of its buffer or a different buffer. | |
2520 There are three actions that can change this: scrolling the window, | |
2521 switching buffers in the window, and changing the size of the window. | |
2522 The first two actions run @code{window-scroll-functions}; the last runs | |
2523 @code{window-size-change-functions}. | |
2524 | |
2525 @defvar window-scroll-functions | |
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 | 2532 |
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 | 2536 |
2537 @strong{Warning:} don't use this feature to alter the way the window | |
2538 is scrolled. It's not designed for that, and such use probably won't | |
2539 work. | |
2540 @end defvar | |
2541 | |
2542 @defvar window-size-change-functions | |
2543 This variable holds a list of functions to be called if the size of any | |
2544 window changes for any reason. The functions are called just once per | |
2545 redisplay, and just once for each frame on which size changes have | |
2546 occurred. | |
2547 | |
2548 Each function receives the frame as its sole argument. There is no | |
2549 direct way to find out which windows on that frame have changed size, or | |
2550 precisely how. However, if a size-change function records, at each | |
2551 call, the existing windows and their sizes, it can also compare the | |
2552 present sizes and the previous sizes. | |
2553 | |
2554 Creating or deleting windows counts as a size change, and therefore | |
2555 causes these functions to be called. Changing the frame size also | |
2556 counts, because it changes the sizes of the existing windows. | |
2557 | |
2558 It is not a good idea to use @code{save-window-excursion} (@pxref{Window | |
2559 Configurations}) in these functions, because that always counts as a | |
2560 size change, and it would cause these functions to be called over and | |
2561 over. In most cases, @code{save-selected-window} (@pxref{Selecting | |
2562 Windows}) is what you need here. | |
2563 @end defvar | |
2564 | |
2565 @defvar window-configuration-change-hook | |
2566 A normal hook that is run every time you change the window configuration | |
2567 of an existing frame. This includes splitting or deleting windows, | |
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 | 2575 @end defvar |
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 | 2582 @ignore |
2583 arch-tag: 3f6c36e8-df49-4986-b757-417feed88be3 | |
2584 @end ignore |