@c -*-texinfo-*-@c This is part of the GNU Emacs Lisp Reference Manual.@c Copyright (C) 1990, 1991, 1992, 1993, 1994 Free Software Foundation, Inc. @c See the file elisp.texi for copying conditions.@setfilename ../info/windows@node Windows, Frames, Buffers, Top@chapter Windows This chapter describes most of the functions and variables related toEmacs windows. See @ref{Display}, for information on how text isdisplayed in windows.@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-lever functions for displaying a buffer and choosing a window for it.* Choosing Window:: How to choose a window for displaying a buffer.* Window Point:: Each window has its own location of point.* Window Start:: The display-start position controls which text is on-screen in the window. * Vertical Scrolling:: Moving text up and down in the window.* Horizontal Scrolling:: Moving text 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 Configurations:: Saving and restoring the state of the screen.@end menu@node Basic Windows@section Basic Concepts of Emacs Windows@cindex window@cindex selected window A @dfn{window} is the physical area of the screen in which a buffer isdisplayed. The term is also used to refer to a Lisp object thatrepresents that screen area in Emacs Lisp. It should beclear from the context which is meant. There is always at least one window in any frame. In each frame, atany time, one and only one window is designated as @dfn{selected withinthe frame}. The frame's cursor appears in that window. There is alsoone selected frame; and the window selected within that frame is@dfn{the selected window}. The selected window's buffer is usually thecurrent buffer (except when @code{set-buffer} has been used).@xref{Current Buffer}. For practical purposes, a window exists only while it is displayed on theterminal. Once removed from the display, the window is effectivelydeleted and should not be used, @emph{even though there may still bereferences to it} from other Lisp objects. Restoring a saved windowconfiguration is the only way for a window no longer on the screen tocome back to life. (@xref{Deleting Windows}.) Each window has the following attributes:@itemize @bullet@itemcontaining frame@item window height@item window width@item window edges with respect to the screen or frame@item the buffer it displays@item position within the buffer at the upper left of the window@item amount of horizontal scrolling, in columns@item point@item the mark@item how recently the window was selected@end itemize@cindex multiple windows Users create multiple windows so they can look at several buffers atonce. Lisp libraries use multiple windows for a variety of reasons, butmost often to give different views of the same information. In Rmail,for example, you can move through a summary buffer in one window whilethe 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 thecontext of general-purpose window systems such as X, but not identical.The X Window System subdivides the screen into X windows; Emacs uses oneor more X windows, called @dfn{frames} in Emacs terminology, andsubdivides each of them into (nonoverlapping) Emacs windows. When youuse Emacs on an ordinary display terminal, Emacs subdivides the terminalscreen into Emacs windows.@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, andtogether they fill the whole screen or frame. Because of the wayin which Emacs creates new windows and resizes them, you can't createevery conceivable tiling of windows on an Emacs frame. @xref{SplittingWindows}, and @ref{Size of Window}. @xref{Display}, for information on how the contents of thewindow's buffer are displayed in the window.@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 The functions described here are the primitives used to split a windowinto two windows. Two higher level functions sometimes split a window,but not always: @code{pop-to-buffer} and @code{display-buffer}(@pxref{Displaying Buffers}). The functions described here do not accept a buffer as an argument.The two ``halves'' of the split window initially display the same bufferpreviously visible in the window that was split.@deffn Command split-window &optional window size horizontalThis function splits @var{window} into two windows. The originalwindow @var{window} remains the selected window, but occupies onlypart of its former screen area. The rest is occupied by a newly createdwindow which is returned as the value of this function. If @var{horizontal} is non-@code{nil}, then @var{window} splits intotwo side by side windows. The original window @var{window} keeps theleftmost @var{size} columns, and gives the rest of the columns to thenew window. Otherwise, it splits into windows one above the other, and@var{window} keeps the upper @var{size} lines and gives the rest of thelines to the new window. The original window is therefore theleft-hand or upper of the two, and the new window is the right-hand orlower. If @var{window} is omitted or @code{nil}, then the selected window issplit. If @var{size} is omitted or @code{nil}, then @var{window} isdivided evenly into two parts. (If there is an odd line, it isallocated to the new window.) When @code{split-window} is calledinteractively, all its arguments are @code{nil}. The following example starts with one window on a screen that is 50lines high by 80 columns wide; then the window is split.@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 smallexampleThe screen looks like this:@smallexample@group __________ | | line 0 | w | |__________| | | line 15 | w2 | |__________| line 50 column 0 column 80@end group@end smallexampleNext, the top window is split 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 smallexampleNow, 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 smallexampleNormally, Emacs indicates the border between two side-by-side windowswith a scroll bar (@pxref{X Frame Parameters,Scroll Bars}) or @samp{|}characters. The display table can specify alternative bordercharacters; see @ref{Display Tables}.@end deffn@deffn Command split-window-vertically sizeThis function splits the selected window into two windows, one abovethe other, leaving the selected window with @var{size} lines.This function is simply an interface to @code{split-windows}.Here is the complete function definition for it:@smallexample@group(defun split-window-vertically (&optional arg) "Split current window into two windows, one above the other." (interactive "P") (split-window nil (and arg (prefix-numeric-value arg))))@end group@end smallexample@end deffn@deffn Command split-window-horizontally sizeThis function splits the selected window into two windowsside-by-side, leaving the selected window with @var{size} columns.This function is simply an interface to @code{split-windows}. Here isthe complete definition for @code{split-window-horizontally} (except forpart of the documentation string):@smallexample@group(defun split-window-horizontally (&optional arg) "Split selected window into two windows, side by side..." (interactive "P") (split-window nil (and arg (prefix-numeric-value arg)) t))@end group@end smallexample@end deffn@defun one-window-p &optional no-mini all-framesThis function returns non-@code{nil} if there is only one window. Theargument @var{no-mini}, if non-@code{nil}, means don't count theminibuffer even if it is active; otherwise, the minibuffer window isincluded, if active, in the total number of windows, which is comparedagainst one.The argument @var{all-frames} specifies which frames to consider. Hereare the possible values and their meanings:@table @asis@item @code{nil}Count the windows in the selected frame, plus the minibuffer usedby 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 anything elseCount precisely the windows in the selected frame, and no others.@end table@end defun@node Deleting Windows@section Deleting Windows@cindex deleting windowsA window remains visible on its frame unless you @dfn{delete} it bycalling certain functions that delete windows. A deleted window cannotappear on the screen, but continues to exist as a Lisp object untilthere are no references to it. There is no way to cancel the deletionof a window aside from restoring a saved window configuration(@pxref{Window Configurations}). Restoring a window configuration alsodeletes any windows that aren't part of that configuration. When you delete a window, the space it took up is given to oneadjacent sibling. (In Emacs version 18, the space was divided evenlyamong all the siblings.)@c Emacs 19 feature@defun window-live-p windowThis function returns @code{nil} if @var{window} is deleted, and@code{t} otherwise.@strong{Warning:} Erroneous information or fatal errors may result fromusing a deleted window as if it were live.@end defun@deffn Command delete-window &optional windowThis function removes @var{window} from the display. If @var{window}is omitted, then the selected window is deleted. An error is signaledif there is only one window when @code{delete-window} is called.This function returns @code{nil}.When @code{delete-window} is called interactively, @var{window}defaults to the selected window.@end deffn@deffn Command delete-other-windows &optional windowThis function makes @var{window} the only window on its frame, bydeleting the other windows in that frame. If @var{window} is omitted or@code{nil}, then the selected window is used by default.The result is @code{nil}.@end deffn@deffn Command delete-windows-on buffer &optional frameThis function deletes all windows showing @var{buffer}. If there areno windows showing @var{buffer}, it does nothing.@code{delete-windows-on} operates frame by frame. If a frame hasseveral windows showing different buffers, then those showing@var{buffer} are removed, and the others expand to fill the space. Ifall windows in some frame are showing @var{buffer} (including the casewhere there is only one window), then the frame reverts to having asingle window showing another buffer chosen with @code{other-buffer}.@xref{The Buffer List}.The argument @var{frame} controls which frames to operate on:@itemize @bullet@itemIf it is @code{nil}, operate on the selected frame.@itemIf it is @code{t}, operate on all frames.@itemIf it is @code{visible}, operate on all visible frames.@itemIf it is a frame, operate on that frame.@end itemizeThis function always returns @code{nil}.@end deffn@node Selecting Windows@section Selecting Windows@cindex selecting windows When a window is selected, the buffer in the window becomes the currentbuffer, and the cursor will appear in it.@defun selected-windowThis function returns the selected window. This is the window inwhich the cursor appears and to which many commands apply.@end defun@defun select-window windowThis function makes @var{window} the selected window. The cursor thenappears in @var{window} (on redisplay). The buffer being displayed in@var{window} is immediately designated the current buffer.The return value is @var{window}.@example@group(setq w (next-window))(select-window w) @result{} #<window 65 on windows.texi>@end group@end example@end defun@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 frameThis function returns the window least recently ``used'' (that is,selected). The selected window is always the most recently used window.The selected window can be the least recently used window if it is theonly window. A newly created window becomes the least recently usedwindow until it is selected. A minibuffer window is never a candidate.The argument @var{frame} controls which windows are considered.@itemize @bullet@itemIf it is @code{nil}, consider windows on the selected frame.@itemIf it is @code{t}, consider windows on all frames.@itemIf it is @code{visible}, consider windows on all visible frames.@itemIf it is a frame, consider windows on that frame.@end itemize@end defun@defun get-largest-window &optional frameThis function returns the window with the largest area (height timeswidth). If there are no side-by-side windows, then this is the windowwith the most lines. A minibuffer window is never a candidate.If there are two windows of the same size, then the function returnsthe window that is first in the cyclic ordering of windows (seefollowing section), starting from the selected window.The argument @var{frame} controls which set of windows areconsidered. See @code{get-lru-window}, above.@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 selectthe next window, it moves through all the windows on the screen in aspecific cyclic order. For any given configuration of windows, thisorder never varies. It is called the @dfn{cyclic ordering of windows}. This ordering generally goes from top to bottom, and from left toright. But it may go down first or go right first, depending on theorder in which the windows were split. If the first split was vertical (into windows one above each other),and then the subwindows were split horizontally, then the ordering isleft to right in the top of the frame, and then left to right in thenext lower part of the frame, and so on. If the first split washorizontal, the ordering is top to bottom in the left part, and so on.In general, within each set of siblings at any level in the window tree,the order is left to right, or top to bottom.@defun next-window &optional window minibuf all-frames@cindex minibuffer windowThis function returns the window following @var{window} in the cyclicordering of windows. This is the window that @kbd{C-x o} would selectif typed when @var{window} is selected. If @var{window} is the onlywindow visible, then this function returns @var{window}. If omitted,@var{window} defaults to the selected window.The value of the argument @var{minibuf} determines whether theminibuffer is included in the window order. Normally, when@var{minibuf} is @code{nil}, the minibuffer is included if it iscurrently active; this is the behavior of @kbd{C-x o}. (The minibufferwindow is active while the minibuffer is in use. @xref{Minibuffers}.)If @var{minibuf} is @code{t}, then the cyclic ordering includes theminibuffer window even if it is not active.If @var{minibuf} is neither @code{t} nor @code{nil}, then the minibufferwindow is not included even if it is active.The argument @var{all-frames} specifies which frames to consider. Hereare the possible values and their meanings:@table @asis@item @code{nil}Consider all the windows in @var{window}'s frame, plus the minibufferused by that frame even if it lies in some other frame.@item @code{t}Consider all windows in all existing frames.@item @code{visible}Consider all windows in all visible frames. (To get useful results, youmust ensure @var{window} is in a visible frame.)@item anything elseConsider precisely the windows in @var{window}'s frame, and no others.@end tableThis 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@end defun@defun previous-window &optional window minibuf all-framesThis function returns the window preceding @var{window} in the cyclicordering of windows. The other arguments specify which windows toinclude in the cycle, as in @code{next-window}.@end defun@deffn Command other-window countThis function selects the @var{count}th following window in the cyclicorder. If count is negative, then it selects the @minus{}@var{count}thpreceding window. It returns @code{nil}.In an interactive call, @var{count} is the numeric prefix argument.@end deffn@c Emacs 19 feature@defun walk-windows proc &optional minibuf all-framesThis function cycles through all windows, calling @code{proc}once for each window with the window as its sole argument.The optional arguments @var{minibuf} and @var{all-frames} specify theset of windows to include in the scan. See @code{next-window}, above,for details.@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 todisplay buffers in windows in a precisely controlled fashion.@iftexSee the following section for@end iftex@ifinfo@xref{Displaying Buffers}, for@end ifinforelated functions that find a window to use and specify a buffer for it.The functions described there are easier to use than these, but theyemploy heuristics in choosing or creating a window; use these functionswhen you need complete control.@defun set-window-buffer window buffer-or-nameThis function makes @var{window} display @var{buffer-or-name} as itscontents. It returns @code{nil}.@example@group(set-window-buffer (selected-window) "foo") @result{} nil@end group@end example@end defun@defun window-buffer &optional windowThis function returns the buffer that @var{window} is displaying. If@var{window} is omitted, this function returns the buffer for theselected window.@example@group(window-buffer) @result{} #<buffer windows.texi>@end group@end example@end defun@defun get-buffer-window buffer-or-name &optional all-framesThis function returns a window currently displaying@var{buffer-or-name}, or @code{nil} if there is none. If there areseveral such windows, then the function returns the first one in thecyclic ordering of windows, starting from the selected window.@xref{Cyclic Window Ordering}.The argument @var{all-frames} controls which windows to consider.@itemize @bullet@itemIf it is @code{nil}, consider windows on the selected frame.@itemIf it is @code{t}, consider windows on all frames.@itemIf it is @code{visible}, consider windows on all visible frames.@itemIf it is a frame, consider windows on that frame.@end itemize@end defun@deffn Command replace-buffer-in-windows bufferThis function replaces @var{buffer} with some other buffer in allwindows displaying it. The other buffer used is chosen with@code{other-buffer}. In the usual applications of this function, youdon't care which other buffer is used; you just want to make sure that@var{buffer} is no longer displayed.This function returns @code{nil}.@end deffn@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 windowautomatically and use it to display a specified buffer. These functionscan also split an existing window in certain circumstances. We alsodescribe variables that parameterize the heuristics used for choosing awindow.@iftexSee the preceding section for@end iftex@ifinfo@xref{Buffers and Windows}, for@end ifinfolow-level functions that give you more precise control. Do not use the functions in this section in order to make a buffercurrent so that a Lisp program can access or modify it; they are toodrastic for that purpose, since they change the display of buffers inwindows, which is gratuitous and will surprise the user. Instead, use@code{set-buffer} (@pxref{Current Buffer}) and @code{save-excursion}(@pxref{Excursions}), which designate buffers as current for programmedaccess without affecting the display of buffers in windows.@deffn Command switch-to-buffer buffer-or-name &optional norecordThis function makes @var{buffer-or-name} the current buffer, and alsodisplays the buffer in the selected window. This means that a human cansee the buffer and subsequent keyboard commands will apply to it.Contrast this with @code{set-buffer}, which makes @var{buffer-or-name}the current buffer but does not display it in the selected window.@xref{Current Buffer}.If @var{buffer-or-name} does not identify an existing buffer, thena new buffer by that name is created.Normally the specified buffer is put at the front of the buffer list.This affects the operation of @code{other-buffer}. However, if@var{norecord} is non-@code{nil}, this is not done. @xref{The BufferList}.The @code{switch-to-buffer} function is often used interactively, asthe binding of @kbd{C-x b}. It is also used frequently in programs. Italways returns @code{nil}.@end deffn@deffn Command switch-to-buffer-other-window buffer-or-nameThis function makes @var{buffer-or-name} the current buffer anddisplays it in a window not currently selected. It then selects thatwindow. The handling of the buffer is the same as in@code{switch-to-buffer}.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 forthis purpose. If the selected window is already displaying the buffer,then it continues to do so, but another window is nonetheless found todisplay it in as well.@end deffn@defun pop-to-buffer buffer-or-name &optional other-windowThis function makes @var{buffer-or-name} the current buffer andswitches to it in some window, preferably not the window previouslyselected. The ``popped-to'' window becomes the selected window withinits frame.If the variable @code{pop-up-frames} is non-@code{nil},@code{pop-to-buffer} looks for a window in any visible frame alreadydisplaying the buffer; if there is one, it returns that window and makesit be selected within its frame. If there is none, it creates a newframe and displays the buffer in it.If @code{pop-up-frames} is @code{nil}, then @code{pop-to-buffer}operates entirely within the selected frame. (If the selected frame hasjust a minibuffer, @code{pop-to-buffer} operates within the mostrecently selected frame that was not just a minibuffer.)If the variable @code{pop-up-windows} is non-@code{nil}, windows maybe split to create a new window that is different from the originalwindow. For details, see @ref{Choosing Window}.If @var{other-window} is non-@code{nil}, @code{pop-to-buffer} finds orcreates another window even if @var{buffer-or-name} is already visiblein the selected window. Thus @var{buffer-or-name} could end updisplayed in two windows. On the other hand, if @var{buffer-or-name} isalready displayed in the selected window and @var{other-window} is@code{nil}, then the selected window is considered sufficient displayfor @var{buffer-or-name}, so that nothing needs to be done.If @var{buffer-or-name} is a string that does not name an existingbuffer, a buffer by that name is created.@end defun@node Choosing Window@section Choosing a Window for Display This section describes the basic facility that chooses a window todisplay a buffer in---@code{display-buffer}. All the higher-levelfunctions and commands use this subroutine. Here we describe how to use@code{display-buffer} and how to customize it.@deffn Command display-buffer buffer-or-name &optional not-this-windowThis command makes @var{buffer-or-name} appear in some window, like@code{pop-to-buffer}, but it does not select that window and does notmake the buffer current. The identity of the selected window isunaltered by this function.If @var{not-this-window} is non-@code{nil}, it means to display thespecified buffer in a window other than the selected one, even if it isalready on display in the selected window. This can cause the buffer toappear in two windows at once. Otherwise, if @var{buffer-or-name} isalready being displayed in any window, that is good enough, so thisfunction does nothing.@code{display-buffer} returns the window chosen to display@var{buffer-or-name}.Precisely how @code{display-buffer} finds or creates a window depends onthe variables described below.@end deffn@defopt pop-up-windowsThis variable controls whether @code{display-buffer} makes new windows.If it is non-@code{nil} and there is only one window, then that windowis split. If it is @code{nil}, then @code{display-buffer} does notsplit the single window, but uses it whole.@end defopt@defopt split-height-thresholdThis variable determines when @code{display-buffer} may split a window,if there are multiple windows. @code{display-buffer} always splits thelargest window if it has at least this many lines. If the largestwindow is not this tall, it is split only if it is the sole window and@code{pop-up-windows} is non-@code{nil}.@end defopt@c Emacs 19 feature@defopt pop-up-framesThis variable controls whether @code{display-buffer} makes new frames.If it is non-@code{nil}, @code{display-buffer} looks for an existingwindow already displaying the desired buffer, on any visible frame. Ifit finds one, it returns that window. Otherwise it makes a new frame.The variables @code{pop-up-windows} and @code{split-height-threshold} donot matter if @code{pop-up-frames} is non-@code{nil}.If @code{pop-up-frames} is @code{nil}, then @code{display-buffer} eithersplits a window or reuses one.@xref{Frames}, for more information.@end defopt@c Emacs 19 feature@defvar pop-up-frame-functionThis 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 thatfunction, which should return a frame. The default value of thevariable is a function that creates a frame using parameters from@code{pop-up-frame-alist}.@end defvar@defvar pop-up-frame-alistThis variable holds an alist specifying frame parameters used when@code{display-buffer} makes a new frame. @xref{Frame Parameters}, formore information about frame parameters.@end defvar@defvar special-display-buffer-namesA list of buffer names for buffers that should be displayed specially.If the buffer's name is in this list, @code{display-buffer} handles thebuffer specially.By default, special display means to give the buffer a dedicated frame.@end defvar@defvar special-display-regexpsA list of regular expressions that specify buffers that should bedisplayed specially. If the buffer's name matches any of the regularexpressions in this list, @code{display-buffer} handles the bufferspecially.By default, special display means to give the buffer a dedicated frame.@end defvar@defvar special-display-functionThis variable holds the function to call to display a buffer specially.It receives the buffer as an argument, and should return the window inwhich it is displayed.The default value of this variable is@code{special-display-popup-frame}.@end defvar@defun special-display-popup-frame bufferThis function makes @var{buffer} visible in a frame of its own. If@var{buffer} is already displayed in a window in some frame, it makesthe frame visible and raises it, to use that window. Otherwise, itcreates a frame that will be dedicated to @var{buffer}.This function uses an existing window displaying @var{buffer} whether ornot it is in a frame of its own; but if you set up the above variablesin your init file, before @var{buffer} was created, then presumably thewindow was previously made by this function.@end defun@defopt special-display-frame-alistThis variable holds frame parameters for@code{special-display-popup-frame} to use when it creates a frame.@end defopt@c Emacs 19 feature@defvar display-buffer-functionThis variable is the most flexible way to customize the behavior of@code{display-buffer}. If it is non-@code{nil}, it should be a functionthat @code{display-buffer} calls to do the work. The function shouldaccept two arguments, the same two arguments that @code{display-buffer}received. It should choose or create a window, display the specifiedbuffer, and then return the window.This hook takes precedence over all the other options and hooksdescribed above.@end defvar@c Emacs 19 feature@cindex dedicated windowA window can be marked as ``dedicated'' to its buffer. Then@code{display-buffer} does not try to use that window.@defun window-dedicated-p windowThis function returns @code{t} if @var{window} is marked as dedicated;otherwise @code{nil}.@end defun@defun set-window-dedicated-p window flagThis function marks @var{window} as dedicated if @var{flag} isnon-@code{nil}, and nondedicated otherwise.@end defun@node Window Point@section Windows and Point@cindex window position@cindex window point@cindex position in window@cindex point in window Each window has its own value of point, independent of the value ofpoint in other windows displaying the same buffer. This makes it usefulto have multiple windows showing one buffer.@itemize @bullet@itemThe window point is established when a window is first created; it isinitialized from the buffer's point, or from the window point of anotherwindow opened on the buffer if such a window exists.@itemSelecting a window sets the value of point in its buffer to the window'svalue of point. Conversely, deselecting a window sets the window'svalue of point from that of the buffer. Thus, when you switch betweenwindows that display a given buffer, the point value for the selectedwindow is in effect in the buffer, while the point values for the otherwindows are stored in those windows.@itemAs long as the selected window displays the current buffer, the window'spoint and the buffer's point always move together; they remain equal.@item@xref{Positions}, for more details on buffer positions.@end itemize As far as the user is concerned, point is where the cursor is, andwhen the user switches to another buffer, the cursor jumps to theposition of point in that buffer.@defun window-point windowThis function returns the current position of point in @var{window}.For a nonselected window, this is the value point would have (in thatwindow's buffer) if that window were selected.When @var{window} is the selected window and its buffer is also thecurrent buffer, the value returned is the same as point in that buffer.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.@end defun@defun set-window-point window positionThis function positions point in @var{window} at position@var{position} in @var{window}'s buffer.@end defun@node Window Start@section The Window Start Position Each window contains a marker used to keep track of a buffer positionthat specifies where in the buffer display should start. This positionis called the @dfn{display-start} position of the window (or just the@dfn{start}). The character after this position is the one that appearsat the upper left corner of the window. It is usually, but notinevitably, at the beginning of a text line.@defun window-start &optional window@cindex window top lineThis function returns the display-start position of window@var{window}. If @var{window} is @code{nil}, the selected window isused. For example, @example@group(window-start) @result{} 7058@end group@end exampleWhen you create a window, or display a different buffer in it, thedisplay-start position is set to a display-start position recently usedfor the same buffer, or 1 if the buffer doesn't have any.For a realistic example, see the description of @code{count-lines} in@ref{Text Lines}.@end defun@defun window-end &optional windowThis function returns the position of the end of the display in window@var{window}. If @var{window} is @code{nil}, the selected window isused.Simply changing the buffer text or moving point does not update thevalue that @code{window-end} returns. The value is updated only whenEmacs redisplays and redisplay actually finishes.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 a value that is not correct. In afuture version, @code{window-end} will return @code{nil} in that case.@ignorein that case, this function returns @code{nil}. You can compute wherethe end of the window @emph{would} have been, if redisplay had finished,like this:@example(save-excursion (goto-char (window-start window)) (vertical-motion (1- (window-height window)) window) (point))@end example@end ignore@end defun@defun set-window-start window position &optional noforceThis 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 abuffer 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 thescreen. If this does place point off screen, the display routines movepoint to the left margin on the middle line in the window.For example, if point @w{is 1} and you set the start of the window @w{to2}, then point would be ``above'' the top of the window. The displayroutines will automatically move point if it is still 1 when redisplayoccurs. Here is an example:@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.23456---------- Buffer: foo ----------@end group@group(set-window-start (selected-window) (1+ (window-start)))@result{} 2@end group@group;; @r{Here is what @samp{foo} looks like after executing};; @r{the @code{set-window-start} expression.}---------- Buffer: foo ----------his is the contents of buffer foo.23@point{}456---------- Buffer: foo ----------@end group@end exampleIf @var{noforce} is non-@code{nil}, and @var{position} would place pointoff screen at the next redisplay, then redisplay computes a new window-startposition that works well with point, and thus @var{position} is not used.@end defun@defun pos-visible-in-window-p &optional position windowThis function returns @code{t} if @var{position} is within the rangeof text currently visible on the screen in @var{window}. It returns@code{nil} if @var{position} is scrolled vertically out of view. Theargument @var{position} defaults to the current position of point;@var{window}, to the selected window. Here is an example:@example@group(or (pos-visible-in-window-p (point) (selected-window)) (recenter 0))@end group@end exampleThe @code{pos-visible-in-window-p} function considers only verticalscrolling. If @var{position} is out of view only because @var{window}has been scrolled horizontally, @code{pos-visible-in-window-p} returns@code{t}. @xref{Horizontal Scrolling}.@end defun@node Vertical Scrolling@section Vertical Scrolling@cindex vertical scrolling@cindex scrolling vertically Vertical scrolling means moving the text up or down in a window. Itworks by changing the value of the window's display-start location. Itmay also change the value of @code{window-point} to keep it on thescreen. In the commands @code{scroll-up} and @code{scroll-down}, the directions``up'' and ``down'' refer to the motion of the text in the buffer at whichyou are looking through the window. Imagine that the text iswritten on a long roll of paper and that the scrolling commands move thepaper up and down. Thus, if you are looking at text in the middle of abuffer and repeatedly call @code{scroll-down}, you will eventually seethe beginning of the buffer. Some people have urged that the opposite convention be used: theyimagine that the window moves over text that remains in place. Then``down'' commands would take you to the end of the buffer. This view ismore consistent with the actual relationship between windows and thetext in the buffer, but it is less like what the user sees. Theposition of a window on the terminal does not move, and short scrollingcommands clearly move the text up or down on the screen. We have chosennames that fit the user's point of view. The scrolling functions (aside from @code{scroll-other-window}) haveunpredictable results if the current buffer is different from the bufferthat is displayed in the selected window. @xref{Current Buffer}.@deffn Command scroll-up &optional countThis function scrolls the text in the selected window upward@var{count} lines. If @var{count} is negative, scrolling is actuallydownward.If @var{count} is @code{nil} (or omitted), then the length of scrollis @code{next-screen-context-lines} lines less than the usable height ofthe window (not counting its mode line).@code{scroll-up} returns @code{nil}.@end deffn@deffn Command scroll-down &optional countThis function scrolls the text in the selected window downward@var{count} lines. If @var{count} is negative, scrolling is actuallyupward.If @var{count} is omitted or @code{nil}, then the length of the scrollis @code{next-screen-context-lines} lines less than the usable height ofthe window (not counting its mode line).@code{scroll-down} returns @code{nil}.@end deffn@deffn Command scroll-other-window &optional countThis function scrolls the text in another window upward @var{count}lines. Negative values of @var{count}, or @code{nil}, are handledas in @code{scroll-up}.The window that is scrolled is normally the one following the selectedwindow in the cyclic ordering of windows---the window that@code{next-window} would return. @xref{Cyclic Window Ordering}.You can specify a buffer to scroll with the variable@code{other-window-scroll-buffer}. When the selected window is theminibuffer, the next window is normally the one at the top left corner.You can specify a different window to scroll with the variable@code{minibuffer-scroll-window}. This variable has no effect when anyother window is selected. @xref{Minibuffer Misc}.When the minibuffer is active, it is the next window if the selectedwindow is the one at the bottom right corner. In this case,@code{scroll-other-window} attempts to scroll the minibuffer. If theminibuffer contains just one line, it has nowhere to scroll to, so theline reappears after the echo area momentarily displays the message``Beginning of buffer''.@end deffn@c Emacs 19 feature@defvar other-window-scroll-bufferIf this variable is non-@code{nil}, it tells @code{scroll-other-window}which buffer to scroll.@end defvar@defopt scroll-stepThis variable controls how scrolling is done automatically when pointmoves off the screen. If the value is zero, then redisplay scrolls thetext to center point vertically in the window. If the value is apositive integer @var{n}, then redisplay brings point back on screen byscrolling @var{n} lines in either direction, if possible; otherwise, itcenters point. The default value is zero.@end defopt@defopt next-screen-context-linesThe value of this variable is the number of lines of continuity toretain when scrolling by full screens. For example, @code{scroll-up}with an argument of @code{nil} scrolls so that this many lines at thebottom of the window appear instead at the top. The default value is@code{2}.@end defopt@deffn Command recenter &optional count@cindex centering pointThis function scrolls the selected window to put the text where pointis located at a specified vertical position within the window.If @var{count} is a nonnegative number, it puts the line containingpoint @var{count} lines down from the top of the window. If @var{count}is a negative number, then it counts upward from the bottom of thewindow, so that @minus{}1 stands for the last usable line in the window.If @var{count} is a non-@code{nil} list, then it stands for the line inthe middle of the window.If @var{count} is @code{nil}, @code{recenter} puts the line containingpoint in the middle of the window, then clears and redisplays the entireselected frame.When @code{recenter} is called interactively, @var{count} is the rawprefix argument. Thus, typing @kbd{C-u} as the prefix sets the@var{count} to a non-@code{nil} list, while typing @kbd{C-u 4} sets@var{count} to 4, which positions the current line four lines from thetop.With an argument of zero, @code{recenter} positions the current line atthe top of the window. This action is so handy that some people make aseparate key binding to do this. For example,@example@group(defun line-to-top-of-window () "Scroll current line to top of window.Replaces three keystroke sequence C-u 0 C-l." (interactive) (recenter 0))(global-set-key [kp-multiply] 'line-to-top-of-window) @end group@end example@end deffn@node Horizontal Scrolling@section Horizontal Scrolling@cindex horizontal scrolling Because we read English first from top to bottom and second from leftto right, horizontal scrolling is not like vertical scrolling. Verticalscrolling involves selection of a contiguous portion of text to display.Horizontal scrolling causes part of each line to go off screen. Theamount of horizontal scrolling is therefore specified as a number ofcolumns rather than as a position in the buffer. It has nothing to dowith the display-start position returned by @code{window-start}. Usually, no horizontal scrolling is in effect; then the leftmostcolumn is at the left edge of the window. In this state, scrolling tothe right is meaningless, since there is no data to the left of thescreen to be revealed by it; so this is not allowed. Scrolling to theleft is allowed; it scrolls the first columns of text off the edge ofthe window and can reveal additional columns on the right that weretruncated before. Once a window has a nonzero amount of leftwardhorizontal scrolling, you can scroll it back to the right, but only sofar as to reduce the net horizontal scroll to zero. There is no limitto how far left you can scroll, but eventually all the text willdisappear off the left edge.@deffn Command scroll-left countThis function scrolls the selected window @var{count} columns to theleft (or to the right if @var{count} is negative). The return value isthe total amount of leftward horizontal scrolling in effect after thechange---just like the value returned by @code{window-hscroll} (below).@end deffn@deffn Command scroll-right countThis function scrolls the selected window @var{count} columns to theright (or to the left if @var{count} is negative). The return value isthe total amount of leftward horizontal scrolling in effect after thechange---just like the value returned by @code{window-hscroll} (below).Once you scroll a window as far right as it can go, back to its normalposition where the total leftward scrolling is zero, attempts to scrollany farther right have no effect.@end deffn@defun window-hscroll &optional windowThis function returns the total leftward horizontal scrolling of@var{window}---the number of columns by which the text in @var{window}is scrolled left past the left margin.The value is never negative. It is zero when no horizontal scrollinghas been done in @var{window} (which is usually the case).If @var{window} is @code{nil}, the selected window is used.@example@group(window-hscroll) @result{} 0@end group@group(scroll-left 5) @result{} 5@end group@group(window-hscroll) @result{} 5@end group@end example@end defun@defun set-window-hscroll window columnsThis function sets the number of columns from the left margin that@var{window} is scrolled to the value of @var{columns}. The argument@var{columns} should be zero or positive; if not, it is taken as zero.The value returned is @var{columns}.@example@group(set-window-hscroll (selected-window) 10) @result{} 10@end group@end example@end defun Here is how you can determine whether a given position @var{position}is off the screen due to horizontal scrolling:@example@group(defun hscroll-on-screen (window position) (save-excursion (goto-char position) (and (>= (- (current-column) (window-hscroll window)) 0) (< (- (current-column) (window-hscroll window)) (window-width window)))))@end group@end example@node Size of Window@section The Size of a Window@cindex window size@cindex size of window An Emacs window is rectangular, and its size information consists ofthe height (the number of lines) and the width (the number of characterpositions in each line). The mode line is included in the height. Butthe width does not count the scroll bar or the column of @samp{|}characters that separates side-by-side windows. The following three functions return size information about a window:@defun window-height &optional windowThis function returns the number of lines in @var{window}, includingits mode line. If @var{window} fills its entire frame, this is one lessthan the value of @code{frame-height} on that frame (since the last lineis always reserved for the minibuffer).If @var{window} is @code{nil}, the function uses the selected window.@example@group(window-height) @result{} 23@end group@group(split-window-vertically) @result{} #<window 4 on windows.texi>@end group@group(window-height) @result{} 11@end group@end example@end defun@defun window-width &optional windowThis function returns the number of columns in @var{window}. If@var{window} fills its entire frame, this is the same as the value of@code{frame-width} on that frame. The width does not include thewindow's scroll bar or the column of @samp{|} characters that separatesside-by-side windows.If @var{window} is @code{nil}, the function uses the selected window.@example@group(window-width) @result{} 80@end group@end example@end defun@defun window-edges &optional windowThis function returns a list of the edge coordinates of @var{window}.If @var{window} is @code{nil}, the selected window is used.The order of the list is @code{(@var{left} @var{top} @var{right}@var{bottom})}, all elements relative to 0, 0 at the top left corner ofthe frame. The element @var{right} of the value is one more than therightmost column used by @var{window}, and @var{bottom} is one more thanthe bottommost row used by @var{window} and its mode-line.When you have side-by-side windows, the right edge value for a windowwith a neighbor on the right includes the width of the separator betweenthe window and that neighbor. This separator may be a column of@samp{|} characters or it may be a scroll bar. Since the width of thewindow does not include this separator, the width does not equal thedifference between the right and left edges in this case.Here is the result obtained on a typical 24-line terminal with just onewindow:@example@group(window-edges (selected-window)) @result{} (0 0 80 23)@end group@end example@noindentThe bottom edge is at line 23 because the last line is the echo area.If @var{window} is at the upper left corner of its frame, @var{right}and @var{bottom} are the same as the values returned by@code{(window-width)} and @code{(window-height)} respectively, and@var{top} and @var{bottom} are zero. For example, the edges of thefollowing window are @w{@samp{0 0 5 8}}. Assuming that the frame hasmore than 8 columns, the last column of the window (column 7) holds aborder rather than text. The last row (row 4) holds the mode line,shown here with @samp{xxxxxxxxx}.@example@group 0 _______ 0 | | | | | | | | xxxxxxxxx 4 7 @end group@end exampleWhen there are side-by-side windows, any window not at the right edge ofits frame has a separator in its last column or columns. The separatorcounts as one or two columns in the width of the window. A window neverincludes a separator on its left, since that belongs to the window tothe left.In the following example, let's suppose that the frame is 7columns wide. Then the edges of the left window are @w{@samp{0 0 4 3}}and the edges of the right window are @w{@samp{4 0 7 3}}.@example@group ___ ___ | | | | | | xxxxxxxxx 0 34 7@end group@end example@end defun@node Resizing Windows@section Changing the Size of a Window@cindex window resizing@cindex changing window size@cindex window size, changing The window size functions fall into two classes: high-level commandsthat change the size of windows and low-level functions that accesswindow size. Emacs does not permit overlapping windows or gaps betweenwindows, so resizing one window affects other windows.@deffn Command enlarge-window size &optional horizontalThis function makes the selected window @var{size} lines taller,stealing lines from neighboring windows. It takes the lines from onewindow at a time until that window is used up, then takes from another.If a window from which lines are stolen shrinks below@code{window-min-height} lines, that window disappears.If @var{horizontal} is non-@code{nil}, this function makes@var{window} wider by @var{size} columns, stealing columns instead oflines. If a window from which columns are stolen shrinks below@code{window-min-width} columns, that window disappears.If the requested size would exceed that of the window's frame, then thefunction makes the window occupy the entire height (or width) of theframe.If @var{size} is negative, this function shrinks the window by@minus{}@var{size} lines or columns. If that makes the window smallerthan the minimum size (@code{window-min-height} and@code{window-min-width}), @code{enlarge-window} deletes the window.@code{enlarge-window} returns @code{nil}. @end deffn@deffn Command enlarge-window-horizontally columnsThis function makes the selected window @var{columns} wider.It could be defined as follows:@example@group(defun enlarge-window-horizontally (columns) (enlarge-window columns t))@end group@end example@end deffn@deffn Command shrink-window size &optional horizontalThis function is like @code{enlarge-window} but negates the argument@var{size}, making the selected window smaller by giving lines (orcolumns) to the other windows. If the window shrinks below@code{window-min-height} or @code{window-min-width}, then it disappears.If @var{size} is negative, the window is enlarged by @minus{}@var{size}lines or columns.@end deffn@deffn Command shrink-window-horizontally columnsThis function makes the selected window @var{columns} narrower.It could be defined as follows:@example@group(defun shrink-window-horizontally (columns) (shrink-window columns t))@end group@end example@end deffn@cindex minimum window size The following two variables constrain the window-size-changingfunctions to a minimum height and width.@defopt window-min-heightThe value of this variable determines how short a window may becomebefore it is automatically deleted. Making a window smaller than@code{window-min-height} automatically deletes it, and no window may becreated shorter than this. The absolute minimum height is two (allowingone line for the mode line, and one line for the buffer display).Actions that change window sizes reset this variable to two if it isless than two. The default value is 4.@end defopt@defopt window-min-widthThe value of this variable determines how narrow a window may becomebefore it automatically deleted. Making a window smaller than@code{window-min-width} automatically deletes it, and no window may becreated narrower than this. The absolute minimum width is one; anyvalue below that is ignored. The default value is 10.@end defopt@node Coordinates and Windows@section Coordinates and WindowsThis section describes how to relate screen coordinates to windows.@defun window-at x y &optional frameThis function returns the window containing the specified cursorposition in the frame @var{frame}. The coordinates @var{x} and @var{y}are measured in characters and count from the top left corner of theframe. If they are out of range, @code{window-at} returns @code{nil}.If you omit @var{frame}, the selected frame is used.@end defun@defun coordinates-in-window-p coordinates windowThis function checks whether a particular frame position falls withinthe window @var{window}.The argument @var{coordinates} is a cons cell of this form:@example(@var{x} . @var{y})@end example@noindentThe coordinates @var{x} and @var{y} are measured in characters, andcount from the top left corner of the screen or frame.The value of @code{coordinates-in-window-p} is non-@code{nil} if thecoordinates are inside @var{window}. The value also indicates what partof the window the position is in, as follows:@table @code@item (@var{relx} . @var{rely})The coordinates are inside @var{window}. The numbers @var{relx} and@var{rely} are the equivalent window-relative coordinates for thespecified position, counting from 0 at the top left corner of thewindow.@item mode-lineThe coordinates are in the mode line of @var{window}.@item vertical-splitThe coordinates are in the vertical line between @var{window} and itsneighbor to the right. This value occurs only if the window doesn't have a scroll bar; positions in a scroll bar are considered outside thewindow.@item nilThe coordinates are not in any part of @var{window}.@end tableThe function @code{coordinates-in-window-p} does not require a frame asargument because it always uses the frame that @var{window} is on.@end defun@node Window Configurations@section Window Configurations@cindex window configurations@cindex saving window information A @dfn{window configuration} records the entire layout of aframe---all windows, their sizes, which buffers they contain, what partof each buffer is displayed, and the values of point and the mark. Youcan bring back an entire previous layout by restoring a windowconfiguration previously saved. If you want to record all frames instead of just one, use a frameconfiguration instead of a window configuration. @xref{FrameConfigurations}.@defun current-window-configurationThis function returns a new object representing Emacs's current windowconfiguration, namely the number of windows, their sizes and currentbuffers, which window is the selected window, and for each window thedisplayed buffer, the display-start position, and the positions of pointand the mark. An exception is made for point in the current buffer,whose value is not saved.@end defun@defun set-window-configuration configurationThis function restores the configuration of Emacs's windows andbuffers to the state specified by @var{configuration}. The argument@var{configuration} must be a value that was previously returned by@code{current-window-configuration}.Here is a way of using this function to get the same effectas @code{save-window-excursion}:@example@group(let ((config (current-window-configuration))) (unwind-protect (progn (split-window-vertically nil) @dots{}) (set-window-configuration config)))@end group@end example@end defun@defspec save-window-excursion forms@dots{}This special form records the window configuration, executes @var{forms}in sequence, then restores the earlier window configuration. The windowconfiguration includes the value of point and the portion of the bufferthat is visible. It also includes the choice of selected window.However, it does not include the value of point in the current buffer;use @code{save-excursion} if you wish to preserve that.The return value is the value of the final form in @var{forms}.For example:@example@group(split-window) @result{} #<window 25 on control.texi>@end group@group(setq w (selected-window)) @result{} #<window 19 on control.texi>@end group@group(save-window-excursion (delete-other-windows w) (switch-to-buffer "foo") 'do-something) @result{} do-something ;; @r{The screen is now split again.}@end group@end example@end defspec@defun window-configuration-p objectThis function returns @code{t} if @var{object} is a window configuration.@end defun Primitives to look inside of window configurations would make sense,but none are implemented. It is not clear they are useful enough to beworth implementing.