windows.texi 103 KB
Newer Older
Glenn Morris's avatar
Glenn Morris committed
1 2 3
@c -*-texinfo-*-
@c This is part of the GNU Emacs Lisp Reference Manual.
@c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2001,
Glenn Morris's avatar
Glenn Morris committed
4
@c   2002, 2003, 2004, 2005, 2006, 2007, 2008  Free Software Foundation, Inc.
Glenn Morris's avatar
Glenn Morris committed
5
@c See the file elisp.texi for copying conditions.
6
@setfilename ../../info/windows
Glenn Morris's avatar
Glenn Morris committed
7 8 9 10
@node Windows, Frames, Buffers, Top
@chapter Windows

  This chapter describes most of the functions and variables related to
Martin Rudalics's avatar
Martin Rudalics committed
11 12 13
Emacs windows.  @xref{Frames and Windows}, for how windows relate to
frames.  @xref{Display}, for information on how text is displayed in
windows.
Glenn Morris's avatar
Glenn Morris committed
14 15 16 17 18 19 20 21 22 23 24

@menu
* Basic Windows::           Basic information on using windows.
* Splitting Windows::       Splitting one window into two windows.
* Deleting Windows::        Deleting a window gives its space to other windows.
* Selecting Windows::       The selected window is the one that you edit in.
* Cyclic Window Ordering::  Moving around the existing windows.
* Buffers and Windows::     Each window displays the contents of a buffer.
* Displaying Buffers::      Higher-level functions for displaying a buffer
                              and choosing a window for it.
* Choosing Window::	    How to choose a window for displaying a buffer.
Martin Rudalics's avatar
Martin Rudalics committed
25 26
* Dedicated Windows::	    How to avoid displaying another buffer in
                              a specific window.          
Glenn Morris's avatar
Glenn Morris committed
27
* Window Point::            Each window has its own location of point.
Martin Rudalics's avatar
Martin Rudalics committed
28 29
* Window Start and End::    Buffer positions indicating which text is
                              on-screen in a window.
Glenn Morris's avatar
Glenn Morris committed
30 31 32 33 34 35 36 37
* Textual Scrolling::       Moving text up and down through the window.
* Vertical Scrolling::      Moving the contents up and down on the window.
* Horizontal Scrolling::    Moving the contents sideways on the window.
* Size of Window::          Accessing the size of a window.
* Resizing Windows::        Changing the size of a window.
* Coordinates and Windows:: Converting coordinates to windows.
* Window Tree::             The layout and sizes of all windows in a frame.
* Window Configurations::   Saving and restoring the state of the screen.
Martin Rudalics's avatar
Martin Rudalics committed
38
* Window Parameters::       Associating additional information with windows.
Glenn Morris's avatar
Glenn Morris committed
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
* Window Hooks::            Hooks for scrolling, window size changes,
                              redisplay going past a certain point,
                              or window configuration changes.
@end menu

@node Basic Windows
@section Basic Concepts of Emacs Windows
@cindex window
@cindex selected window

  A @dfn{window} in Emacs is the physical area of the screen in which a
buffer is displayed.  The term is also used to refer to a Lisp object that
represents that screen area in Emacs Lisp.  It should be
clear from the context which is meant.

Martin Rudalics's avatar
Martin Rudalics committed
54 55 56 57
  Emacs groups windows into frames, @xref{Frames}.  A frame represents
an area of screen available for Emacs to use.  Each frame always
contains at least one window, but you can subdivide it vertically or
horizontally into multiple, nonoverlapping Emacs windows.
Glenn Morris's avatar
Glenn Morris committed
58 59 60 61

  In each frame, at any time, one and only one window is designated as
@dfn{selected within the frame}.  The frame's cursor appears in that
window, but the other windows have ``non-selected'' cursors, normally
Martin Rudalics's avatar
Martin Rudalics committed
62 63
less visible.  (@pxref{Cursor Parameters}, for customizing this.)  At
any time, one frame is the selected frame; and the window selected
64
within that frame is @dfn{the selected window}.  The selected window's
Martin Rudalics's avatar
Martin Rudalics committed
65 66
buffer is usually the current buffer (except when @code{set-buffer} has
been used), @xref{Current Buffer}.
Glenn Morris's avatar
Glenn Morris committed
67 68 69 70

  For practical purposes, a window exists only while it is displayed in
a frame.  Once removed from the frame, the window is effectively deleted
and should not be used, @emph{even though there may still be references
Martin Rudalics's avatar
Martin Rudalics committed
71 72 73
to it} from other Lisp objects, @xref{Deleting Windows}.  Restoring a
saved window configuration is the only way for a window no longer on the
screen to come back to life, @xref{Window Configurations}.
Glenn Morris's avatar
Glenn Morris committed
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94

@cindex multiple windows
  Users create multiple windows so they can look at several buffers at
once.  Lisp libraries use multiple windows for a variety of reasons, but
most often to display related information.  In Rmail, for example, you
can move through a summary buffer in one window while the other window
shows messages one at a time as they are reached.

  The meaning of ``window'' in Emacs is similar to what it means in the
context of general-purpose window systems such as X, but not identical.
The X Window System places X windows on the screen; Emacs uses one or
more X windows as frames, and subdivides them into
Emacs windows.  When you use Emacs on a character-only terminal, Emacs
treats the whole terminal screen as one frame.

@cindex terminal screen
@cindex screen of terminal
@cindex tiled windows
  Most window systems support arbitrarily located overlapping windows.
In contrast, Emacs windows are @dfn{tiled}; they never overlap, and
together they fill the whole screen or frame.  Because of the way in
Martin Rudalics's avatar
Martin Rudalics committed
95 96 97
which Emacs creates new windows (@pxref{Splitting Windows}) and resizes
them (@pxref{Resizing Windows}), not all conceivable tilings of windows
on an Emacs frame are actually possible.
Glenn Morris's avatar
Glenn Morris committed
98 99 100 101 102 103 104 105 106 107

@defun windowp object
This function returns @code{t} if @var{object} is a window.
@end defun

@node Splitting Windows
@section Splitting Windows
@cindex splitting windows
@cindex window splitting

Martin Rudalics's avatar
Martin Rudalics committed
108 109 110
The functions described below are the primitives used to split a window
into two windows.  They do not accept a buffer as an argument.  Rather,
the two ``halves'' of the split window initially display the same buffer
Glenn Morris's avatar
Glenn Morris committed
111 112 113
previously visible in the window that was split.

@deffn Command split-window &optional window size horizontal
Martin Rudalics's avatar
Martin Rudalics committed
114 115 116 117 118 119 120 121 122 123 124 125
This function splits a new window out of @var{window}'s screen area.  It
returns the new window.  @var{window} defaults to the selected window.
When you split the selected window, it remains selected.

If @var{horizontal} is non-@code{nil}, then @var{window} splits into two
side by side windows.  The original window keeps the leftmost @var{size}
columns, and gives the rest of the columns to the new window.
Otherwise, @var{window} splits into windows one above the other, the
original window keeps the upper @var{size} lines and gives the rest of
the lines to the new window.  The original window @var{window} is
therefore the left-hand or upper of the two, and the new window is the
right-hand or lower.
Glenn Morris's avatar
Glenn Morris committed
126 127 128 129 130 131 132

If @var{size} is omitted or @code{nil}, then @var{window} is divided
evenly into two parts.  (If there is an odd line, it is allocated to
the new window.)  When @code{split-window} is called interactively,
all its arguments are @code{nil}.

If splitting would result in making a window that is smaller than
Martin Rudalics's avatar
Martin Rudalics committed
133 134 135
@code{window-min-height} or @code{window-min-width} (@pxref{Resizing
Windows}), @code{split-window} signals an error and does not split the
window at all.
Glenn Morris's avatar
Glenn Morris committed
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219

The following example starts with one window on a screen that is 50
lines high by 80 columns wide; then it splits the window.

@smallexample
@group
(setq w (selected-window))
     @result{} #<window 8 on windows.texi>
(window-edges)          ; @r{Edges in order:}
     @result{} (0 0 80 50)     ;   @r{left--top--right--bottom}
@end group

@group
;; @r{Returns window created}
(setq w2 (split-window w 15))
     @result{} #<window 28 on windows.texi>
@end group
@group
(window-edges w2)
     @result{} (0 15 80 50)    ; @r{Bottom window;}
                        ;   @r{top is line 15}
@end group
@group
(window-edges w)
     @result{} (0 0 80 15)     ; @r{Top window}
@end group
@end smallexample

The screen looks like this:

@smallexample
@group
         __________
        |          |  line 0
        |    w     |
        |__________|
        |          |  line 15
        |    w2    |
        |__________|
                      line 50
 column 0   column 80
