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