Mercurial > emacs
annotate lispref/windows.texi @ 8505:d3f7cadf8c95
*** empty log message ***
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Wed, 10 Aug 1994 06:38:39 +0000 |
parents | 320375e58ee3 |
children | 5d76d6decb35 |
rev | line source |
---|---|
6564 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994 Free Software Foundation, Inc. | |
4 @c See the file elisp.texi for copying conditions. | |
5 @setfilename ../info/windows | |
6 @node Windows, Frames, Buffers, Top | |
7 @chapter Windows | |
8 | |
9 This chapter describes most of the functions and variables related to | |
10 Emacs windows. See @ref{Display}, for information on how text is | |
11 displayed in windows. | |
12 | |
13 @menu | |
14 * Basic Windows:: Basic information on using windows. | |
15 * Splitting Windows:: Splitting one window into two windows. | |
16 * Deleting Windows:: Deleting a window gives its space to other windows. | |
17 * Selecting Windows:: The selected window is the one that you edit in. | |
18 * Cyclic Window Ordering:: Moving around the existing windows. | |
19 * Buffers and Windows:: Each window displays the contents of a buffer. | |
20 * Displaying Buffers:: Higher-lever functions for displaying a buffer | |
21 and choosing a window for it. | |
22 * Choosing Window:: How to choose a window for displaying a buffer. | |
23 * Window Point:: Each window has its own location of point. | |
24 * Window Start:: The display-start position controls which text | |
25 is on-screen in the window. | |
26 * Vertical Scrolling:: Moving text up and down in the window. | |
27 * Horizontal Scrolling:: Moving text sideways on the window. | |
28 * Size of Window:: Accessing the size of a window. | |
29 * Resizing Windows:: Changing the size of a window. | |
30 * Coordinates and Windows::Converting coordinates to windows. | |
31 * Window Configurations:: Saving and restoring the state of the screen. | |
32 @end menu | |
33 | |
34 @node Basic Windows | |
35 @section Basic Concepts of Emacs Windows | |
36 @cindex window | |
37 @cindex selected window | |
38 | |
39 A @dfn{window} is the physical area of the screen in which a buffer is | |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
40 displayed. The term is also used to refer to a Lisp object that |
6564 | 41 represents that screen area in Emacs Lisp. It should be |
42 clear from the context which is meant. | |
43 | |
44 There is always at least one window in any frame. In each frame, at | |
45 any time, one and only one window is designated as @dfn{selected within | |
46 the frame}. The frame's cursor appears in that window. There is also | |
47 one selected frame; and the window selected within that frame is | |
48 @dfn{the selected window}. The selected window's buffer is usually the | |
49 current buffer (except when @code{set-buffer} has been used). | |
50 @xref{Current Buffer}. | |
51 | |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
52 For practical purposes, a window exists only while it is displayed on the |
6564 | 53 terminal. Once removed from the display, the window is effectively |
54 deleted and should not be used, @emph{even though there may still be | |
55 references to it} from other Lisp objects. Restoring a saved window | |
56 configuration is the only way for a window no longer on the screen to | |
57 come back to life. (@xref{Deleting Windows}.) | |
58 | |
59 Each window has the following attributes: | |
60 | |
61 @itemize @bullet | |
62 @item | |
63 containing frame | |
64 | |
65 @item | |
66 window height | |
67 | |
68 @item | |
69 window width | |
70 | |
71 @item | |
72 window edges with respect to the screen or frame | |
73 | |
74 @item | |
75 the buffer it displays | |
76 | |
77 @item | |
78 position within the buffer at the upper left of the window | |
79 | |
80 @item | |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
81 amount of horizontal scrolling, in columns |
6564 | 82 |
83 @item | |
84 point | |
85 | |
86 @item | |
87 the mark | |
88 | |
89 @item | |
90 how recently the window was selected | |
91 @end itemize | |
92 | |
93 @cindex multiple windows | |
94 Users create multiple windows so they can look at several buffers at | |
95 once. Lisp libraries use multiple windows for a variety of reasons, but | |
96 most often to give different views of the same information. In Rmail, | |
97 for example, you can move through a summary buffer in one window while | |
98 the other window shows messages one at a time as they are reached. | |
99 | |
100 The meaning of ``window'' in Emacs is similar to what it means in the | |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
101 context of general-purpose window systems such as X, but not identical. |
6564 | 102 The X Window System subdivides the screen into X windows; Emacs uses one |
103 or more X windows, called @dfn{frames} in Emacs terminology, and | |
104 subdivides each of them into (nonoverlapping) Emacs windows. When you | |
105 use Emacs on an ordinary display terminal, Emacs subdivides the terminal | |
106 screen into Emacs windows. | |
107 | |
108 @cindex terminal screen | |
109 @cindex screen of terminal | |
110 @cindex tiled windows | |
111 Most window systems support arbitrarily located overlapping windows. | |
112 In contrast, Emacs windows are @dfn{tiled}; they never overlap, and | |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
113 together they fill the whole screen or frame. Because of the way |
6564 | 114 in which Emacs creates new windows and resizes them, you can't create |
115 every conceivable tiling of windows on an Emacs frame. @xref{Splitting | |
116 Windows}, and @ref{Size of Window}. | |
117 | |
118 @xref{Display}, for information on how the contents of the | |
119 window's buffer are displayed in the window. | |
120 | |
121 @defun windowp object | |
122 This function returns @code{t} if @var{object} is a window. | |
123 @end defun | |
124 | |
125 @node Splitting Windows | |
126 @section Splitting Windows | |
127 @cindex splitting windows | |
128 @cindex window splitting | |
129 | |
130 The functions described here are the primitives used to split a window | |
131 into two windows. Two higher level functions sometimes split a window, | |
132 but not always: @code{pop-to-buffer} and @code{display-buffer} | |
133 (@pxref{Displaying Buffers}). | |
134 | |
135 The functions described here do not accept a buffer as an argument. | |
136 The two ``halves'' of the split window initially display the same buffer | |
137 previously visible in the window that was split. | |
138 | |
139 @deffn Command split-window &optional window size horizontal | |
140 This function splits @var{window} into two windows. The original | |
141 window @var{window} remains the selected window, but occupies only | |
142 part of its former screen area. The rest is occupied by a newly created | |
143 window which is returned as the value of this function. | |
144 | |
145 If @var{horizontal} is non-@code{nil}, then @var{window} splits into | |
146 two side by side windows. The original window @var{window} keeps the | |
147 leftmost @var{size} columns, and gives the rest of the columns to the | |
148 new window. Otherwise, it splits into windows one above the other, and | |
149 @var{window} keeps the upper @var{size} lines and gives the rest of the | |
150 lines to the new window. The original window is therefore the | |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
151 left-hand or upper of the two, and the new window is the right-hand or |
6564 | 152 lower. |
153 | |
154 If @var{window} is omitted or @code{nil}, then the selected window is | |
155 split. If @var{size} is omitted or @code{nil}, then @var{window} is | |
156 divided evenly into two parts. (If there is an odd line, it is | |
157 allocated to the new window.) When @code{split-window} is called | |
158 interactively, all its arguments are @code{nil}. | |
159 | |
160 The following example starts with one window on a screen that is 50 | |
161 lines high by 80 columns wide; then the window is split. | |
162 | |
163 @smallexample | |
164 @group | |
165 (setq w (selected-window)) | |
166 @result{} #<window 8 on windows.texi> | |
167 (window-edges) ; @r{Edges in order:} | |
168 @result{} (0 0 80 50) ; @r{left--top--right--bottom} | |
169 @end group | |
170 | |
171 @group | |
172 ;; @r{Returns window created} | |
173 (setq w2 (split-window w 15)) | |
174 @result{} #<window 28 on windows.texi> | |
175 @end group | |
176 @group | |
177 (window-edges w2) | |
178 @result{} (0 15 80 50) ; @r{Bottom window;} | |
179 ; @r{top is line 15} | |
180 @end group | |
181 @group | |
182 (window-edges w) | |
183 @result{} (0 0 80 15) ; @r{Top window} | |
184 @end group | |
185 @end smallexample | |
186 | |
187 The screen looks like this: | |
188 | |
189 @smallexample | |
190 @group | |
191 __________ | |
192 | | line 0 | |
193 | w | | |
194 |__________| | |
195 | | line 15 | |
196 | w2 | | |
197 |__________| | |
198 line 50 | |
199 column 0 column 80 | |
200 @end group | |
201 @end smallexample | |
202 | |
203 Next, the top window is split horizontally: | |
204 | |
205 @smallexample | |
206 @group | |
207 (setq w3 (split-window w 35 t)) | |
208 @result{} #<window 32 on windows.texi> | |
209 @end group | |
210 @group | |
211 (window-edges w3) | |
212 @result{} (35 0 80 15) ; @r{Left edge at column 35} | |
213 @end group | |
214 @group | |
215 (window-edges w) | |
216 @result{} (0 0 35 15) ; @r{Right edge at column 35} | |
217 @end group | |
218 @group | |
219 (window-edges w2) | |
220 @result{} (0 15 80 50) ; @r{Bottom window unchanged} | |
221 @end group | |
222 @end smallexample | |
223 | |
224 Now, the screen looks like this: | |
225 | |
226 @smallexample | |
227 @group | |
228 column 35 | |
229 __________ | |
230 | | | line 0 | |
231 | w | w3 | | |
232 |___|______| | |
233 | | line 15 | |
234 | w2 | | |
235 |__________| | |
236 line 50 | |
237 column 0 column 80 | |
238 @end group | |
239 @end smallexample | |
240 @end deffn | |
241 | |
242 @deffn Command split-window-vertically size | |
243 This function splits the selected window into two windows, one above | |
244 the other, leaving the selected window with @var{size} lines. | |
245 | |
246 This function is simply an interface to @code{split-windows}. | |
247 Here is the complete function definition for it: | |
248 | |
249 @smallexample | |
250 @group | |
251 (defun split-window-vertically (&optional arg) | |
252 "Split current window into two windows, one above the other." | |
253 (interactive "P") | |
254 (split-window nil (and arg (prefix-numeric-value arg)))) | |
255 @end group | |
256 @end smallexample | |
257 @end deffn | |
258 | |
259 @deffn Command split-window-horizontally size | |
260 This function splits the selected window into two windows | |
261 side-by-side, leaving the selected window with @var{size} columns. | |
262 | |
263 This function is simply an interface to @code{split-windows}. Here is | |
264 the complete definition for @code{split-window-horizontally} (except for | |
265 part of the documentation string): | |
266 | |
267 @smallexample | |
268 @group | |
269 (defun split-window-horizontally (&optional arg) | |
270 "Split selected window into two windows, side by side..." | |
271 (interactive "P") | |
272 (split-window nil (and arg (prefix-numeric-value arg)) t)) | |
273 @end group | |
274 @end smallexample | |
275 @end deffn | |
276 | |
277 @defun one-window-p &optional no-mini all-frames | |
278 This function returns non-@code{nil} if there is only one window. The | |
279 argument @var{no-mini}, if non-@code{nil}, means don't count the | |
280 minibuffer even if it is active; otherwise, the minibuffer window is | |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
281 included, if active, in the total number of windows, which is compared |
6564 | 282 against one. |
283 | |
284 The argument @var{all-frames} specifies which frames to consider. Here | |
285 are the possible values and their meanings: | |
286 | |
287 @table @asis | |
288 @item @code{nil} | |
289 Count the windows in the selected frame, plus the minibuffer used | |
290 by that frame even if it lies in some other frame. | |
291 | |
292 @item @code{t} | |
293 Count all windows in all existing frames. | |
294 | |
295 @item @code{visible} | |
296 Count all windows in all visible frames. | |
297 | |
298 @item anything else | |
299 Count precisely the windows in the selected frame, and no others. | |
300 @end table | |
301 @end defun | |
302 | |
303 @node Deleting Windows | |
304 @section Deleting Windows | |
305 @cindex deleting windows | |
306 | |
307 A window remains visible on its frame unless you @dfn{delete} it by | |
308 calling certain functions that delete windows. A deleted window cannot | |
309 appear on the screen, but continues to exist as a Lisp object until | |
310 there are no references to it. There is no way to cancel the deletion | |
311 of a window aside from restoring a saved window configuration | |
312 (@pxref{Window Configurations}). Restoring a window configuration also | |
313 deletes any windows that aren't part of that configuration. | |
314 | |
315 When you delete a window, the space it took up is given to one | |
316 adjacent sibling. (In Emacs version 18, the space was divided evenly | |
317 among all the siblings.) | |
318 | |
319 @c Emacs 19 feature | |
320 @defun window-live-p window | |
321 This function returns @code{nil} if @var{window} is deleted, and | |
322 @code{t} otherwise. | |
323 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7082
diff
changeset
|
324 @strong{Warning:} Erroneous information or fatal errors may result from |
6564 | 325 using a deleted window as if it were live. |
326 @end defun | |
327 | |
328 @deffn Command delete-window &optional window | |
329 This function removes @var{window} from the display. If @var{window} | |
330 is omitted, then the selected window is deleted. An error is signaled | |
331 if there is only one window when @code{delete-window} is called. | |
332 | |
333 This function returns @code{nil}. | |
334 | |
335 When @code{delete-window} is called interactively, @var{window} | |
336 defaults to the selected window. | |
337 @end deffn | |
338 | |
339 @deffn Command delete-other-windows &optional window | |
340 This function makes @var{window} the only window on its frame, by | |
341 deleting the other windows in that frame. If @var{window} is omitted or | |
342 @code{nil}, then the selected window is used by default. | |
343 | |
344 The result is @code{nil}. | |
345 @end deffn | |
346 | |
347 @deffn Command delete-windows-on buffer &optional frame | |
348 This function deletes all windows showing @var{buffer}. If there are | |
349 no windows showing @var{buffer}, it does nothing. | |
350 | |
351 @code{delete-windows-on} operates frame by frame. If a frame has | |
352 several windows showing different buffers, then those showing | |
353 @var{buffer} are removed, and the others expand to fill the space. If | |
354 all windows in some frame are showing @var{buffer} (including the case | |
355 where there is only one window), then the frame reverts to having a | |
356 single window showing another buffer chosen with @code{other-buffer}. | |
357 @xref{The Buffer List}. | |
358 | |
359 The argument @var{frame} controls which frames to operate on: | |
360 | |
361 @itemize @bullet | |
362 @item | |
363 If it is @code{nil}, operate on the selected frame. | |
364 @item | |
365 If it is @code{t}, operate on all frames. | |
366 @item | |
367 If it is @code{visible}, operate on all visible frames. | |
368 @item | |
369 If it is a frame, operate on that frame. | |
370 @end itemize | |
371 | |
372 This function always returns @code{nil}. | |
373 @end deffn | |
374 | |
375 @node Selecting Windows | |
376 @section Selecting Windows | |
377 @cindex selecting windows | |
378 | |
379 When a window is selected, the buffer in the window becomes the current | |
380 buffer, and the cursor will appear in it. | |
381 | |
382 @defun selected-window | |
383 This function returns the selected window. This is the window in | |
384 which the cursor appears and to which many commands apply. | |
385 @end defun | |
386 | |
387 @defun select-window window | |
388 This function makes @var{window} the selected window. The cursor then | |
389 appears in @var{window} (on redisplay). The buffer being displayed in | |
390 @var{window} is immediately designated the current buffer. | |
391 | |
392 The return value is @var{window}. | |
393 | |
394 @example | |
395 @group | |
396 (setq w (next-window)) | |
397 (select-window w) | |
398 @result{} #<window 65 on windows.texi> | |
399 @end group | |
400 @end example | |
401 @end defun | |
402 | |
403 @cindex finding windows | |
404 The following functions choose one of the windows on the screen, | |
405 offering various criteria for the choice. | |
406 | |
407 @defun get-lru-window &optional frame | |
408 This function returns the window least recently ``used'' (that is, | |
409 selected). The selected window is always the most recently used window. | |
410 | |
411 The selected window can be the least recently used window if it is the | |
412 only window. A newly created window becomes the least recently used | |
413 window until it is selected. A minibuffer window is never a candidate. | |
414 | |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
415 The argument @var{frame} controls which windows are considered. |
6564 | 416 |
417 @itemize @bullet | |
418 @item | |
419 If it is @code{nil}, consider windows on the selected frame. | |
420 @item | |
421 If it is @code{t}, consider windows on all frames. | |
422 @item | |
423 If it is @code{visible}, consider windows on all visible frames. | |
424 @item | |
425 If it is a frame, consider windows on that frame. | |
426 @end itemize | |
427 @end defun | |
428 | |
429 @defun get-largest-window &optional frame | |
430 This function returns the window with the largest area (height times | |
431 width). If there are no side-by-side windows, then this is the window | |
432 with the most lines. A minibuffer window is never a candidate. | |
433 | |
434 If there are two windows of the same size, then the function returns | |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
435 the window that is first in the cyclic ordering of windows (see |
6564 | 436 following section), starting from the selected window. |
437 | |
438 The argument @var{frame} controls which set of windows are | |
439 considered. See @code{get-lru-window}, above. | |
440 @end defun | |
441 | |
442 @node Cyclic Window Ordering | |
443 @comment node-name, next, previous, up | |
444 @section Cyclic Ordering of Windows | |
445 @cindex cyclic ordering of windows | |
446 @cindex ordering of windows, cyclic | |
447 @cindex window ordering, cyclic | |
448 | |
449 When you use the command @kbd{C-x o} (@code{other-window}) to select | |
450 the next window, it moves through all the windows on the screen in a | |
451 specific cyclic order. For any given configuration of windows, this | |
452 order never varies. It is called the @dfn{cyclic ordering of windows}. | |
453 | |
454 This ordering generally goes from top to bottom, and from left to | |
455 right. But it may go down first or go right first, depending on the | |
456 order in which the windows were split. | |
457 | |
458 If the first split was vertical (into windows one above each other), | |
459 and then the subwindows were split horizontally, then the ordering is | |
460 left to right in the top of the frame, and then left to right in the | |
461 next lower part of the frame, and so on. If the first split was | |
462 horizontal, the ordering is top to bottom in the left part, and so on. | |
463 In general, within each set of siblings at any level in the window tree, | |
464 the order is left to right, or top to bottom. | |
465 | |
466 @defun next-window &optional window minibuf all-frames | |
467 @cindex minibuffer window | |
468 This function returns the window following @var{window} in the cyclic | |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
469 ordering of windows. This is the window that @kbd{C-x o} would select |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
470 if typed when @var{window} is selected. If @var{window} is the only |
6564 | 471 window visible, then this function returns @var{window}. If omitted, |
472 @var{window} defaults to the selected window. | |
473 | |
474 The value of the argument @var{minibuf} determines whether the | |
475 minibuffer is included in the window order. Normally, when | |
476 @var{minibuf} is @code{nil}, the minibuffer is included if it is | |
477 currently active; this is the behavior of @kbd{C-x o}. (The minibuffer | |
478 window is active while the minibuffer is in use. @xref{Minibuffers}.) | |
479 | |
480 If @var{minibuf} is @code{t}, then the cyclic ordering includes the | |
481 minibuffer window even if it is not active. | |
482 | |
483 If @var{minibuf} is neither @code{t} nor @code{nil}, then the minibuffer | |
484 window is not included even if it is active. | |
485 | |
486 The argument @var{all-frames} specifies which frames to consider. Here | |
487 are the possible values and their meanings: | |
488 | |
489 @table @asis | |
490 @item @code{nil} | |
491 Consider all the windows in @var{window}'s frame, plus the minibuffer | |
492 used by that frame even if it lies in some other frame. | |
493 | |
494 @item @code{t} | |
495 Consider all windows in all existing frames. | |
496 | |
497 @item @code{visible} | |
498 Consider all windows in all visible frames. (To get useful results, you | |
499 must ensure @var{window} is in a visible frame.) | |
500 | |
501 @item anything else | |
502 Consider precisely the windows in @var{window}'s frame, and no others. | |
503 @end table | |
504 | |
505 This example assumes there are two windows, both displaying the | |
506 buffer @samp{windows.texi}: | |
507 | |
508 @example | |
509 @group | |
510 (selected-window) | |
511 @result{} #<window 56 on windows.texi> | |
512 @end group | |
513 @group | |
514 (next-window (selected-window)) | |
515 @result{} #<window 52 on windows.texi> | |
516 @end group | |
517 @group | |
518 (next-window (next-window (selected-window))) | |
519 @result{} #<window 56 on windows.texi> | |
520 @end group | |
521 @end example | |
522 @end defun | |
523 | |
524 @defun previous-window &optional window minibuf all-frames | |
525 This function returns the window preceding @var{window} in the cyclic | |
526 ordering of windows. The other arguments specify which windows to | |
527 include in the cycle, as in @code{next-window}. | |
528 @end defun | |
529 | |
530 @deffn Command other-window count | |
531 This function selects the @var{count}th following window in the cyclic | |
532 order. If count is negative, then it selects the @minus{}@var{count}th | |
533 preceding window. It returns @code{nil}. | |
534 | |
535 In an interactive call, @var{count} is the numeric prefix argument. | |
536 @end deffn | |
537 | |
538 @c Emacs 19 feature | |
539 @defun walk-windows proc &optional minibuf all-frames | |
540 This function cycles through all windows, calling @code{proc} | |
541 once for each window with the window as its sole argument. | |
542 | |
543 The optional arguments @var{minibuf} and @var{all-frames} specify the | |
544 set of windows to include in the scan. See @code{next-window}, above, | |
545 for details. | |
546 @end defun | |
547 | |
548 @node Buffers and Windows | |
549 @section Buffers and Windows | |
550 @cindex examining windows | |
551 @cindex windows, controlling precisely | |
552 @cindex buffers, controlled in windows | |
553 | |
554 This section describes low-level functions to examine windows or to | |
555 display buffers in windows in a precisely controlled fashion. | |
556 @iftex | |
557 See the following section for | |
558 @end iftex | |
559 @ifinfo | |
560 @xref{Displaying Buffers}, for | |
561 @end ifinfo | |
562 related functions that find a window to use and specify a buffer for it. | |
563 The functions described there are easier to use than these, but they | |
564 employ heuristics in choosing or creating a window; use these functions | |
565 when you need complete control. | |
566 | |
567 @defun set-window-buffer window buffer-or-name | |
568 This function makes @var{window} display @var{buffer-or-name} as its | |
569 contents. It returns @code{nil}. | |
570 | |
571 @example | |
572 @group | |
573 (set-window-buffer (selected-window) "foo") | |
574 @result{} nil | |
575 @end group | |
576 @end example | |
577 @end defun | |
578 | |
579 @defun window-buffer &optional window | |
580 This function returns the buffer that @var{window} is displaying. If | |
581 @var{window} is omitted, this function returns the buffer for the | |
582 selected window. | |
583 | |
584 @example | |
585 @group | |
586 (window-buffer) | |
587 @result{} #<buffer windows.texi> | |
588 @end group | |
589 @end example | |
590 @end defun | |
591 | |
592 @defun get-buffer-window buffer-or-name &optional all-frames | |
593 This function returns a window currently displaying | |
594 @var{buffer-or-name}, or @code{nil} if there is none. If there are | |
595 several such windows, then the function returns the first one in the | |
596 cyclic ordering of windows, starting from the selected window. | |
597 @xref{Cyclic Window Ordering}. | |
598 | |
599 The argument @var{all-frames} controls which windows to consider. | |
600 | |
601 @itemize @bullet | |
602 @item | |
603 If it is @code{nil}, consider windows on the selected frame. | |
604 @item | |
605 If it is @code{t}, consider windows on all frames. | |
606 @item | |
607 If it is @code{visible}, consider windows on all visible frames. | |
608 @item | |
609 If it is a frame, consider windows on that frame. | |
610 @end itemize | |
611 @end defun | |
612 | |
613 @deffn Command replace-buffer-in-windows buffer | |
614 This function replaces @var{buffer} with some other buffer in all | |
615 windows displaying it. The other buffer used is chosen with | |
616 @code{other-buffer}. In the usual applications of this function, you | |
617 don't care which other buffer is used; you just want to make sure that | |
618 @var{buffer} is no longer displayed. | |
619 | |
620 This function returns @code{nil}. | |
621 @end deffn | |
622 | |
623 @node Displaying Buffers | |
624 @section Displaying Buffers in Windows | |
625 @cindex switching to a buffer | |
626 @cindex displaying a buffer | |
627 | |
628 In this section we describe convenient functions that choose a window | |
629 automatically and use it to display a specified buffer. These functions | |
630 can also split an existing window in certain circumstances. We also | |
631 describe variables that parameterize the heuristics used for choosing a | |
632 window. | |
633 @iftex | |
634 See the preceding section for | |
635 @end iftex | |
636 @ifinfo | |
637 @xref{Buffers and Windows}, for | |
638 @end ifinfo | |
639 low-level functions that give you more precise control. | |
640 | |
641 Do not use the functions in this section in order to make a buffer | |
642 current so that a Lisp program can access or modify it; they are too | |
643 drastic for that purpose, since they change the display of buffers in | |
644 windows, which is gratuitous and will surprise the user. Instead, use | |
645 @code{set-buffer} (@pxref{Current Buffer}) and @code{save-excursion} | |
646 (@pxref{Excursions}), which designate buffers as current for programmed | |
647 access without affecting the display of buffers in windows. | |
648 | |
649 @deffn Command switch-to-buffer buffer-or-name &optional norecord | |
650 This function makes @var{buffer-or-name} the current buffer, and also | |
651 displays the buffer in the selected window. This means that a human can | |
652 see the buffer and subsequent keyboard commands will apply to it. | |
653 Contrast this with @code{set-buffer}, which makes @var{buffer-or-name} | |
654 the current buffer but does not display it in the selected window. | |
655 @xref{Current Buffer}. | |
656 | |
657 If @var{buffer-or-name} does not identify an existing buffer, then | |
658 a new buffer by that name is created. | |
659 | |
660 Normally the specified buffer is put at the front of the buffer list. | |
661 This affects the operation of @code{other-buffer}. However, if | |
662 @var{norecord} is non-@code{nil}, this is not done. @xref{The Buffer | |
663 List}. | |
664 | |
665 The @code{switch-to-buffer} function is often used interactively, as | |
666 the binding of @kbd{C-x b}. It is also used frequently in programs. It | |
667 always returns @code{nil}. | |
668 @end deffn | |
669 | |
670 @deffn Command switch-to-buffer-other-window buffer-or-name | |
671 This function makes @var{buffer-or-name} the current buffer and | |
672 displays it in a window not currently selected. It then selects that | |
673 window. The handling of the buffer is the same as in | |
674 @code{switch-to-buffer}. | |
675 | |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
676 The currently selected window is absolutely never used to do the job. |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
677 If it is the only window, then it is split to make a distinct window for |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
678 this purpose. If the selected window is already displaying the buffer, |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
679 then it continues to do so, but another window is nonetheless found to |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
680 display it in as well. |
6564 | 681 @end deffn |
682 | |
683 @defun pop-to-buffer buffer-or-name &optional other-window | |
684 This function makes @var{buffer-or-name} the current buffer and | |
685 switches to it in some window, preferably not the window previously | |
686 selected. The ``popped-to'' window becomes the selected window within | |
687 its frame. | |
688 | |
689 If the variable @code{pop-up-frames} is non-@code{nil}, | |
690 @code{pop-to-buffer} looks for a window in any visible frame already | |
691 displaying the buffer; if there is one, it returns that window and makes | |
692 it be selected within its frame. If there is none, it creates a new | |
693 frame and displays the buffer in it. | |
694 | |
695 If @code{pop-up-frames} is @code{nil}, then @code{pop-to-buffer} | |
696 operates entirely within the selected frame. (If the selected frame has | |
697 just a minibuffer, @code{pop-to-buffer} operates within the most | |
698 recently selected frame that was not just a minibuffer.) | |
699 | |
700 If the variable @code{pop-up-windows} is non-@code{nil}, windows may | |
701 be split to create a new window that is different from the original | |
702 window. For details, see @ref{Choosing Window}. | |
703 | |
704 If @var{other-window} is non-@code{nil}, @code{pop-to-buffer} finds or | |
705 creates another window even if @var{buffer-or-name} is already visible | |
706 in the selected window. Thus @var{buffer-or-name} could end up | |
707 displayed in two windows. On the other hand, if @var{buffer-or-name} is | |
708 already displayed in the selected window and @var{other-window} is | |
709 @code{nil}, then the selected window is considered sufficient display | |
710 for @var{buffer-or-name}, so that nothing needs to be done. | |
711 | |
712 If @var{buffer-or-name} is a string that does not name an existing | |
713 buffer, a buffer by that name is created. | |
714 @end defun | |
715 | |
716 @node Choosing Window | |
717 @section Choosing a Window for Display | |
718 | |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
719 This section describes the basic facility that chooses a window to |
6564 | 720 display a buffer in---@code{display-buffer}. All the higher-level |
721 functions and commands use this subroutine. Here we describe how to use | |
722 @code{display-buffer} and how to customize it. | |
723 | |
724 @deffn Command display-buffer buffer-or-name &optional not-this-window | |
725 This command makes @var{buffer-or-name} appear in some window, like | |
726 @code{pop-to-buffer}, but it does not select that window and does not | |
727 make the buffer current. The identity of the selected window is | |
728 unaltered by this function. | |
729 | |
730 If @var{not-this-window} is non-@code{nil}, it means to display the | |
731 specified buffer in a window other than the selected one, even if it is | |
732 already on display in the selected window. This can cause the buffer to | |
733 appear in two windows at once. Otherwise, if @var{buffer-or-name} is | |
734 already being displayed in any window, that is good enough, so this | |
735 function does nothing. | |
736 | |
737 @code{display-buffer} returns the window chosen to display | |
738 @var{buffer-or-name}. | |
739 | |
740 Precisely how @code{display-buffer} finds or creates a window depends on | |
741 the variables described below. | |
742 @end deffn | |
743 | |
744 @defopt pop-up-windows | |
745 This variable controls whether @code{display-buffer} makes new windows. | |
746 If it is non-@code{nil} and there is only one window, then that window | |
747 is split. If it is @code{nil}, then @code{display-buffer} does not | |
748 split the single window, but uses it whole. | |
749 @end defopt | |
750 | |
751 @defopt split-height-threshold | |
752 This variable determines when @code{display-buffer} may split a window, | |
753 if there are multiple windows. @code{display-buffer} always splits the | |
754 largest window if it has at least this many lines. If the largest | |
755 window is not this tall, it is split only if it is the sole window and | |
756 @code{pop-up-windows} is non-@code{nil}. | |
757 @end defopt | |
758 | |
759 @c Emacs 19 feature | |
760 @defopt pop-up-frames | |
761 This variable controls whether @code{display-buffer} makes new frames. | |
762 If it is non-@code{nil}, @code{display-buffer} looks for an existing | |
763 window already displaying the desired buffer, on any visible frame. If | |
764 it finds one, it returns that window. Otherwise it makes a new frame. | |
765 The variables @code{pop-up-windows} and @code{split-height-threshold} do | |
766 not matter if @code{pop-up-frames} is non-@code{nil}. | |
767 | |
768 If @code{pop-up-frames} is @code{nil}, then @code{display-buffer} either | |
769 splits a window or reuses one. | |
770 | |
771 @xref{Frames}, for more information. | |
772 @end defopt | |
773 | |
774 @c Emacs 19 feature | |
775 @defvar pop-up-frame-function | |
776 This variable specifies how to make a new frame if @code{pop-up-frames} | |
777 is non-@code{nil}. | |
778 | |
779 Its value should be a function of no arguments. When | |
780 @code{display-buffer} makes a new frame, it does so by calling that | |
781 function, which should return a frame. The default value of the | |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
782 variable is a function that creates a frame using parameters from |
6564 | 783 @code{pop-up-frame-alist}. |
784 @end defvar | |
785 | |
786 @defvar pop-up-frame-alist | |
787 This variable holds an alist specifying frame parameters used when | |
788 @code{display-buffer} makes a new frame. @xref{Frame Parameters}, for | |
789 more information about frame parameters. | |
790 @end defvar | |
791 | |
7082
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
792 @defvar special-display-buffer-names |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
793 A list of buffer names for buffers that should be displayed specially. |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
794 If the buffer's name is in this list, @code{display-buffer} handles the |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
795 buffer specially. |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
796 |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
797 By default, special display means to give the buffer a dedicated frame. |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
798 @end defvar |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
799 |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
800 @defvar special-display-regexps |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
801 A list of regular expressions that specify buffers that should be |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
802 displayed specially. If the buffer's name matches any of the regular |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
803 expressions in this list, @code{display-buffer} handles the buffer |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
804 specially. |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
805 |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
806 By default, special display means to give the buffer a dedicated frame. |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
807 @end defvar |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
808 |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
809 @defvar special-display-function |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
810 This variable holds the function to call to display a buffer specially. |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
811 It receives the buffer as an argument, and should return the window in |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
812 which it is displayed. |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
813 |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
814 The default value of this variable is |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
815 @code{special-display-popup-frame}. |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
816 @end defvar |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
817 |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
818 @defun special-display-popup-frame buffer |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
819 This function makes @var{buffer} visible in a frame of its own. If |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
820 @var{buffer} is already displayed in a window in some frame, it makes |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
821 the frame visible and raises it, to use that window. Otherwise, it |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
822 creates a frame that will be dedicated to @var{buffer}. |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
823 |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
824 This function uses an existing window displaying @var{buffer} whether or |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
825 not it is in a frame of its own; but if you set up the above variables |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
826 in your init file, before @var{buffer} was created, then presumably the |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
827 window was previously made by this function. |
7082
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
828 @end defun |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
829 |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
830 @defopt special-display-frame-alist |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
831 This variable holds frame parameters for |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
832 @code{special-display-popup-frame} to use when it creates a frame. |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
833 @end defopt |
70b62e9d773b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
834 |
6564 | 835 @c Emacs 19 feature |
836 @defvar display-buffer-function | |
837 This variable is the most flexible way to customize the behavior of | |
838 @code{display-buffer}. If it is non-@code{nil}, it should be a function | |
839 that @code{display-buffer} calls to do the work. The function should | |
840 accept two arguments, the same two arguments that @code{display-buffer} | |
841 received. It should choose or create a window, display the specified | |
842 buffer, and then return the window. | |
843 | |
844 This hook takes precedence over all the other options and hooks | |
845 described above. | |
846 @end defvar | |
847 | |
848 @c Emacs 19 feature | |
849 @cindex dedicated window | |
850 A window can be marked as ``dedicated'' to its buffer. Then | |
851 @code{display-buffer} does not try to use that window. | |
852 | |
853 @defun window-dedicated-p window | |
854 This function returns @code{t} if @var{window} is marked as dedicated; | |
855 otherwise @code{nil}. | |
856 @end defun | |
857 | |
858 @defun set-window-dedicated-p window flag | |
859 This function marks @var{window} as dedicated if @var{flag} is | |
860 non-@code{nil}, and nondedicated otherwise. | |
861 @end defun | |
862 | |
863 @node Window Point | |
864 @section Windows and Point | |
865 @cindex window position | |
866 @cindex window point | |
867 @cindex position in window | |
868 @cindex point in window | |
869 | |
870 Each window has its own value of point, independent of the value of | |
871 point in other windows displaying the same buffer. This makes it useful | |
872 to have multiple windows showing one buffer. | |
873 | |
874 @itemize @bullet | |
875 @item | |
876 The window point is established when a window is first created; it is | |
877 initialized from the buffer's point, or from the window point of another | |
878 window opened on the buffer if such a window exists. | |
879 | |
880 @item | |
881 Selecting a window sets the value of point in its buffer to the window's | |
882 value of point. Conversely, deselecting a window sets the window's | |
883 value of point from that of the buffer. Thus, when you switch between | |
884 windows that display a given buffer, the point value for the selected | |
885 window is in effect in the buffer, while the point values for the other | |
886 windows are stored in those windows. | |
887 | |
888 @item | |
889 As long as the selected window displays the current buffer, the window's | |
890 point and the buffer's point always move together; they remain equal. | |
891 | |
892 @item | |
893 @xref{Positions}, for more details on buffer positions. | |
894 @end itemize | |
895 | |
896 As far as the user is concerned, point is where the cursor is, and | |
897 when the user switches to another buffer, the cursor jumps to the | |
898 position of point in that buffer. | |
899 | |
900 @defun window-point window | |
901 This function returns the current position of point in @var{window}. | |
902 For a nonselected window, this is the value point would have (in that | |
903 window's buffer) if that window were selected. | |
904 | |
905 When @var{window} is the selected window and its buffer is also the | |
906 current buffer, the value returned is the same as point in that buffer. | |
907 | |
908 Strictly speaking, it would be more correct to return the | |
909 ``top-level'' value of point, outside of any @code{save-excursion} | |
910 forms. But that value is hard to find. | |
911 @end defun | |
912 | |
913 @defun set-window-point window position | |
914 This function positions point in @var{window} at position | |
915 @var{position} in @var{window}'s buffer. | |
916 @end defun | |
917 | |
918 @node Window Start | |
919 @section The Window Start Position | |
920 | |
921 Each window contains a marker used to keep track of a buffer position | |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
922 that specifies where in the buffer display should start. This position |
6564 | 923 is called the @dfn{display-start} position of the window (or just the |
924 @dfn{start}). The character after this position is the one that appears | |
925 at the upper left corner of the window. It is usually, but not | |
926 inevitably, at the beginning of a text line. | |
927 | |
928 @defun window-start &optional window | |
929 @cindex window top line | |
930 This function returns the display-start position of window | |
931 @var{window}. If @var{window} is @code{nil}, the selected window is | |
932 used. For example, | |
933 | |
934 @example | |
935 @group | |
936 (window-start) | |
937 @result{} 7058 | |
938 @end group | |
939 @end example | |
940 | |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
941 When you create a window, or display a different buffer in it, the |
6564 | 942 display-start position is set to a display-start position recently used |
943 for the same buffer, or 1 if the buffer doesn't have any. | |
944 | |
945 For a realistic example, see the description of @code{count-lines} in | |
946 @ref{Text Lines}. | |
947 @end defun | |
948 | |
949 @defun window-end &optional window | |
950 This function returns the position of the end of the display in window | |
951 @var{window}. If @var{window} is @code{nil}, the selected window is | |
952 used. | |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
953 |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
954 If the last redisplay of @var{window} was preempted, and did not finish, |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
955 Emacs does not know the position of the end of display in that window; |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
956 in that case, this function returns @code{nil}. You can compute where |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
957 the end of the window @emph{would} have been, if redisplay had finished, |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
958 like this: |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
959 |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
960 @example |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
961 (save-excursion |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
962 (goto-char (window-start window)) |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
963 (vertical-motion (1- (window-height window)) |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
964 window) |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
965 (point)) |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
966 @end example |
6564 | 967 @end defun |
968 | |
969 @defun set-window-start window position &optional noforce | |
970 This function sets the display-start position of @var{window} to | |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
971 @var{position} in @var{window}'s buffer. It returns @var{position}. |
6564 | 972 |
973 The display routines insist that the position of point be visible when a | |
974 buffer is displayed. Normally, they change the display-start position | |
975 (that is, scroll the window) whenever necessary to make point visible. | |
976 However, if you specify the start position with this function using | |
977 @code{nil} for @var{noforce}, it means you want display to start at | |
978 @var{position} even if that would put the location of point off the | |
979 screen. If this does place point off screen, the display routines move | |
980 point to the left margin on the middle line in the window. | |
981 | |
982 For example, if point @w{is 1} and you set the start of the window @w{to | |
983 2}, then point would be ``above'' the top of the window. The display | |
984 routines will automatically move point if it is still 1 when redisplay | |
985 occurs. Here is an example: | |
986 | |
987 @example | |
988 @group | |
989 ;; @r{Here is what @samp{foo} looks like before executing} | |
990 ;; @r{the @code{set-window-start} expression.} | |
991 @end group | |
992 | |
993 @group | |
994 ---------- Buffer: foo ---------- | |
995 @point{}This is the contents of buffer foo. | |
996 2 | |
997 3 | |
998 4 | |
999 5 | |
1000 6 | |
1001 ---------- Buffer: foo ---------- | |
1002 @end group | |
1003 | |
1004 @group | |
1005 (set-window-start | |
1006 (selected-window) | |
1007 (1+ (window-start))) | |
1008 @result{} 2 | |
1009 @end group | |
1010 | |
1011 @group | |
1012 ;; @r{Here is what @samp{foo} looks like after executing} | |
1013 ;; @r{the @code{set-window-start} expression.} | |
1014 ---------- Buffer: foo ---------- | |
1015 his is the contents of buffer foo. | |
1016 2 | |
1017 3 | |
1018 @point{}4 | |
1019 5 | |
1020 6 | |
1021 ---------- Buffer: foo ---------- | |
1022 @end group | |
1023 @end example | |
1024 | |
1025 If @var{noforce} is non-@code{nil}, and @var{position} would place point | |
1026 off screen at the next redisplay, then redisplay computes a new window-start | |
1027 position that works well with point, and thus @var{position} is not used. | |
1028 @end defun | |
1029 | |
1030 @defun pos-visible-in-window-p &optional position window | |
1031 This function returns @code{t} if @var{position} is within the range | |
1032 of text currently visible on the screen in @var{window}. It returns | |
1033 @code{nil} if @var{position} is scrolled vertically out of view. The | |
1034 argument @var{position} defaults to the current position of point; | |
1035 @var{window}, to the selected window. Here is an example: | |
1036 | |
1037 @example | |
1038 @group | |
1039 (or (pos-visible-in-window-p | |
1040 (point) (selected-window)) | |
1041 (recenter 0)) | |
1042 @end group | |
1043 @end example | |
1044 | |
1045 The @code{pos-visible-in-window-p} function considers only vertical | |
1046 scrolling. If @var{position} is out of view only because @var{window} | |
1047 has been scrolled horizontally, @code{pos-visible-in-window-p} returns | |
1048 @code{t}. @xref{Horizontal Scrolling}. | |
1049 @end defun | |
1050 | |
1051 @node Vertical Scrolling | |
1052 @section Vertical Scrolling | |
1053 @cindex vertical scrolling | |
1054 @cindex scrolling vertically | |
1055 | |
1056 Vertical scrolling means moving the text up or down in a window. It | |
1057 works by changing the value of the window's display-start location. It | |
1058 may also change the value of @code{window-point} to keep it on the | |
1059 screen. | |
1060 | |
1061 In the commands @code{scroll-up} and @code{scroll-down}, the directions | |
1062 ``up'' and ``down'' refer to the motion of the text in the buffer at which | |
1063 you are looking through the window. Imagine that the text is | |
1064 written on a long roll of paper and that the scrolling commands move the | |
1065 paper up and down. Thus, if you are looking at text in the middle of a | |
1066 buffer and repeatedly call @code{scroll-down}, you will eventually see | |
1067 the beginning of the buffer. | |
1068 | |
1069 Some people have urged that the opposite convention be used: they | |
1070 imagine that the window moves over text that remains in place. Then | |
1071 ``down'' commands would take you to the end of the buffer. This view is | |
1072 more consistent with the actual relationship between windows and the | |
1073 text in the buffer, but it is less like what the user sees. The | |
1074 position of a window on the terminal does not move, and short scrolling | |
1075 commands clearly move the text up or down on the screen. We have chosen | |
1076 names that fit the user's point of view. | |
1077 | |
1078 The scrolling functions (aside from @code{scroll-other-window}) have | |
1079 unpredictable results if the current buffer is different from the buffer | |
1080 that is displayed in the selected window. @xref{Current Buffer}. | |
1081 | |
1082 @deffn Command scroll-up &optional count | |
1083 This function scrolls the text in the selected window upward | |
1084 @var{count} lines. If @var{count} is negative, scrolling is actually | |
1085 downward. | |
1086 | |
1087 If @var{count} is @code{nil} (or omitted), then the length of scroll | |
1088 is @code{next-screen-context-lines} lines less than the usable height of | |
1089 the window (not counting its mode line). | |
1090 | |
1091 @code{scroll-up} returns @code{nil}. | |
1092 @end deffn | |
1093 | |
1094 @deffn Command scroll-down &optional count | |
1095 This function scrolls the text in the selected window downward | |
1096 @var{count} lines. If @var{count} is negative, scrolling is actually | |
1097 upward. | |
1098 | |
1099 If @var{count} is omitted or @code{nil}, then the length of the scroll | |
1100 is @code{next-screen-context-lines} lines less than the usable height of | |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1101 the window (not counting its mode line). |
6564 | 1102 |
1103 @code{scroll-down} returns @code{nil}. | |
1104 @end deffn | |
1105 | |
1106 @deffn Command scroll-other-window &optional count | |
1107 This function scrolls the text in another window upward @var{count} | |
1108 lines. Negative values of @var{count}, or @code{nil}, are handled | |
1109 as in @code{scroll-up}. | |
1110 | |
1111 The window that is scrolled is normally the one following the selected | |
1112 window in the cyclic ordering of windows---the window that | |
1113 @code{next-window} would return. @xref{Cyclic Window Ordering}. | |
1114 | |
1115 You can specify a buffer to scroll with the variable | |
1116 @code{other-window-scroll-buffer}. When the selected window is the | |
1117 minibuffer, the next window is normally the one at the top left corner. | |
1118 You can specify a different window to scroll with the variable | |
1119 @code{minibuffer-scroll-window}. This variable has no effect when any | |
1120 other window is selected. @xref{Minibuffer Misc}. | |
1121 | |
1122 When the minibuffer is active, it is the next window if the selected | |
1123 window is the one at the bottom right corner. In this case, | |
1124 @code{scroll-other-window} attempts to scroll the minibuffer. If the | |
1125 minibuffer contains just one line, it has nowhere to scroll to, so the | |
1126 line reappears after the echo area momentarily displays the message | |
1127 ``Beginning of buffer''. | |
1128 @end deffn | |
1129 | |
1130 @c Emacs 19 feature | |
1131 @defvar other-window-scroll-buffer | |
1132 If this variable is non-@code{nil}, it tells @code{scroll-other-window} | |
1133 which buffer to scroll. | |
1134 @end defvar | |
1135 | |
1136 @defopt scroll-step | |
1137 This variable controls how scrolling is done automatically when point | |
1138 moves off the screen. If the value is zero, then redisplay scrolls the | |
1139 text to center point vertically in the window. If the value is a | |
1140 positive integer @var{n}, then redisplay brings point back on screen by | |
1141 scrolling @var{n} lines in either direction, if possible; otherwise, it | |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1142 centers point. The default value is zero. |
6564 | 1143 @end defopt |
1144 | |
1145 @defopt next-screen-context-lines | |
1146 The value of this variable is the number of lines of continuity to | |
1147 retain when scrolling by full screens. For example, @code{scroll-up} | |
1148 with an argument of @code{nil} scrolls so that this many lines at the | |
1149 bottom of the window appear instead at the top. The default value is | |
1150 @code{2}. | |
1151 @end defopt | |
1152 | |
1153 @deffn Command recenter &optional count | |
1154 @cindex centering point | |
1155 This function scrolls the selected window to put the text where point | |
1156 is located at a specified vertical position within the window. | |
1157 | |
1158 If @var{count} is a nonnegative number, it puts the line containing | |
1159 point @var{count} lines down from the top of the window. If @var{count} | |
1160 is a negative number, then it counts upward from the bottom of the | |
1161 window, so that @minus{}1 stands for the last usable line in the window. | |
1162 If @var{count} is a non-@code{nil} list, then it stands for the line in | |
1163 the middle of the window. | |
1164 | |
1165 If @var{count} is @code{nil}, @code{recenter} puts the line containing | |
1166 point in the middle of the window, then clears and redisplays the entire | |
1167 selected frame. | |
1168 | |
1169 When @code{recenter} is called interactively, @var{count} is the raw | |
1170 prefix argument. Thus, typing @kbd{C-u} as the prefix sets the | |
1171 @var{count} to a non-@code{nil} list, while typing @kbd{C-u 4} sets | |
1172 @var{count} to 4, which positions the current line four lines from the | |
1173 top. | |
1174 | |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1175 With an argument of zero, @code{recenter} positions the current line at |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1176 the top of the window. This action is so handy that some people make a |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1177 separate key binding to do this. For example, |
6564 | 1178 |
1179 @example | |
1180 @group | |
1181 (defun line-to-top-of-window () | |
1182 "Scroll current line to top of window. | |
1183 Replaces three keystroke sequence C-u 0 C-l." | |
1184 (interactive) | |
1185 (recenter 0)) | |
1186 | |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1187 (global-set-key [kp-multiply] 'line-to-top-of-window) |
6564 | 1188 @end group |
1189 @end example | |
1190 @end deffn | |
1191 | |
1192 @node Horizontal Scrolling | |
1193 @section Horizontal Scrolling | |
1194 @cindex horizontal scrolling | |
1195 | |
1196 Because we read English first from top to bottom and second from left | |
1197 to right, horizontal scrolling is not like vertical scrolling. Vertical | |
1198 scrolling involves selection of a contiguous portion of text to display. | |
1199 Horizontal scrolling causes part of each line to go off screen. The | |
1200 amount of horizontal scrolling is therefore specified as a number of | |
1201 columns rather than as a position in the buffer. It has nothing to do | |
1202 with the display-start position returned by @code{window-start}. | |
1203 | |
1204 Usually, no horizontal scrolling is in effect; then the leftmost | |
1205 column is at the left edge of the window. In this state, scrolling to | |
1206 the right is meaningless, since there is no data to the left of the | |
1207 screen to be revealed by it; so this is not allowed. Scrolling to the | |
1208 left is allowed; it scrolls the first columns of text off the edge of | |
1209 the window and can reveal additional columns on the right that were | |
1210 truncated before. Once a window has a nonzero amount of leftward | |
1211 horizontal scrolling, you can scroll it back to the right, but only so | |
1212 far as to reduce the net horizontal scroll to zero. There is no limit | |
1213 to how far left you can scroll, but eventually all the text will | |
1214 disappear off the left edge. | |
1215 | |
1216 @deffn Command scroll-left count | |
1217 This function scrolls the selected window @var{count} columns to the | |
1218 left (or to the right if @var{count} is negative). The return value is | |
1219 the total amount of leftward horizontal scrolling in effect after the | |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1220 change---just like the value returned by @code{window-hscroll} (below). |
6564 | 1221 @end deffn |
1222 | |
1223 @deffn Command scroll-right count | |
1224 This function scrolls the selected window @var{count} columns to the | |
1225 right (or to the left if @var{count} is negative). The return value is | |
1226 the total amount of leftward horizontal scrolling in effect after the | |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1227 change---just like the value returned by @code{window-hscroll} (below). |
6564 | 1228 |
1229 Once you scroll a window as far right as it can go, back to its normal | |
1230 position where the total leftward scrolling is zero, attempts to scroll | |
1231 any farther right have no effect. | |
1232 @end deffn | |
1233 | |
1234 @defun window-hscroll &optional window | |
1235 This function returns the total leftward horizontal scrolling of | |
1236 @var{window}---the number of columns by which the text in @var{window} | |
1237 is scrolled left past the left margin. | |
1238 | |
1239 The value is never negative. It is zero when no horizontal scrolling | |
1240 has been done in @var{window} (which is usually the case). | |
1241 | |
1242 If @var{window} is @code{nil}, the selected window is used. | |
1243 | |
1244 @example | |
1245 @group | |
1246 (window-hscroll) | |
1247 @result{} 0 | |
1248 @end group | |
1249 @group | |
1250 (scroll-left 5) | |
1251 @result{} 5 | |
1252 @end group | |
1253 @group | |
1254 (window-hscroll) | |
1255 @result{} 5 | |
1256 @end group | |
1257 @end example | |
1258 @end defun | |
1259 | |
1260 @defun set-window-hscroll window columns | |
1261 This function sets the number of columns from the left margin that | |
1262 @var{window} is scrolled to the value of @var{columns}. The argument | |
1263 @var{columns} should be zero or positive; if not, it is taken as zero. | |
1264 | |
1265 The value returned is @var{columns}. | |
1266 | |
1267 @example | |
1268 @group | |
1269 (set-window-hscroll (selected-window) 10) | |
1270 @result{} 10 | |
1271 @end group | |
1272 @end example | |
1273 @end defun | |
1274 | |
1275 Here is how you can determine whether a given position @var{position} | |
1276 is off the screen due to horizontal scrolling: | |
1277 | |
1278 @example | |
1279 @group | |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1280 (defun hscroll-on-screen (window position) |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1281 (save-excursion |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1282 (goto-char position) |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1283 (and |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1284 (>= (- (current-column) (window-hscroll window)) 0) |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1285 (< (- (current-column) (window-hscroll window)) |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1286 (window-width window))))) |
6564 | 1287 @end group |
1288 @end example | |
1289 | |
1290 @node Size of Window | |
1291 @section The Size of a Window | |
1292 @cindex window size | |
1293 @cindex size of window | |
1294 | |
1295 An Emacs window is rectangular, and its size information consists of | |
1296 the height (the number of lines) and the width (the number of character | |
1297 positions in each line). The mode line is included in the height. But | |
1298 the width does not count the scroll bar or the column of @samp{|} | |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1299 characters that separates side-by-side windows. |
6564 | 1300 |
1301 The following three functions return size information about a window: | |
1302 | |
1303 @defun window-height &optional window | |
1304 This function returns the number of lines in @var{window}, including | |
1305 its mode line. If @var{window} fills its entire frame, this is one less | |
1306 than the value of @code{frame-height} on that frame (since the last line | |
1307 is always reserved for the minibuffer). | |
1308 | |
1309 If @var{window} is @code{nil}, the function uses the selected window. | |
1310 | |
1311 @example | |
1312 @group | |
1313 (window-height) | |
1314 @result{} 23 | |
1315 @end group | |
1316 @group | |
1317 (split-window-vertically) | |
1318 @result{} #<window 4 on windows.texi> | |
1319 @end group | |
1320 @group | |
1321 (window-height) | |
1322 @result{} 11 | |
1323 @end group | |
1324 @end example | |
1325 @end defun | |
1326 | |
1327 @defun window-width &optional window | |
1328 This function returns the number of columns in @var{window}. If | |
1329 @var{window} fills its entire frame, this is the same as the value of | |
1330 @code{frame-width} on that frame. The width does not include the | |
1331 window's scroll bar or the column of @samp{|} characters that separates | |
1332 side-by-side windows. | |
1333 | |
1334 If @var{window} is @code{nil}, the function uses the selected window. | |
1335 | |
1336 @example | |
1337 @group | |
1338 (window-width) | |
1339 @result{} 80 | |
1340 @end group | |
1341 @end example | |
1342 @end defun | |
1343 | |
1344 @defun window-edges &optional window | |
1345 This function returns a list of the edge coordinates of @var{window}. | |
1346 If @var{window} is @code{nil}, the selected window is used. | |
1347 | |
1348 The order of the list is @code{(@var{left} @var{top} @var{right} | |
1349 @var{bottom})}, all elements relative to 0, 0 at the top left corner of | |
1350 the frame. The element @var{right} of the value is one more than the | |
1351 rightmost column used by @var{window}, and @var{bottom} is one more than | |
1352 the bottommost row used by @var{window} and its mode-line. | |
1353 | |
1354 When you have side-by-side windows, the right edge value for a window | |
1355 with a neighbor on the right includes the width of the separator between | |
1356 the window and that neighbor. This separator may be a column of | |
1357 @samp{|} characters or it may be a scroll bar. Since the width of the | |
1358 window does not include this separator, the width does not equal the | |
1359 difference between the right and left edges in this case. | |
1360 | |
1361 Here is the result obtained on a typical 24-line terminal with just one | |
1362 window: | |
1363 | |
1364 @example | |
1365 @group | |
1366 (window-edges (selected-window)) | |
1367 @result{} (0 0 80 23) | |
1368 @end group | |
1369 @end example | |
1370 | |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1371 @noindent |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1372 The bottom edge is at line 23 because the last line is the echo area. |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1373 |
6564 | 1374 If @var{window} is at the upper left corner of its frame, @var{right} |
1375 and @var{bottom} are the same as the values returned by | |
1376 @code{(window-width)} and @code{(window-height)} respectively, and | |
1377 @var{top} and @var{bottom} are zero. For example, the edges of the | |
1378 following window are @w{@samp{0 0 5 8}}. Assuming that the frame has | |
1379 more than 8 columns, the last column of the window (column 7) holds a | |
1380 border rather than text. The last row (row 4) holds the mode line, | |
1381 shown here with @samp{xxxxxxxxx}. | |
1382 | |
1383 @example | |
1384 @group | |
1385 0 | |
1386 _______ | |
1387 0 | | | |
1388 | | | |
1389 | | | |
1390 | | | |
1391 xxxxxxxxx 4 | |
1392 | |
1393 7 | |
1394 @end group | |
1395 @end example | |
1396 | |
1397 When there are side-by-side windows, any window not at the right edge of | |
1398 its frame has a separator in its last column or columns. The separator | |
1399 counts as one or two columns in the width of the window. A window never | |
1400 includes a separator on its left, since that belongs to the window to | |
1401 the left. | |
1402 | |
1403 In the following example, let's suppose that the frame is 7 | |
1404 columns wide. Then the edges of the left window are @w{@samp{0 0 4 3}} | |
1405 and the edges of the right window are @w{@samp{4 0 7 3}}. | |
1406 | |
1407 @example | |
1408 @group | |
1409 ___ ___ | |
1410 | | | | |
1411 | | | | |
1412 xxxxxxxxx | |
1413 | |
1414 0 34 7 | |
1415 @end group | |
1416 @end example | |
1417 @end defun | |
1418 | |
1419 @node Resizing Windows | |
1420 @section Changing the Size of a Window | |
1421 @cindex window resizing | |
1422 @cindex changing window size | |
1423 @cindex window size, changing | |
1424 | |
1425 The window size functions fall into two classes: high-level commands | |
1426 that change the size of windows and low-level functions that access | |
1427 window size. Emacs does not permit overlapping windows or gaps between | |
1428 windows, so resizing one window affects other windows. | |
1429 | |
1430 @deffn Command enlarge-window size &optional horizontal | |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1431 This function makes the selected window @var{size} lines taller, |
6564 | 1432 stealing lines from neighboring windows. It takes the lines from one |
1433 window at a time until that window is used up, then takes from another. | |
1434 If a window from which lines are stolen shrinks below | |
1435 @code{window-min-height} lines, that window disappears. | |
1436 | |
1437 If @var{horizontal} is non-@code{nil}, this function makes | |
1438 @var{window} wider by @var{size} columns, stealing columns instead of | |
1439 lines. If a window from which columns are stolen shrinks below | |
1440 @code{window-min-width} columns, that window disappears. | |
1441 | |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1442 If the requested size would exceed that of the window's frame, then the |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1443 function makes the window occupy the entire height (or width) of the |
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1444 frame. |
6564 | 1445 |
1446 If @var{size} is negative, this function shrinks the window by | |
1447 @minus{}@var{size} lines or columns. If that makes the window smaller | |
1448 than the minimum size (@code{window-min-height} and | |
1449 @code{window-min-width}), @code{enlarge-window} deletes the window. | |
1450 | |
1451 @code{enlarge-window} returns @code{nil}. | |
1452 @end deffn | |
1453 | |
1454 @deffn Command enlarge-window-horizontally columns | |
1455 This function makes the selected window @var{columns} wider. | |
1456 It could be defined as follows: | |
1457 | |
1458 @example | |
1459 @group | |
1460 (defun enlarge-window-horizontally (columns) | |
1461 (enlarge-window columns t)) | |
1462 @end group | |
1463 @end example | |
1464 @end deffn | |
1465 | |
1466 @deffn Command shrink-window size &optional horizontal | |
1467 This function is like @code{enlarge-window} but negates the argument | |
1468 @var{size}, making the selected window smaller by giving lines (or | |
1469 columns) to the other windows. If the window shrinks below | |
1470 @code{window-min-height} or @code{window-min-width}, then it disappears. | |
1471 | |
1472 If @var{size} is negative, the window is enlarged by @minus{}@var{size} | |
1473 lines or columns. | |
1474 @end deffn | |
1475 | |
1476 @deffn Command shrink-window-horizontally columns | |
1477 This function makes the selected window @var{columns} narrower. | |
1478 It could be defined as follows: | |
1479 | |
1480 @example | |
1481 @group | |
1482 (defun shrink-window-horizontally (columns) | |
1483 (shrink-window columns t)) | |
1484 @end group | |
1485 @end example | |
1486 @end deffn | |
1487 | |
1488 @cindex minimum window size | |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1489 The following two variables constrain the window-size-changing |
6564 | 1490 functions to a minimum height and width. |
1491 | |
1492 @defopt window-min-height | |
1493 The value of this variable determines how short a window may become | |
1494 before it is automatically deleted. Making a window smaller than | |
1495 @code{window-min-height} automatically deletes it, and no window may be | |
1496 created shorter than this. The absolute minimum height is two (allowing | |
1497 one line for the mode line, and one line for the buffer display). | |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1498 Actions that change window sizes reset this variable to two if it is |
6564 | 1499 less than two. The default value is 4. |
1500 @end defopt | |
1501 | |
1502 @defopt window-min-width | |
1503 The value of this variable determines how narrow a window may become | |
1504 before it automatically deleted. Making a window smaller than | |
1505 @code{window-min-width} automatically deletes it, and no window may be | |
1506 created narrower than this. The absolute minimum width is one; any | |
1507 value below that is ignored. The default value is 10. | |
1508 @end defopt | |
1509 | |
1510 @node Coordinates and Windows | |
1511 @section Coordinates and Windows | |
1512 | |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1513 This section describes how to relate screen coordinates to windows. |
6564 | 1514 |
1515 @defun window-at x y &optional frame | |
1516 This function returns the window containing the specified cursor | |
1517 position in the frame @var{frame}. The coordinates @var{x} and @var{y} | |
1518 are measured in characters and count from the top left corner of the | |
1519 frame. If they are out of range, @code{window-at} returns @code{nil}. | |
1520 | |
1521 If you omit @var{frame}, the selected frame is used. | |
1522 @end defun | |
1523 | |
1524 @defun coordinates-in-window-p coordinates window | |
1525 This function checks whether a particular frame position falls within | |
1526 the window @var{window}. | |
1527 | |
1528 The argument @var{coordinates} is a cons cell of this form: | |
1529 | |
1530 @example | |
1531 (@var{x} . @var{y}) | |
1532 @end example | |
1533 | |
1534 @noindent | |
1535 The coordinates @var{x} and @var{y} are measured in characters, and | |
1536 count from the top left corner of the screen or frame. | |
1537 | |
1538 The value of @code{coordinates-in-window-p} is non-@code{nil} if the | |
1539 coordinates are inside @var{window}. The value also indicates what part | |
1540 of the window the position is in, as follows: | |
1541 | |
1542 @table @code | |
1543 @item (@var{relx} . @var{rely}) | |
1544 The coordinates are inside @var{window}. The numbers @var{relx} and | |
1545 @var{rely} are the equivalent window-relative coordinates for the | |
1546 specified position, counting from 0 at the top left corner of the | |
1547 window. | |
1548 | |
1549 @item mode-line | |
1550 The coordinates are in the mode line of @var{window}. | |
1551 | |
1552 @item vertical-split | |
1553 The coordinates are in the vertical line between @var{window} and its | |
1554 neighbor to the right. This value occurs only if the window doesn't | |
1555 have a scroll bar; positions in a scroll bar are considered outside the | |
1556 window. | |
1557 | |
1558 @item nil | |
1559 The coordinates are not in any part of @var{window}. | |
1560 @end table | |
1561 | |
1562 The function @code{coordinates-in-window-p} does not require a frame as | |
1563 argument because it always uses the frame that @var{window} is on. | |
1564 @end defun | |
1565 | |
1566 @node Window Configurations | |
1567 @section Window Configurations | |
1568 @cindex window configurations | |
1569 @cindex saving window information | |
1570 | |
1571 A @dfn{window configuration} records the entire layout of a | |
1572 frame---all windows, their sizes, which buffers they contain, what part | |
1573 of each buffer is displayed, and the values of point and the mark. You | |
1574 can bring back an entire previous layout by restoring a window | |
1575 configuration previously saved. | |
1576 | |
1577 If you want to record all frames instead of just one, use a frame | |
1578 configuration instead of a window configuration. @xref{Frame | |
1579 Configurations}. | |
1580 | |
1581 @defun current-window-configuration | |
1582 This function returns a new object representing Emacs's current window | |
1583 configuration, namely the number of windows, their sizes and current | |
1584 buffers, which window is the selected window, and for each window the | |
1585 displayed buffer, the display-start position, and the positions of point | |
1586 and the mark. An exception is made for point in the current buffer, | |
1587 whose value is not saved. | |
1588 @end defun | |
1589 | |
1590 @defun set-window-configuration configuration | |
1591 This function restores the configuration of Emacs's windows and | |
1592 buffers to the state specified by @var{configuration}. The argument | |
1593 @var{configuration} must be a value that was previously returned by | |
1594 @code{current-window-configuration}. | |
1595 | |
1596 Here is a way of using this function to get the same effect | |
1597 as @code{save-window-excursion}: | |
1598 | |
1599 @example | |
1600 @group | |
1601 (let ((config (current-window-configuration))) | |
1602 (unwind-protect | |
1603 (progn (split-window-vertically nil) | |
1604 @dots{}) | |
1605 (set-window-configuration config))) | |
1606 @end group | |
1607 @end example | |
1608 @end defun | |
1609 | |
1610 @defspec save-window-excursion forms@dots{} | |
1611 This special form records the window configuration, executes @var{forms} | |
1612 in sequence, then restores the earlier window configuration. The window | |
1613 configuration includes the value of point and the portion of the buffer | |
8491
320375e58ee3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1614 that is visible. It also includes the choice of selected window. |
6564 | 1615 However, it does not include the value of point in the current buffer; |
1616 use @code{save-excursion} if you wish to preserve that. | |
1617 | |
1618 The return value is the value of the final form in @var{forms}. | |
1619 For example: | |
1620 | |
1621 @example | |
1622 @group | |
1623 (split-window) | |
1624 @result{} #<window 25 on control.texi> | |
1625 @end group | |
1626 @group | |
1627 (setq w (selected-window)) | |
1628 @result{} #<window 19 on control.texi> | |
1629 @end group | |
1630 @group | |
1631 (save-window-excursion | |
1632 (delete-other-windows w) | |
1633 (switch-to-buffer "foo") | |
1634 'do-something) | |
1635 @result{} do-something | |
1636 ;; @r{The screen is now split again.} | |
1637 @end group | |
1638 @end example | |
1639 @end defspec | |
1640 | |
1641 @defun window-configuration-p object | |
1642 This function returns @code{t} if @var{object} is a window configuration. | |
1643 @end defun | |
1644 | |
1645 Primitives to look inside of window configurations would make sense, | |
1646 but none are implemented. It is not clear they are useful enough to be | |
1647 worth implementing. |