annotate lispref/windows.texi @ 19960:38172783650b EMACS_20_2

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