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