@end group
@end smallexample

Next, split the top window horizontally:

@smallexample
@group
(setq w3 (split-window w 35 t))
     @result{} #<window 32 on windows.texi>
@end group
@group
(window-edges w3)
     @result{} (35 0 80 15)  ; @r{Left edge at column 35}
@end group
@group
(window-edges w)
     @result{} (0 0 35 15)   ; @r{Right edge at column 35}
@end group
@group
(window-edges w2)
     @result{} (0 15 80 50)  ; @r{Bottom window unchanged}
@end group
@end smallexample

@need 3000
Now the screen looks like this:

@smallexample
@group
     column 35
         __________
        |   |      |  line 0
        | w |  w3  |
        |___|______|
        |          |  line 15
        |    w2    |
        |__________|
                      line 50
 column 0   column 80
@end group
@end smallexample

Normally, Emacs indicates the border between two side-by-side windows
Martin Rudalics's avatar
Martin Rudalics committed
220 221 222
with a scroll bar, @xref{Scroll Bars}, or @samp{|} characters.  The
display table can specify alternative border characters; @xref{Display
Tables}.
Glenn Morris's avatar
Glenn Morris committed
223 224 225 226 227 228
@end deffn

@deffn Command split-window-vertically &optional size
This function splits the selected window into two windows, one above the
other, leaving the upper of the two windows selected, with @var{size}
lines.  (If @var{size} is negative, then the lower of the two windows
229
gets @minus{}@var{size} lines and the upper window gets the rest, but
Glenn Morris's avatar
Glenn Morris committed
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
the upper window is still the one selected.)  However, if
@code{split-window-keep-point} (see below) is @code{nil}, then either
window can be selected.

In other respects, this function is similar to @code{split-window}.
In particular, the upper window is the original one and the return
value is the new, lower window.
@end deffn

@defopt split-window-keep-point
If this variable is non-@code{nil} (the default), then
@code{split-window-vertically} behaves as described above.

If it is @code{nil}, then @code{split-window-vertically} adjusts point
in each of the two windows to avoid scrolling.  (This is useful on
slow terminals.)  It selects whichever window contains the screen line
that point was previously on.

248 249
This variable affects the behavior of @code{split-window-vertically}
only.  It has no effect on the other functions described here.
Glenn Morris's avatar
Glenn Morris committed
250 251 252 253 254 255
@end defopt

@deffn Command split-window-horizontally &optional size
This function splits the selected window into two windows
side-by-side, leaving the selected window on the left with @var{size}
columns.  If @var{size} is negative, the rightmost window gets
256
@minus{}@var{size} columns, but the leftmost window still remains
Glenn Morris's avatar
Glenn Morris committed
257 258 259 260 261 262 263 264 265 266 267 268 269 270
selected.

This function is basically an interface to @code{split-window}.
You could define a simplified version of the function like this:

@smallexample
@group
(defun split-window-horizontally (&optional arg)
  "Split selected window into two windows, side by side..."
  (interactive "P")
@end group
@group
  (let ((size (and arg (prefix-numeric-value arg))))
    (and size (< size 0)
271
         (setq size (+ (window-width) size)))
Glenn Morris's avatar
Glenn Morris committed
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
    (split-window nil size t)))
@end group
@end smallexample
@end deffn

@defun one-window-p &optional no-mini all-frames
This function returns non-@code{nil} if there is only one window.  The
argument @var{no-mini}, if non-@code{nil}, means don't count the
minibuffer even if it is active; otherwise, the minibuffer window is
counted when it is active.

The argument @var{all-frames} specifies which frames to consider.  Here
are the possible values and their meanings:

@table @asis
@item @code{nil}
Count the windows in the selected frame, plus the minibuffer used
by that frame even if it lies in some other frame.

@item @code{t}
Count all windows in all existing frames.

@item @code{visible}
Count all windows in all visible frames.

@item 0
Count all windows in all visible or iconified frames.

@item anything else
Count precisely the windows in the selected frame, and no others.
@end table
@end defun

@node Deleting Windows
@section Deleting Windows
@cindex deleting windows

A window remains visible on its frame unless you @dfn{delete} it by
calling certain functions that delete windows.  A deleted window cannot
appear on the screen, but continues to exist as a Lisp object until
there are no references to it.  There is no way to cancel the deletion
of a window aside from restoring a saved window configuration
(@pxref{Window Configurations}).  Restoring a window configuration also
deletes any windows that aren't part of that configuration.

  When you delete a window, the space it took up is given to one
Martin Rudalics's avatar
Martin Rudalics committed
318
adjacent window.
Glenn Morris's avatar
Glenn Morris committed
319 320 321 322 323 324 325 326 327 328 329

@c Emacs 19 feature
@defun window-live-p window
This function returns @code{nil} if @var{window} is deleted, and
@code{t} otherwise.

@strong{Warning:} Erroneous information or fatal errors may result from
using a deleted window as if it were live.
@end defun

@deffn Command delete-window &optional window
Martin Rudalics's avatar
Martin Rudalics committed
330 331 332
This function removes @var{window} from display and returns @code{nil}.
@var{window} defaults to the selected window.  An error is signaled if
@var{window} is the only window on its frame.
Glenn Morris's avatar
Glenn Morris committed
333 334 335 336
@end deffn

@deffn Command delete-other-windows &optional window
This function makes @var{window} the only window on its frame, by
Martin Rudalics's avatar
Martin Rudalics committed
337 338
deleting the other windows in that frame.  @var{window} defaults to the
selected window.  The return value is @code{nil}.
Glenn Morris's avatar
Glenn Morris committed
339 340
@end deffn

341
@deffn Command delete-windows-on &optional buffer-or-name frame
Glenn Morris's avatar
Glenn Morris committed
342 343
This function deletes all windows showing @var{buffer-or-name}.  If
there are no windows showing @var{buffer-or-name}, it does nothing.
344 345
@var{buffer-or-name} may be a buffer or the name of an existing buffer
and defaults to the current buffer.
Glenn Morris's avatar
Glenn Morris committed
346 347 348 349 350 351 352

@code{delete-windows-on} operates frame by frame.  If a frame has
several windows showing different buffers, then those showing
@var{buffer-or-name} are removed, and the others expand to fill the
space.  If all windows in some frame are showing @var{buffer-or-name}
(including the case where there is only one window), then the frame
winds up with a single window showing another buffer chosen with
Martin Rudalics's avatar
Martin Rudalics committed
353 354 355 356
@code{other-buffer} (@pxref{The Buffer List}).  If, however, the window
showing @var{buffer-or-name} is dedicated to its buffer
(@pxref{Dedicated Windows}), and there are other frames left, that
window's frame is deleted.
Glenn Morris's avatar
Glenn Morris committed
357

Eli Zaretskii's avatar
Eli Zaretskii committed
358
The argument @var{frame} specifies which frames to operate on.  This
Glenn Morris's avatar
Glenn Morris committed
359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
function does not use it in quite the same way as the other functions
which scan all windows; specifically, the values @code{t} and @code{nil}
have the opposite of their meanings in other functions.  Here are the
full details:

@itemize @bullet
@item
If it is @code{nil}, operate on all frames.
@item
If it is @code{t}, operate on the selected frame.
@item
If it is @code{visible}, operate on all visible frames.
@item
If it is 0, operate on all visible or iconified frames.
@item
If it is a frame, operate on that frame.
@end itemize

This function always returns @code{nil}.
@end deffn

@node Selecting Windows
@section Selecting Windows
@cindex selecting a window

  When a window is selected, the buffer in the window becomes the current
buffer, and the cursor will appear in it.

@defun selected-window
This function returns the selected window.  This is the window in
which the cursor appears and to which many commands apply.
@end defun

@defun select-window window &optional norecord
This function makes @var{window} the selected window.  The cursor then
Martin Rudalics's avatar
Martin Rudalics committed
394 395 396
appears in @var{window} (on redisplay).  Unless @var{window} was already
selected, @code{select-window} makes @var{window}'s buffer the current
buffer.  The return value is @var{window}.
Glenn Morris's avatar
Glenn Morris committed
397

Martin Rudalics's avatar
Martin Rudalics committed
398 399 400 401 402
Normally, @var{window}'s selected buffer is moved to the front of the
buffer list (@pxref{The Buffer List}) and @var{window} becomes the most
recently selected window.  But if @var{norecord} is non-@code{nil}, the
buffer list remains unchanged and @var{window} does not become the most
recently selected one.
Glenn Morris's avatar
Glenn Morris committed
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420


@example
@group
(setq w (next-window))
(select-window w)
     @result{} #<window 65 on windows.texi>
@end group
@end example
@end defun

