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