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