@defmac save-selected-window forms@dots{}
This macro records the selected frame, as well as the selected window
of each frame, executes @var{forms} in sequence, then restores the
earlier selected frame and windows.  It also saves and restores the
current buffer.  It returns the value of the last form in @var{forms}.

This macro does not save or restore anything about the sizes,
Martin Rudalics's avatar
Martin Rudalics committed
421 422 423 424 425 426 427 428 429 430
arrangement or contents of windows; therefore, if the @var{forms} change
them, the change persists.  If the previously selected window of some
frame is no longer live at the time of exit from @var{forms}, that
frame's selected window is left alone.  If the previously selected
window is no longer live, then whatever window is selected at the end of
@var{forms} remains selected.  The current buffer is restored if and
only if it is still live when exiting @var{forms}.

This macro changes neither the ordering of recently selected windows nor
the buffer list.
Glenn Morris's avatar
Glenn Morris committed
431 432 433
@end defmac

@defmac with-selected-window window forms@dots{}
Martin Rudalics's avatar
Martin Rudalics committed
434 435 436 437 438
This macro selects @var{window}, executes @var{forms} in sequence, then
restores the previously selected window and current buffer.  The ordering
of recently selected windows and the buffer list remain unchanged unless
you deliberately change them within @var{forms}, for example, by calling
@code{select-window} with argument @var{norecord} nil or omitted there.
Glenn Morris's avatar
Glenn Morris committed
439 440 441 442 443 444 445 446 447
@end defmac

@cindex finding windows
  The following functions choose one of the windows on the screen,
offering various criteria for the choice.

@defun get-lru-window &optional frame dedicated
This function returns the window least recently ``used'' (that is,
selected).  If any full-width windows are present, it only considers
Martin Rudalics's avatar
Martin Rudalics committed
448
these.
Glenn Morris's avatar
Glenn Morris committed
449 450 451

The selected window can be the least recently used window if it is the
only window.  A newly created window becomes the least recently used
Martin Rudalics's avatar
Martin Rudalics committed
452 453 454
window until it is selected.  A minibuffer window is never a candidate.
A dedicated window (@pxref{Dedicated Windows}) is never a candidate
unless the @var{dedicated} argument is non-@code{nil}, so if all
Glenn Morris's avatar
Glenn Morris committed
455 456
existing windows are dedicated, the value is @code{nil}.

Eli Zaretskii's avatar
Eli Zaretskii committed
457
The argument @var{frame} specifies which windows are considered.
Glenn Morris's avatar
Glenn Morris committed
458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475

@itemize @bullet
@item
If it is @code{nil}, consider windows on the selected frame.
@item
If it is @code{t}, consider windows on all frames.
@item
If it is @code{visible}, consider windows on all visible frames.
@item
If it is 0, consider windows on all visible or iconified frames.
@item
If it is a frame, consider windows on that frame.
@end itemize
@end defun

@defun get-largest-window &optional frame dedicated
This function returns the window with the largest area (height times
width).  If there are no side-by-side windows, then this is the window
Martin Rudalics's avatar
Martin Rudalics committed
476 477 478 479
with the most lines.  A minibuffer window is never a candidate.  A
dedicated window (@pxref{Dedicated Windows}) is never a candidate unless
the @var{dedicated} argument is non-@code{nil}, so if all existing
windows are dedicated, the value is @code{nil}.
Glenn Morris's avatar
Glenn Morris committed
480 481 482

If there are two candidate windows of the same size, this function
prefers the one that comes first in the cyclic ordering of windows
Martin Rudalics's avatar
Martin Rudalics committed
483
starting from the selected window (@pxref{Cyclic Window Ordering}).
Glenn Morris's avatar
Glenn Morris committed
484

Martin Rudalics's avatar
Martin Rudalics committed
485 486
The argument @var{frame} specifies which set of windows to consider, see
@code{get-lru-window} above.
Glenn Morris's avatar
Glenn Morris committed
487 488 489 490 491 492 493
@end defun

@cindex window that satisfies a predicate
@cindex conditional selection of windows
@defun get-window-with-predicate predicate &optional minibuf all-frames default
This function returns a window satisfying @var{predicate}.  It cycles
through all visible windows using @code{walk-windows} (@pxref{Cyclic
Martin Rudalics's avatar
Martin Rudalics committed
494 495 496 497
Window Ordering}), calling @var{predicate} on each one of them with that
window as its argument.  The function returns the first window for which
@var{predicate} returns a non-@code{nil} value; if that never happens,
it returns @var{default} (which defaults to @code{nil}).
Glenn Morris's avatar
Glenn Morris committed
498 499 500 501 502 503 504 505 506 507 508 509 510 511

The optional arguments @var{minibuf} and @var{all-frames} specify the
set of windows to include in the scan.  See the description of
@code{next-window} in @ref{Cyclic Window Ordering}, for details.
@end defun

@node Cyclic Window Ordering
@comment  node-name,  next,  previous,  up
@section Cyclic Ordering of Windows
@cindex cyclic ordering of windows
@cindex ordering of windows, cyclic
@cindex window ordering, cyclic

  When you use the command @kbd{C-x o} (@code{other-window}) to select
Martin Rudalics's avatar
Martin Rudalics committed
512 513 514
some other window, it moves through the windows on the screen in a
specific order.  For any given configuration of windows, this order
never varies.  It is called the @dfn{cyclic ordering of windows}.
Glenn Morris's avatar
Glenn Morris committed
515 516 517

  This ordering generally goes from top to bottom, and from left to
right.  But it may go down first or go right first, depending on the
Martin Rudalics's avatar
Martin Rudalics committed
518
order in which windows were split.
Glenn Morris's avatar
Glenn Morris committed
519 520 521 522 523 524

  If the first split was vertical (into windows one above each other),
and then the subwindows were split horizontally, then the ordering is
left to right in the top of the frame, and then left to right in the
next lower part of the frame, and so on.  If the first split was
horizontal, the ordering is top to bottom in the left part, and so on.
Martin Rudalics's avatar
Martin Rudalics committed
525 526
In general, within each set of siblings at any level in the window tree
(@pxref{Window Tree}), the order is left to right, or top to bottom.
Glenn Morris's avatar
Glenn Morris committed
527

Martin Rudalics's avatar
Martin Rudalics committed
528
@deffn Command next-window &optional window minibuf all-frames
Glenn Morris's avatar
Glenn Morris committed
529 530
@cindex minibuffer window, and @code{next-window}
This function returns the window following @var{window} in the cyclic
Martin Rudalics's avatar
Martin Rudalics committed
531 532 533
ordering of windows.  This is the window @kbd{C-x o} selects if typed
when @var{window} is selected.  @var{window} defaults to the selected
window.
Glenn Morris's avatar
Glenn Morris committed
534

Martin Rudalics's avatar
Martin Rudalics committed
535 536 537 538 539
The value of the argument @var{minibuf} specifies whether the minibuffer
is included in the window order.  Normally, when @var{minibuf} is
@code{nil}, the minibuffer is included only if it is currently
``active''; this matches the behavior of @kbd{C-x o}.  (The minibuffer
window is active while the minibuffer is in use, @xref{Minibuffers}.)
Glenn Morris's avatar
Glenn Morris committed
540

Martin Rudalics's avatar
Martin Rudalics committed
541 542 543 544
If @var{minibuf} is @code{t}, the cyclic ordering includes the
minibuffer window even if it is not active.  If @var{minibuf} is neither
@code{t} nor @code{nil}, the minibuffer window is not included even if
it is active.
Glenn Morris's avatar
Glenn Morris committed
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589

The argument @var{all-frames} specifies which frames to consider.  Here
are the possible values and their meanings:

@table @asis
@item @code{nil}
Consider all the windows in @var{window}'s frame, plus the minibuffer
used by that frame even if it lies in some other frame.  If the
minibuffer counts (as determined by @var{minibuf}), then all windows on
all frames that share that minibuffer count too.

@item @code{t}
Consider all windows in all existing frames.

@item @code{visible}
Consider all windows in all visible frames.  (To get useful results, you
must ensure @var{window} is in a visible frame.)

@item 0
Consider all windows in all visible or iconified frames.

@item a frame
Consider all windows on that frame.

@item anything else
Consider precisely the windows in @var{window}'s frame, and no others.
@end table

This example assumes there are two windows, both displaying the
buffer @samp{windows.texi}:

@example
@group
(selected-window)
     @result{} #<window 56 on windows.texi>
@end group
@group
(next-window (selected-window))
     @result{} #<window 52 on windows.texi>
@end group
@group
(next-window (next-window (selected-window)))
     @result{} #<window 56 on windows.texi>
@end group
@end example
Martin Rudalics's avatar
Martin Rudalics committed
590
@end deffn
Glenn Morris's avatar
Glenn Morris committed
591

