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