annotate lispref/windows.texi @ 66138:88bf1b026ccb

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