Martin Rudalics's avatar
Martin Rudalics committed
592
@deffn Command previous-window &optional window minibuf all-frames
Glenn Morris's avatar
Glenn Morris committed
593 594 595
This function returns the window preceding @var{window} in the cyclic
ordering of windows.  The other arguments specify which windows to
include in the cycle, as in @code{next-window}.
Martin Rudalics's avatar
Martin Rudalics committed
596
@end deffn
Glenn Morris's avatar
Glenn Morris committed
597 598

@deffn Command other-window count &optional all-frames
Martin Rudalics's avatar
Martin Rudalics committed
599 600 601 602 603 604 605 606
This function selects another window in the cyclic ordering of windows.
@var{count} specifies the number of windows to skip in the ordering,
starting with the selected window, before making the selection.  If
@var{count} is a positive number, it skips @var{count} windows forwards.
@var{count} negative means skip @minus{}@var{count} windows backwards.
If @var{count} is zero, it does not skip any window, thus re-selecting
the selected window.  In an interactive call, @var{count} is the numeric
prefix argument.
Glenn Morris's avatar
Glenn Morris committed
607 608 609

The argument @var{all-frames} has the same meaning as in
@code{next-window}, but the @var{minibuf} argument of @code{next-window}
Martin Rudalics's avatar
Martin Rudalics committed
610
is always effectively @code{nil}.  This function returns @code{nil}.
Glenn Morris's avatar
Glenn Morris committed
611 612 613 614 615 616 617 618 619
@end deffn

@c Emacs 19 feature
@defun walk-windows proc &optional minibuf all-frames
This function cycles through all windows.  It calls the function
@code{proc} once for each window, with the window as its sole
argument.

The optional arguments @var{minibuf} and @var{all-frames} specify the
Martin Rudalics's avatar
Martin Rudalics committed
620
set of windows to include in the walk.  See @code{next-window}, above,
Glenn Morris's avatar
Glenn Morris committed
621 622 623 624
for details.
@end defun

@defun window-list &optional frame minibuf window
Martin Rudalics's avatar
Martin Rudalics committed
625 626 627
This function returns a list of all windows on @var{frame}, starting
with @var{window}.  @var{frame} defaults to the selected frame;
@var{window} to the selected window.
Glenn Morris's avatar
Glenn Morris committed
628

Martin Rudalics's avatar
Martin Rudalics committed
629
The value of @var{minibuf} specifies if the minibuffer window shall be
Glenn Morris's avatar
Glenn Morris committed
630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651
included in the result list.  If @var{minibuf} is @code{t}, the result
always includes the minibuffer window.  If @var{minibuf} is @code{nil}
or omitted, that includes the minibuffer window if it is active.  If
@var{minibuf} is neither @code{nil} nor @code{t}, the result never
includes the minibuffer window.
@end defun

@node Buffers and Windows
@section Buffers and Windows
@cindex examining windows
@cindex windows, controlling precisely
@cindex buffers, controlled in windows

  This section describes low-level functions to examine windows or to
display buffers in windows in a precisely controlled fashion.
@iftex
See the following section for
@end iftex
@ifnottex
@xref{Displaying Buffers}, for
@end ifnottex
related functions that find a window to use and specify a buffer for it.
Martin Rudalics's avatar
Martin Rudalics committed
652 653 654
The functions described there are easier to use, but they employ
heuristics in choosing or creating a window; use the functions described
here when you need complete control.
Glenn Morris's avatar
Glenn Morris committed
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669

@defun set-window-buffer window buffer-or-name &optional keep-margins
This function makes @var{window} display @var{buffer-or-name} as its
contents.  It returns @code{nil}.  @var{buffer-or-name} must be a
buffer, or the name of an existing buffer.  This is the fundamental
primitive for changing which buffer is displayed in a window, and all
ways of doing that call this function.

@example
@group
(set-window-buffer (selected-window) "foo")
     @result{} nil
@end group
@end example

Martin Rudalics's avatar
Martin Rudalics committed
670 671 672 673 674 675 676 677 678 679 680 681
Normally, displaying @var{buffer-or-name} in @var{window} resets the
window's position, display margins, fringe widths, and scroll bar
settings, to values based on the local variables of that buffer.
However, if @var{keep-margins} is non-@code{nil}, display margins and
fringe widths of @var{window} remain unchanged.  @xref{Fringes}.

This function signals an error when @var{window} is @dfn{strongly}
dedicated to its buffer (@pxref{Dedicated Windows}) and does not already
display @var{buffer-or-name}.

This function runs @code{window-scroll-functions} before running
@code{window-configuration-change-hook}.
Glenn Morris's avatar
Glenn Morris committed
682 683 684
@end defun

@defvar buffer-display-count
Martin Rudalics's avatar
Martin Rudalics committed
685
This buffer-local variable records the number of times a buffer has been
Glenn Morris's avatar
Glenn Morris committed
686 687 688 689 690
displayed in a window.  It is incremented each time
@code{set-window-buffer} is called for the buffer.
@end defvar

@defun window-buffer &optional window
Martin Rudalics's avatar
Martin Rudalics committed
691 692
This function returns the buffer that @var{window} is displaying.
@var{window} defaults to the selected window.
Glenn Morris's avatar
Glenn Morris committed
693 694 695 696 697 698 699 700 701

@example
@group
(window-buffer)
     @result{} #<buffer windows.texi>
@end group
@end example
@end defun

702
@defun get-buffer-window &optional buffer-or-name all-frames
Glenn Morris's avatar
Glenn Morris committed
703 704 705 706 707 708
This function returns a window currently displaying
@var{buffer-or-name}, or @code{nil} if there is none.  If there are
several such windows, then the function returns the first one in the
cyclic ordering of windows, starting from the selected window.
@xref{Cyclic Window Ordering}.

709 710 711
@var{BUFFER-OR-NAME} may be a buffer or a buffer name and defaults to
the current buffer.  The argument @var{all-frames} specifies which
windows to consider:
Glenn Morris's avatar
Glenn Morris committed
712 713 714

@itemize @bullet
@item
Martin Rudalics's avatar
Martin Rudalics committed
715
@code{nil} means consider windows on the selected frame.
Glenn Morris's avatar
Glenn Morris committed
716
@item
Martin Rudalics's avatar
Martin Rudalics committed
717
@code{t} means consider windows on all existing frames.
Glenn Morris's avatar
Glenn Morris committed
718
@item
Martin Rudalics's avatar
Martin Rudalics committed
719
@code{visible} means consider windows on all visible frames.
Glenn Morris's avatar
Glenn Morris committed
720
@item
Martin Rudalics's avatar
Martin Rudalics committed
721
0 means consider windows on all visible or iconified frames.
Glenn Morris's avatar
Glenn Morris committed
722
@item
Martin Rudalics's avatar
Martin Rudalics committed
723
A frame means consider windows on that frame only.
Glenn Morris's avatar
Glenn Morris committed
724
@end itemize
Martin Rudalics's avatar
Martin Rudalics committed
725 726 727 728 729 730

Observe that the behavior of @code{get-buffer-window} may differ from
that of @code{next-window} (@pxref{Cyclic Window Ordering}) when
@var{all-frames} equals @code{nil} or any value not listed here.
Perhaps we will change @code{get-buffer-window} in the future to make it
compatible with the other functions.
Glenn Morris's avatar
Glenn Morris committed
731 732
@end defun

733 734 735
@defun get-buffer-window-list &optional buffer-or-name minibuf all-frames
This function returns a list of all windows currently displaying
@var{buffer-or-name}.  @var{buffer-or-name} may be a buffer or the name
Martin Rudalics's avatar
Martin Rudalics committed
736
of an existing buffer and defaults to the current buffer.
Glenn Morris's avatar
Glenn Morris committed
737

Martin Rudalics's avatar
Martin Rudalics committed
738 739 740
The two remaining arguments work like the same-named arguments of
@code{next-window}; they are @emph{not} like the optional arguments of
@code{get-buffer-window}.
Glenn Morris's avatar
Glenn Morris committed
741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767
@end defun

@defvar buffer-display-time
This variable records the time at which a buffer was last made visible
in a window.  It is always local in each buffer; each time
@code{set-window-buffer} is called, it sets this variable to
@code{(current-time)} in the specified buffer (@pxref{Time of Day}).
When a buffer is first created, @code{buffer-display-time} starts out
with the value @code{nil}.
@end defvar

@node Displaying Buffers
@section Displaying Buffers in Windows
@cindex switching to a buffer
@cindex displaying a buffer

  In this section we describe convenient functions that choose a window
