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