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