automatically and use it to display a specified buffer.  These functions
can also split an existing window in certain circumstances.  We also
describe variables that parameterize the heuristics used for choosing a
window.
@iftex
See the preceding section for
@end iftex
@ifnottex
@xref{Buffers and Windows}, for
@end ifnottex
768
low-level primitives that give you more precise control.  All of these
Glenn Morris's avatar
Glenn Morris committed
769 770 771 772 773 774 775 776 777 778 779 780 781 782 783
functions work by calling @code{set-window-buffer}.

  Do not use the functions in this section in order to make a buffer
current so that a Lisp program can access or modify it; they are too
drastic for that purpose, since they change the display of buffers in
windows, which would be gratuitous and surprise the user.  Instead, use
@code{set-buffer} and @code{save-current-buffer} (@pxref{Current
Buffer}), which designate buffers as current for programmed access
without affecting the display of buffers in windows.

@deffn Command switch-to-buffer buffer-or-name &optional norecord
This function makes @var{buffer-or-name} the current buffer, and also
displays the buffer in the selected window.  This means that a human can
see the buffer and subsequent keyboard commands will apply to it.
Contrast this with @code{set-buffer}, which makes @var{buffer-or-name}
Martin Rudalics's avatar
Martin Rudalics committed
784
the current buffer but does not display it in the selected window,
Glenn Morris's avatar
Glenn Morris committed
785 786
@xref{Current Buffer}.

Martin Rudalics's avatar
Martin Rudalics committed
787 788 789 790 791
If @var{buffer-or-name} is @code{nil}, @code{switch-to-buffer} chooses a
buffer using @code{other-buffer}.  If @var{buffer-or-name} is a string
that does not identify an existing buffer, then a new buffer by that
name is created.  The major mode for the new buffer is set according to
the variable @code{default-major-mode}, @xref{Auto Major Mode}.
Glenn Morris's avatar
Glenn Morris committed
792

793 794 795 796 797 798
When @code{enable-recursive-minibuffers} is non-@code{nil} and the
selected window is either the minibuffer window or is dedicated to its
buffer (@pxref{Dedicated Windows}), @code{switch-to-buffer} calls
@code{pop-to-buffer} (see below) to display the buffer in some other
window.

Glenn Morris's avatar
Glenn Morris committed
799 800 801 802 803 804 805 806 807 808 809 810 811 812 813
Normally the specified buffer is put at the front of the buffer list
(both the selected frame's buffer list and the frame-independent buffer
list).  This affects the operation of @code{other-buffer}.  However, if
@var{norecord} is non-@code{nil}, this is not done.  @xref{The Buffer
List}.

The @code{switch-to-buffer} function is often used interactively, as
the binding of @kbd{C-x b}.  It is also used frequently in programs.  It
returns the buffer that it switched to.
@end deffn

The next two functions are similar to @code{switch-to-buffer}, except
for the described features.

@deffn Command switch-to-buffer-other-window buffer-or-name &optional norecord
Martin Rudalics's avatar
Martin Rudalics committed
814 815 816
This function makes @var{buffer-or-name} the current buffer, displays it
in a window not currently selected, and selects that window.  The
handling of the buffer is the same as in @code{switch-to-buffer}.
Glenn Morris's avatar
Glenn Morris committed
817 818 819 820 821 822 823 824 825 826 827

The currently selected window is absolutely never used to do the job.
If it is the only window, then it is split to make a distinct window for
this purpose.  If the selected window is already displaying the buffer,
then it continues to do so, but another window is nonetheless found to
display it in as well.

This function updates the buffer list just like @code{switch-to-buffer}
unless @var{norecord} is non-@code{nil}.
@end deffn

Martin Rudalics's avatar
Martin Rudalics committed
828 829
@deffn Command pop-to-buffer buffer-or-name &optional other-window norecord
This command makes @var{buffer-or-name} the current buffer and switches
830 831
to it in some window, preferably not the window previously selected.
The ``popped-to'' window becomes the selected window.  Its frame is
Martin Rudalics's avatar
Martin Rudalics committed
832 833 834 835 836 837 838 839
given the X server's focus, if possible, @xref{Input Focus}.  The return
value is the buffer that was switched to.

If @var{buffer-or-name} is @code{nil}, that means to choose some other
buffer, but you don't specify which.  If @var{buffer-or-name} is a
string that does not name an existing buffer, a buffer by that name is
created.  The major mode for the new buffer is set according to the
variable @code{default-major-mode}.  @xref{Auto Major Mode}.
Glenn Morris's avatar
Glenn Morris committed
840 841 842

If the variable @code{pop-up-frames} is non-@code{nil},
@code{pop-to-buffer} looks for a window in any visible frame already
Martin Rudalics's avatar
Martin Rudalics committed
843 844 845
displaying the buffer; if there is one, it selects and returns that
window.  If no such window exists, it creates a new frame and displays
the buffer in it.
Glenn Morris's avatar
Glenn Morris committed
846 847 848 849 850 851

If @code{pop-up-frames} is @code{nil}, then @code{pop-to-buffer}
operates entirely within the selected frame.  (If the selected frame has
just a minibuffer, @code{pop-to-buffer} operates within the most
recently selected frame that was not just a minibuffer.)

Martin Rudalics's avatar
Martin Rudalics committed
852 853 854
If the variable @code{pop-up-windows} is non-@code{nil}, windows may be
split to create a new window that is different from the original window.
For details, @xref{Choosing Window}.
Glenn Morris's avatar
Glenn Morris committed
855 856 857 858 859 860

If @var{other-window} is non-@code{nil}, @code{pop-to-buffer} finds or
creates another window even if @var{buffer-or-name} is already visible
in the selected window.  Thus @var{buffer-or-name} could end up
displayed in two windows.  On the other hand, if @var{buffer-or-name} is
already displayed in the selected window and @var{other-window} is
Martin Rudalics's avatar
Martin Rudalics committed
861 862
@code{nil}, then the selected window is considered sufficient for
displaying @var{buffer-or-name}, so that nothing needs to be done.
Glenn Morris's avatar
Glenn Morris committed
863 864 865 866 867 868

All the variables that affect @code{display-buffer} affect
@code{pop-to-buffer} as well.  @xref{Choosing Window}.

This function updates the buffer list just like @code{switch-to-buffer}
unless @var{norecord} is non-@code{nil}.
Martin Rudalics's avatar
Martin Rudalics committed
869
@end deffn
Glenn Morris's avatar
Glenn Morris committed
870

871
@deffn Command replace-buffer-in-windows &optional buffer-or-name
872 873 874
This function replaces @var{buffer-or-name} in all windows displaying
it with some other buffer.  It uses @code{other-buffer} to choose the
other buffer.  In the usual applications of this function, you
Glenn Morris's avatar
Glenn Morris committed
875 876 877
don't care which other buffer is used; you just want to make sure that
@var{buffer-or-name} is no longer displayed.

878 879 880
@var{buffer-or-name} may be a buffer or the name of an existing buffer
and defaults to the current buffer.

Martin Rudalics's avatar
Martin Rudalics committed
881 882 883 884 885 886
If a window displaying @var{buffer-or-name} is dedicated
(@pxref{Dedicated Windows}), and is not the only window on its frame,
that window is deleted.  If that window is the only window on its frame
and there are other frames left, the window's frame is deleted too.  If
there are no other frames left, some other buffer is displayed in that
window.
887

Glenn Morris's avatar
Glenn Morris committed
888 889 890 891 892 893 894
This function returns @code{nil}.
@end deffn

@node Choosing Window
@section Choosing a Window for Display

  This section describes the basic facility that chooses a window to
Martin Rudalics's avatar
Martin Rudalics committed
895 896 897 898
display a buffer in---@code{display-buffer}.  Higher-level functions and
commands like @code{switch-to-buffer} and @code{pop-to-buffer} use this
subroutine.  Here we describe how to use @code{display-buffer} and how
to customize it.
Glenn Morris's avatar
Glenn Morris committed
899 900

@deffn Command display-buffer buffer-or-name &optional not-this-window frame
901 902 903
This command makes @var{buffer-or-name} appear in some window, but it
does not select that window and does not make the buffer specified by
@var{buffer-or-name} current.  The identity of the selected window is
Glenn Morris's avatar
Glenn Morris committed
904 905 906
unaltered by this function.  @var{buffer-or-name} must be a buffer, or
the name of an existing buffer.

Martin Rudalics's avatar
Martin Rudalics committed
907 908 909 910 911 912
@var{not-this-window} non-@code{nil} means to display the specified
buffer in a window other than the selected one, even if it is already
displayed in the selected window.  This can cause the buffer to appear
in two windows at once.  Otherwise, if @var{buffer-or-name} is already
being displayed in any window, that is good enough, so this function
does nothing.
Glenn Morris's avatar
Glenn Morris committed
913 914 915 916 917 918 919 920 921 922 923 924

