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