annotate doc/lispref/windows.texi @ 95112:0835cb21d60e

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