@code{display-buffer} returns the window chosen to display
@var{buffer-or-name}.

If the argument @var{frame} is non-@code{nil}, it specifies which frames
to check when deciding whether the buffer is already displayed.  If the
buffer is already displayed in some window on one of these frames,
@code{display-buffer} simply returns that window.  Here are the possible
values of @var{frame}:

@itemize @bullet
@item
Martin Rudalics's avatar
Martin Rudalics committed
925
@code{nil} means consider windows on the selected frame.
Glenn Morris's avatar
Glenn Morris committed
926 927
(Actually, the last non-minibuffer frame.)
@item
Martin Rudalics's avatar
Martin Rudalics committed
928
@code{t} means consider windows on all frames.
Glenn Morris's avatar
Glenn Morris committed
929
@item
Martin Rudalics's avatar
Martin Rudalics committed
930
@code{visible} means consider windows on all visible frames.
Glenn Morris's avatar
Glenn Morris committed
931
@item
Martin Rudalics's avatar
Martin Rudalics committed
932
0 means consider windows on all visible or iconified frames.
Glenn Morris's avatar
Glenn Morris committed
933
@item
Martin Rudalics's avatar
Martin Rudalics committed
934
A frame means consider windows on that frame only.
Glenn Morris's avatar
Glenn Morris committed
935 936 937 938 939 940
@end itemize

Precisely how @code{display-buffer} finds or creates a window depends on
the variables described below.
@end deffn

941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961
@defopt display-buffer-reuse-frames
If this variable is non-@code{nil}, @code{display-buffer} searches
existing frames for a window displaying @var{buffer-or-name}.  If the
buffer is already displayed in a window in some frame,
@code{display-buffer} makes the frame visible and raises it, to use that
window.  If the buffer is not already displayed, or
@code{display-buffer-reuse-frames} is @code{nil}, the behavior of
@code{display-buffer} is determined by the variables described next.
@end defopt

@defopt pop-up-windows
This variable specifies whether @code{display-buffer} is allowed to
split (@pxref{Splitting Windows}) an existing window .  If it is
non-@code{nil}, @code{display-buffer} tries to the split the largest or
least recently used window on the selected frame.  (If the selected
frame is a minibuffer-only frame, it tries to split a window on another
frame instead.)  If @code{pop-up-windows} is nil or the variable
@code{pop-up-frames} (see below) is non-@code{nil},
@code{display-buffer} does not split any window.
@end defopt

962
@defvar split-window-preferred-function
963 964 965 966
This variable specifies how to split a window.  Its value, if
non-@code{nil}, should be a function of one argument, which is a
window.  If this variable specifies a function, @code{display-buffer}
will call it with one or more candidate windows when it looks for a
967
window to split.  If the argument window fits, the function is
968
expected to split it and return a new window.  If the function returns
969
@code{nil}, the argument window will not be split.
970 971

If the value of this variable is @code{nil}, @code{display-buffer}
972
uses the two variables described next to decide whether and which
973 974
window to split.
@end defvar
975

Glenn Morris's avatar
Glenn Morris committed
976
@defopt split-height-threshold
977 978 979 980 981 982 983 984 985 986 987 988 989 990 991
This variable specifies whether @code{display-buffer} may split a window
vertically, provided there are multiple windows.  If the value is a
number, @code{display-buffer} splits a window only if it has at least
this many lines.  If no window is tall enough, or if the value of this
variable is @code{nil}, @code{display-buffer} tries to split some window
horizontally, subject to restrictions of @code{split-width-threshold}
(see below).  If splitting horizontally is impossible too,
@code{display-buffer} splits a window vertically only if it's the only
window on its frame and not the minibuffer window, and only if
@code{pop-up-windows} is non-@code{nil}.

A window whose height is fixed (@pxref{Resizing Windows}) cannot be
split vertically by @code{display-buffer}.  Also, @code{display-buffer}
splits a window vertically only if it can accommodate two windows that
are both at least `window-min-height' lines tall.  Moreover, if the
Martin Rudalics's avatar
Martin Rudalics committed
992
window that shall be split has a mode line, the window must be at least
993
four lines tall in order to make sure that the new window can have a
Martin Rudalics's avatar
Martin Rudalics committed
994
mode line as well.  If the original window doesn't have a mode line, a
995
height of two lines suffices.
996 997 998
@end defopt

@defopt split-width-threshold
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
This variable specifies whether @code{display-buffer} may split a window
horizontally.  If the value is a number, @code{display-buffer} may split
a window if it has at least this many columns.  If the value of this
variable is @code{nil}, @code{display-buffer} will not split any windows
horizontally.  (It still might split some window vertically, though, see
above.)

A window whose width is fixed (@pxref{Resizing Windows}) cannot be split
horizontally by @code{display-buffer}.  Also, @code{display-buffer}
splits a window horizontally only if it can accommodate two windows that
are both at least `window-min-width' columns wide.
Glenn Morris's avatar
Glenn Morris committed
1010 1011 1012
@end defopt

@defopt even-window-heights
Eli Zaretskii's avatar
Eli Zaretskii committed
1013
This variable specifies whether @code{display-buffer} should even out
1014 1015 1016 1017 1018 1019
window heights if the buffer gets displayed in an existing window, above
or beneath another window.  If @code{even-window-heights} is
non-@code{nil}, the default, window heights will be evened out.  If
either of the involved window has fixed height (@pxref{Resizing
Windows}) or @code{even-window-heights} is @code{nil}, the original
window heights will be left alone.
Glenn Morris's avatar
Glenn Morris committed
1020 1021 1022 1023
@end defopt

@c Emacs 19 feature
@defopt pop-up-frames
Eli Zaretskii's avatar
Eli Zaretskii committed
1024
This variable specifies whether @code{display-buffer} makes new frames.
Glenn Morris's avatar
Glenn Morris committed
1025
If it is non-@code{nil}, @code{display-buffer} looks for an existing
1026 1027 1028
window already displaying the desired buffer, on any visible frame.  If
it finds one, it returns that window.  Otherwise it makes a new frame,
unless the variable's value is @code{graphic-only} and the selected
Martin Rudalics's avatar
Martin Rudalics committed
1029
frame is not on a graphic display.  @xref{Frames}, for more information.
Glenn Morris's avatar
Glenn Morris committed
1030

Martin Rudalics's avatar
Martin Rudalics committed
1031 1032 1033 1034
Note that the value of @code{pop-up-windows} does not matter if
@code{pop-up-frames} is non-@code{nil}.  If @code{pop-up-frames} is
@code{nil}, then @code{display-buffer} either splits a window or reuses
one.
Glenn Morris's avatar
Glenn Morris committed
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
@end defopt

@c Emacs 19 feature
@defopt pop-up-frame-function
This variable specifies how to make a new frame if @code{pop-up-frames}
is non-@code{nil}.

Its value should be a function of no arguments.  When
@code{display-buffer} makes a new frame, it does so by calling that
function, which should return a frame.  The default value of the
variable is a function that creates a frame using parameters from
@code{pop-up-frame-alist}.
@end defopt

@defopt pop-up-frame-alist
This variable holds an alist specifying frame parameters used when
@code{display-buffer} makes a new frame.  @xref{Frame Parameters}, for
more information about frame parameters.
@end defopt

@defopt special-display-buffer-names
Martin Rudalics's avatar
Martin Rudalics committed
1056 1057 1058 1059
A list of buffer names identifying buffers that should be displayed
specially.  If the name of @var{buffer-or-name} is in this list,
@code{display-buffer} handles the buffer specially.  By default, special
display means to give the buffer a dedicated frame.
Glenn Morris's avatar
Glenn Morris committed
1060

1061 1062 1063 1064
If an element is a list, instead of a string, then the @sc{car} of that
list is the buffer name, and the rest of that list says how to create
the frame.  There are two possibilities for the rest of that list (its
@sc{cdr}): It can be an alist, specifying frame parameters, or it can
Glenn Morris's avatar
Glenn Morris committed
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088
contain a function and arguments to give to it.  (The function's first
argument is always the buffer to be displayed; the arguments from the
list come after that.)

For example:

@example
(("myfile" (minibuffer) (menu-bar-lines . 0)))
@end example

@noindent
specifies to display a buffer named @samp{myfile} in a dedicated frame
with specified @code{minibuffer} and @code{menu-bar-lines} parameters.

The list of frame parameters can also use the phony frame parameters
@code{same-frame} and @code{same-window}.  If the specified frame
parameters include @code{(same-window . @var{value})} and @var{value}
is non-@code{nil}, that means to display the buffer in the current
selected window.  Otherwise, if they include @code{(same-frame .
@var{value})} and @var{value} is non-@code{nil}, that means to display
the buffer in a new window in the currently selected frame.
@end defopt

