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