@defopt special-display-regexps
Martin Rudalics's avatar
Martin Rudalics committed
1089
A list of regular expressions specifying buffers that should be
Glenn Morris's avatar
Glenn Morris committed
1090 1091
displayed specially.  If the buffer's name matches any of the regular
expressions in this list, @code{display-buffer} handles the buffer
Martin Rudalics's avatar
Martin Rudalics committed
1092 1093
specially.  By default, special display means to give the buffer a
dedicated frame.
Glenn Morris's avatar
Glenn Morris committed
1094 1095 1096

If an element is a list, instead of a string, then the @sc{car} of the
list is the regular expression, and the rest of the list says how to
Martin Rudalics's avatar
Martin Rudalics committed
1097
create the frame.  See @code{special-display-buffer-names} above.
Glenn Morris's avatar
Glenn Morris committed
1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110
@end defopt

@defun special-display-p buffer-name
This function returns non-@code{nil} if displaying a buffer
named @var{buffer-name} with @code{display-buffer} would
create a special frame.  The value is @code{t} if it would
use the default frame parameters, or else the specified list
of frame parameters.
@end defun

@defvar special-display-function
This variable holds the function to call to display a buffer specially.
It receives the buffer as an argument, and should return the window in
Martin Rudalics's avatar
Martin Rudalics committed
1111 1112
which it is displayed.  The default value of this variable is
@code{special-display-popup-frame}, see below.
Glenn Morris's avatar
Glenn Morris committed
1113 1114 1115
@end defvar

@defun special-display-popup-frame buffer &optional args
Martin Rudalics's avatar
Martin Rudalics committed
1116 1117 1118 1119 1120
This function tries to make @var{buffer} visible in a frame of its own.
If @var{buffer} is already displayed in some window, it makes that
window's frame visible and raises it.  Otherwise, it creates a frame
that is dedicated to @var{buffer}.  The return value is the window used
to display @var{buffer}.
Glenn Morris's avatar
Glenn Morris committed
1121 1122

If @var{args} is an alist, it specifies frame parameters for the new
Martin Rudalics's avatar
Martin Rudalics committed
1123 1124 1125 1126
frame.  If @var{args} is a list whose @sc{car} is a symbol, then
@code{(car @var{args})} is called as a function to actually create and
set up the frame; it is called with @var{buffer} as first argument, and
@code{(cdr @var{args})} as additional arguments.
Glenn Morris's avatar
Glenn Morris committed
1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168

This function always uses an existing window displaying @var{buffer},
whether or not it is in a frame of its own; but if you set up the above
variables in your init file, before @var{buffer} was created, then
presumably the window was previously made by this function.
@end defun

@defopt special-display-frame-alist
@anchor{Definition of special-display-frame-alist}
This variable holds frame parameters for
@code{special-display-popup-frame} to use when it creates a frame.
@end defopt

@defopt same-window-buffer-names
A list of buffer names for buffers that should be displayed in the
selected window.  If the buffer's name is in this list,
@code{display-buffer} handles the buffer by switching to it in the
selected window.
@end defopt

@defopt same-window-regexps
A list of regular expressions that specify buffers that should be
displayed in the selected window.  If the buffer's name matches any of
the regular expressions in this list, @code{display-buffer} handles the
buffer by switching to it in the selected window.
@end defopt

@defun same-window-p buffer-name
This function returns @code{t} if displaying a buffer
named @var{buffer-name} with @code{display-buffer} would
put it in the selected window.
@end defun

@c Emacs 19 feature
@defvar display-buffer-function
This variable is the most flexible way to customize the behavior of
@code{display-buffer}.  If it is non-@code{nil}, it should be a function
that @code{display-buffer} calls to do the work.  The function should
accept two arguments, the first two arguments that @code{display-buffer}
received.  It should choose or create a window, display the specified
buffer in it, and then return the window.

1169 1170
This variable takes precedence over all the other options described
above.
Glenn Morris's avatar
Glenn Morris committed
1171 1172
@end defvar

1173
If all options described above fail to produce a suitable window,
Martin Rudalics's avatar
Martin Rudalics committed
1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208
@code{display-buffer} tries to reuse an existing window.  As a last
resort, it will try to display @var{buffer-or-name} on a separate frame.
In that case, the value of @code{pop-up-frames} is disregarded.

@node Dedicated Windows
@section Dedicated Windows
@cindex dedicated window

Functions for displaying a buffer can be told to not use specific
windows by marking these window as @dfn{dedicated} to their buffers.
@code{display-buffer} (@pxref{Choosing Window}) never uses a dedicated
window for displaying another buffer in it.  @code{get-lru-window} and
@code{get-largest-window} (@pxref{Selecting Windows}) do not consider
dedicated windows as candidates when their @var{dedicated} argument is
non-@code{nil}.  The behavior of @code{set-window-buffer}
(@pxref{Buffers and Windows}) with respect to dedicated windows is
slightly different, see below.

When @code{delete-windows-on} (@pxref{Deleting Windows}) wants to delete
a dedicated window and that window is the only window on its frame, it
deletes the window's frame too, provided there are other frames left.
@code{replace-buffer-in-windows} (@pxref{Displaying Buffers}) tries to
delete all dedicated windows showing its buffer argument.  When such a
window is the only window on its frame, that frame is deleted, provided
there are other frames left.  If there are no more frames left, some
other buffer is displayed in the window, and the window is marked as
non-dedicated.

When you kill a buffer (@pxref{Killing Buffers}) displayed in a
dedicated window, any such window usually gets deleted too, since
@code{kill-buffer} calls @code{replace-buffer-in-windows} for cleaning
up windows.  Burying a buffer (@pxref{The Buffer List}) deletes the
selected window if it is dedicated and shows that buffer.  However, if
that window is the only window on its frame, another buffer is displayed
in it and the frame is iconified.
1209 1210

@defun window-dedicated-p &optional window
1211 1212 1213 1214
This function returns non-@code{nil} if @var{window} is dedicated to its
buffer and @code{nil} otherwise.  More precisely, the return value is
the value assigned by the last call of @code{set-window-dedicated-p} for
@var{window} or @code{nil} if that function was never called with
Martin Rudalics's avatar
Martin Rudalics committed
1215 1216
@var{WINDOW} as its argument.  @var{WINDOW} defaults to the selected
window.
Glenn Morris's avatar
Glenn Morris committed
1217 1218 1219
@end defun

@defun set-window-dedicated-p window flag
1220 1221 1222
This function marks @var{window} as dedicated to its buffer if
@var{flag} is non-@code{nil}, and non-dedicated otherwise.

Martin Rudalics's avatar
Martin Rudalics committed
1223 1224 1225 1226 1227 1228 1229 1230
As a special case, if @var{flag} is @code{t}, @var{window} becomes
@dfn{strongly} dedicated to its buffer.  @code{set-window-buffer}
signals an error when the window it acts upon is strongly dedicated to
its buffer and does not already display the buffer it is asked to
display.  In any other case, @code{set-window-buffer} will display
another buffer in that window.  Other functions do not treat @code{t}
differently from any non-@code{nil} value.
@end defun
1231

Glenn Morris's avatar
Glenn Morris committed
1232 1233 1234 1235 1236 1237 1238
@node Window Point
@section Windows and Point
@cindex window position
@cindex window point
@cindex position in window
@cindex point in window

Martin Rudalics's avatar
Martin Rudalics committed
1239 1240 1241
  Each window has its own value of point (@pxref{Point}), independent of
the value of point in other windows displaying the same buffer.  This
makes it useful to have multiple windows showing one buffer.
Glenn Morris's avatar
Glenn Morris committed
1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262

@itemize @bullet
@item
The window point is established when a window is first created; it is
initialized from the buffer's point, or from the window point of another
window opened on the buffer if such a window exists.

@item
Selecting a window sets the value of point in its buffer from the
window's value of point.  Conversely, deselecting a window sets the
window's value of point from that of the buffer.  Thus, when you switch
between windows that display a given buffer, the point value for the
selected window is in effect in the buffer, while the point values for
the other windows are stored in those windows.

@item
As long as the selected window displays the current buffer, the window's
point and the buffer's point always move together; they remain equal.
@end itemize

@cindex cursor
Martin Rudalics's avatar
Martin Rudalics committed
1263
As far as the user is concerned, point is where the cursor is, and
Glenn Morris's avatar
Glenn Morris committed
1264 1265 1266 1267 1268 1269
when the user switches to another buffer, the cursor jumps to the
position of point in that buffer.

@defun window-point &optional window
This function returns the current position of point in @var{window}.
For a nonselected window, this is the value point would have (in that
Martin Rudalics's avatar
Martin Rudalics committed
1270 1271
window's buffer) if that window were selected.  @var{window} defaults to
the selected window.
Glenn Morris's avatar
Glenn Morris committed
1272 1273 1274

When @var{window} is the selected window and its buffer is also the
current buffer, the value returned is the same as point in that buffer.
Martin Rudalics's avatar
Martin Rudalics committed
1275 1276 1277
Strictly speaking, it would be more correct to return the ``top-level''
value of point, outside of any @code{save-excursion} forms.  But that
value is hard to find.
Glenn Morris's avatar
Glenn Morris committed
1278 1279 1280 1281 1282 1283 1284 1285 1286 1287
@end defun

@defun set-window-point window position
This function positions point in @var{window} at position
@var{position} in @var{window}'s buffer.  It returns @var{position}.

If @var{window} is selected, and its buffer is current,
this simply does @code{goto-char}.
@end defun

1288 1289 1290 1291 1292 1293
@defvar window-point-insertion-type
This variable specifies the marker insertion type (@pxref{Marker
Insertion Types}) of @code{window-point}.  The default is @code{nil},
so @code{window-point} will stay behind text inserted there.
@end defvar

Martin Rudalics's avatar
Martin Rudalics committed
1294 1295
@node Window Start and End
@section The Window Start and End Positions
Glenn Morris's avatar
Glenn Morris committed
1296 1297
@cindex window start position

Martin Rudalics's avatar
Martin Rudalics committed
1298
  Each window maintains a marker used to keep track of a buffer position
Glenn Morris's avatar
Glenn Morris committed
1299 1300 1301 1302 1303 1304
that specifies where in the buffer display should start.  This position
is called the @dfn{display-start} position of the window (or just the
@dfn{start}).  The character after this position is the one that appears
at the upper left corner of the window.  It is usually, but not
inevitably, at the beginning of a text line.

1305 1306 1307 1308 1309 1310 1311 1312 1313
  After switching windows or buffers, and in some other cases, if the
window start is in the middle of a line, Emacs adjusts the window
start to the start of a line.  This prevents certain operations from
leaving the window start at a meaningless point within a line.  This
feature may interfere with testing some Lisp code by executing it
using the commands of Lisp mode, because they trigger this
readjustment.  To test such code, put it into a command and bind the
command to a key.

Glenn Morris's avatar
Glenn Morris committed
1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328
@defun window-start &optional window
@cindex window top line
This function returns the display-start position of window
@var{window}.  If @var{window} is @code{nil}, the selected window is
used.  For example,

@example
@group
(window-start)
     @result{} 7058
@end group
@end example

When you create a window, or display a different buffer in it, the
display-start position is set to a display-start position recently used
Martin Rudalics's avatar
Martin Rudalics committed
1329 1330
for the same buffer, or to @code{point-min} if the buffer doesn't have
any.
Glenn Morris's avatar
Glenn Morris committed
1331 1332

Redisplay updates the window-start position (if you have not specified
Martin Rudalics's avatar
Martin Rudalics committed
1333 1334 1335 1336
it explicitly since the previous redisplay)---to make sure point appears
on the screen.  Nothing except redisplay automatically changes the
window-start position; if you move point, do not expect the window-start
position to change in response until after the next redisplay.
Glenn Morris's avatar
Glenn Morris committed
1337 1338 1339 1340 1341

For a realistic example of using @code{window-start}, see the
description of @code{count-lines}.  @xref{Definition of count-lines}.
@end defun

Martin Rudalics's avatar
Martin Rudalics committed
1342
@cindex window end position
Glenn Morris's avatar
Glenn Morris committed
1343
@defun window-end &optional window update
Martin Rudalics's avatar
Martin Rudalics committed
1344 1345
This function returns the position where display of its buffer ends in
@var{window}.  @var{window} defaults to the selected window.
Glenn Morris's avatar
Glenn Morris committed
1346 1347 1348 1349 1350 1351 1352 1353 1354 1355

Simply changing the buffer text or moving point does not update the
value that @code{window-end} returns.  The value is updated only when
Emacs redisplays and redisplay completes without being preempted.

If the last redisplay of @var{window} was preempted, and did not finish,
Emacs does not know the position of the end of display in that window.
In that case, this function returns @code{nil}.

If @var{update} is non-@code{nil}, @code{window-end} always returns an
Martin Rudalics's avatar
Martin Rudalics committed
1356 1357 1358 1359
up-to-date value for where display ends, based on the current
@code{window-start} value.  If a previously saved value of that position
is still valid, @code{window-end} returns that value; otherwise it
computes the correct value by scanning the buffer text.
Glenn Morris's avatar
Glenn Morris committed
1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380

Even if @var{update} is non-@code{nil}, @code{window-end} does not
attempt to scroll the display if point has moved off the screen, the
way real redisplay would do.  It does not alter the
@code{window-start} value.  In effect, it reports where the displayed
text will end if scrolling is not required.
@end defun

@defun set-window-start window position &optional noforce
This function sets the display-start position of @var{window} to
@var{position} in @var{window}'s buffer.  It returns @var{position}.

The display routines insist that the position of point be visible when a
buffer is displayed.  Normally, they change the display-start position
(that is, scroll the window) whenever necessary to make point visible.
However, if you specify the start position with this function using
@code{nil} for @var{noforce}, it means you want display to start at
@var{position} even if that would put the location of point off the
screen.  If this does place point off screen, the display routines move
point to the left margin on the middle line in the window.

1381 1382 1383 1384
For example, if point @w{is 1} and you set the start of the window
@w{to 37}, the start of the next line, point will be ``above'' the top
of the window.  The display routines will automatically move point if
it is still 1 when redisplay occurs.  Here is an example:
Glenn Morris's avatar
Glenn Morris committed
1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405

@example
@group
;; @r{Here is what @samp{foo} looks like before executing}
;;   @r{the @code{set-window-start} expression.}
@end group

@group
---------- Buffer: foo ----------
@point{}This is the contents of buffer foo.
2
3
4
5
6
---------- Buffer: foo ----------
@end group

@group
(set-window-start
 (selected-window)
1406 1407 1408 1409 1410
 (save-excursion
   (goto-char 1)
   (forward-line 1)
   (point)))
@result{} 37
Glenn Morris's avatar
Glenn Morris committed
1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433
@end group

@group
;; @r{Here is what @samp{foo} looks like after executing}
;;   @r{the @code{set-window-start} expression.}
---------- Buffer: foo ----------
2
3
@point{}4
5
6
---------- Buffer: foo ----------
@end group
@end example

If @var{noforce} is non-@code{nil}, and @var{position} would place point
off screen at the next redisplay, then redisplay computes a new window-start
position that works well with point, and thus @var{position} is not used.
@end defun

@defun pos-visible-in-window-p &optional position window partially
This function returns non-@code{nil} if @var{position} is within the
range of text currently visible on the screen in @var{window}.  It
Martin Rudalics's avatar
Martin Rudalics committed
1434 1435 1436 1437 1438 1439
returns @code{nil} if @var{position} is scrolled vertically out of view.
Locations that are partially obscured are not considered visible unless
@var{partially} is non-@code{nil}.  The argument @var{position} defaults
to the current position of point in @var{window}; @var{window}, to the
selected window.  If @var{position} is @code{t}, that means to check the
last visible position in @var{window}.
Glenn Morris's avatar
Glenn Morris committed
1440 1441 1442 1443 1444 1445 1446 1447

The @code{pos-visible-in-window-p} function considers only vertical
scrolling.  If @var{position} is out of view only because @var{window}
has been scrolled horizontally, @code{pos-visible-in-window-p} returns
non-@code{nil} anyway.  @xref{Horizontal Scrolling}.

If @var{position} is visible, @code{pos-visible-in-window-p} returns
@code{t} if @var{partially} is @code{nil}; if @var{partially} is
Martin Rudalics's avatar
Martin Rudalics committed
1448
non-@code{nil}, and the character following @var{position} is fully
Glenn Morris's avatar
Glenn Morris committed
1449 1450
visible, it returns a list of the form @code{(@var{x} @var{y})}, where
@var{x} and @var{y} are the pixel coordinates relative to the top left
Martin Rudalics's avatar
Martin Rudalics committed
1451 1452 1453 1454 1455 1456
corner of the window; otherwise it returns an extended list of the form
@code{(@var{x} @var{y} @var{rtop} @var{rbot} @var{rowh} @var{vpos})},
where @var{rtop} and @var{rbot} specify the number of off-window pixels
at the top and bottom of the row at @var{position}, @var{rowh} specifies
the visible height of that row, and @var{vpos} specifies the vertical
position (zero-based row number) of that row.
Glenn Morris's avatar
Glenn Morris committed
1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568