deuce.emacs.window
compare-window-configurations
(compare-window-configurations x y)
Compare two window configurations as regards the structure of windows.
This function ignores details such as the values of point and mark
and scrolling positions.
coordinates-in-window-p
(coordinates-in-window-p coordinates window)
Return non-nil if COORDINATES are in WINDOW.
WINDOW must be a live window.
COORDINATES is a cons of the form (X . Y), X and Y being distances
measured in characters from the upper-left corner of the frame.
(0 . 0) denotes the character in the upper left corner of the
frame.
If COORDINATES are in the text portion of WINDOW,
the coordinates relative to the window are returned.
If they are in the mode line of WINDOW, `mode-line' is returned.
If they are in the top mode line of WINDOW, `header-line' is returned.
If they are in the left fringe of WINDOW, `left-fringe' is returned.
If they are in the right fringe of WINDOW, `right-fringe' is returned.
If they are on the border between WINDOW and its right sibling,
`vertical-line' is returned.
If they are in the windows's left or right marginal areas, `left-margin'
or `right-margin' is returned.
current-window-configuration
(current-window-configuration & [frame])
Return an object representing the current window configuration of FRAME.
If FRAME is nil or omitted, use the selected frame.
This describes the number of windows, their sizes and current buffers,
and for each displayed buffer, where display starts, and the positions of
point and mark. An exception is made for point in the current buffer:
its value is -not- saved.
This also records the currently selected frame, and FRAME's focus
redirection (see `redirect-frame-focus'). The variable
`window-persistent-parameters' specifies which window parameters are
saved by this function.
delete-other-windows-internal
(delete-other-windows-internal & [window root])
Make WINDOW fill its frame.
Only the frame WINDOW is on is affected. WINDOW may be any window and
defaults to the selected one.
Optional argument ROOT, if non-nil, must specify an internal window such
that WINDOW is in its window subtree. If this is the case, replace ROOT
by WINDOW and leave alone any windows not part of ROOT's subtree.
When WINDOW is live try to reduce display jumps by keeping the text
previously visible in WINDOW in the same place on the frame. Doing this
depends on the value of (window-start WINDOW), so if calling this
function in a program gives strange scrolling, make sure the
window-start value is reasonable when this function is called.
delete-window-internal
(delete-window-internal window)
Remove WINDOW from its frame.
WINDOW defaults to the selected window. Return nil.
Signal an error when WINDOW is the only window on its frame.
force-window-update
(force-window-update & [object])
Force all windows to be updated on next redisplay.
If optional arg OBJECT is a window, force redisplay of that window only.
If OBJECT is a buffer or buffer name, force redisplay of all windows
displaying that buffer.
frame-first-window
(frame-first-window & [frame-or-window])
Return the topmost, leftmost live window on FRAME-OR-WINDOW.
If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
Else if FRAME-OR-WINDOW denotes any window, return the first window of
that window's frame. If FRAME-OR-WINDOW denotes a live frame, return
the first window of that frame.
frame-root-window
(frame-root-window & [frame-or-window])
Return the root window of FRAME-OR-WINDOW.
If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
With a frame argument, return that frame's root window.
With a window argument, return the root window of that window's frame.
frame-selected-window
(frame-selected-window & [frame-or-window])
Return the selected window of FRAME-OR-WINDOW.
If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
Else if FRAME-OR-WINDOW denotes any window, return the selected window
of that window's frame. If FRAME-OR-WINDOW denotes a live frame, return
the selected window of that frame.
get-buffer-window
(get-buffer-window & [buffer-or-name all-frames])
Return a window currently displaying BUFFER-OR-NAME, or nil if none.
BUFFER-OR-NAME may be a buffer or a buffer name and defaults to
the current buffer.
The optional argument ALL-FRAMES specifies the frames to consider:
- t means consider all windows on all existing frames.
- `visible' means consider all windows on all visible frames.
- 0 (the number zero) means consider all windows on all visible
and iconified frames.
- A frame means consider all windows on that frame only.
Any other value of ALL-FRAMES means consider all windows on the
selected frame and no others.
internal-temp-output-buffer-show
(internal-temp-output-buffer-show buf)
Internal function for `with-output-to-temp-buffer'.
minibuffer-selected-window
(minibuffer-selected-window)
Return the window which was selected when entering the minibuffer.
Returns nil, if selected window is not a minibuffer window.
minibuffer-window
(minibuffer-window & [frame])
Return the minibuffer window for frame FRAME.
If FRAME is omitted or nil, it defaults to the selected frame.
move-to-window-line
(move-to-window-line arg)
Position point relative to window.
ARG nil means position point at center of window.
Else, ARG specifies vertical position within the window;
zero means top of window, negative means relative to bottom of window.
next-window
(next-window & [window minibuf all-frames])
Return live window after WINDOW in the cyclic ordering of windows.
WINDOW must be a live window and defaults to the selected one. The
optional arguments MINIBUF and ALL-FRAMES specify the set of windows to
consider.
MINIBUF nil or omitted means consider the minibuffer window only if the
minibuffer is active. MINIBUF t means consider the minibuffer window
even if the minibuffer is not active. Any other value means do not
consider the minibuffer window even if the minibuffer is active.
ALL-FRAMES nil or omitted means consider all windows on WINDOW's frame,
plus the minibuffer window if specified by the MINIBUF argument. If the
minibuffer counts, consider all windows on all frames that share that
minibuffer too. The following non-nil values of ALL-FRAMES have special
meanings:
- t means consider all windows on all existing frames.
- `visible' means consider all windows on all visible frames.
- 0 (the number zero) means consider all windows on all visible and
iconified frames.
- A frame means consider all windows on that frame only.
Anything else means consider all windows on WINDOW's frame and no
others.
If you use consistent values for MINIBUF and ALL-FRAMES, you can use
`next-window' to iterate through the entire cycle of acceptable
windows, eventually ending up back at the window you started with.
`previous-window' traverses the same cycle, in the reverse order.
pos-visible-in-window-p
(pos-visible-in-window-p & [pos window partially])
Return non-nil if position POS is currently on the frame in WINDOW.
Return nil if that position is scrolled vertically out of view.
If a character is only partially visible, nil is returned, unless the
optional argument PARTIALLY is non-nil.
If POS is only out of view because of horizontal scrolling, return non-nil.
If POS is t, it specifies the position of the last visible glyph in WINDOW.
POS defaults to point in WINDOW; WINDOW defaults to the selected window.
If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil,
return value is a list of 2 or 6 elements (X Y [RTOP RBOT ROWH VPOS]),
where X and Y are the pixel coordinates relative to the top left corner
of the window. The remaining elements are omitted if the character after
POS is fully visible; otherwise, RTOP and RBOT are the number of pixels
off-window at the top and bottom of the row, ROWH is the height of the
display row, and VPOS is the row number (0-based) containing POS.
previous-window
(previous-window & [window minibuf all-frames])
Return live window before WINDOW in the cyclic ordering of windows.
WINDOW must be a live window and defaults to the selected one. The
optional arguments MINIBUF and ALL-FRAMES specify the set of windows to
consider.
MINIBUF nil or omitted means consider the minibuffer window only if the
minibuffer is active. MINIBUF t means consider the minibuffer window
even if the minibuffer is not active. Any other value means do not
consider the minibuffer window even if the minibuffer is active.
ALL-FRAMES nil or omitted means consider all windows on WINDOW's frame,
plus the minibuffer window if specified by the MINIBUF argument. If the
minibuffer counts, consider all windows on all frames that share that
minibuffer too. The following non-nil values of ALL-FRAMES have special
meanings:
- t means consider all windows on all existing frames.
- `visible' means consider all windows on all visible frames.
- 0 (the number zero) means consider all windows on all visible and
iconified frames.
- A frame means consider all windows on that frame only.
Anything else means consider all windows on WINDOW's frame and no
others.
If you use consistent values for MINIBUF and ALL-FRAMES, you can
use `previous-window' to iterate through the entire cycle of
acceptable windows, eventually ending up back at the window you
started with. `next-window' traverses the same cycle, in the
reverse order.
recenter
(recenter & [arg])
Center point in selected window and maybe redisplay frame.
With prefix argument ARG, recenter putting point on screen line ARG
relative to the selected window. If ARG is negative, it counts up from the
bottom of the window. (ARG should be less than the height of the window.)
If ARG is omitted or nil, then recenter with point on the middle line of
the selected window; if the variable `recenter-redisplay' is non-nil,
also erase the entire frame and redraw it (when `auto-resize-tool-bars'
is set to `grow-only', this resets the tool-bar's height to the minimum
height needed); if `recenter-redisplay' has the special value `tty',
then only tty frames are redrawn.
Just C-u as prefix means put point in the center of the window
and redisplay normally--don't erase and redraw the frame.
resize-mini-window-internal
(resize-mini-window-internal window)
Resize minibuffer window WINDOW.
run-window-configuration-change-hook
(run-window-configuration-change-hook frame)
Run `window-configuration-change-hook' for FRAME.
select-window
(select-window window & [norecord])
Select WINDOW. Most editing will apply to WINDOW's buffer.
Also make WINDOW's buffer current and make WINDOW the frame's selected
window. Return WINDOW.
Optional second arg NORECORD non-nil means do not put this buffer at the
front of the buffer list and do not make this window the most recently
selected one.
Note that the main editor command loop sets the current buffer to the
buffer of the selected window before each command.
selected-window
(selected-window)
Return the selected window.
The selected window is the window in which the standard cursor for
selected windows appears and to which many commands apply.
set-frame-selected-window
(set-frame-selected-window frame window & [norecord])
Set selected window of FRAME to WINDOW.
FRAME must be a live frame and defaults to the selected one. If FRAME
is the selected frame, this makes WINDOW the selected window. Optional
argument NORECORD non-nil means to neither change the order of recently
selected windows nor the buffer list. WINDOW must denote a live window.
Return WINDOW.
set-window-buffer
(set-window-buffer window buffer-or-name & [keep-margins])
Make WINDOW display BUFFER-OR-NAME as its contents.
WINDOW has to be a live window and defaults to the selected one.
BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
Optional third argument KEEP-MARGINS non-nil means that WINDOW's current
display margins, fringe widths, and scroll bar settings are preserved;
the default is to reset these from the local settings for BUFFER-OR-NAME
or the frame defaults. Return nil.
This function throws an error when WINDOW is strongly dedicated to its
buffer (that is `window-dedicated-p' returns t for WINDOW) and does not
already display BUFFER-OR-NAME.
This function runs `window-scroll-functions' before running
`window-configuration-change-hook'.
set-window-combination-limit
(set-window-combination-limit window limit)
Set combination limit of window WINDOW to LIMIT; return LIMIT.
If LIMIT is nil, child windows of WINDOW can be recombined with
WINDOW's siblings. LIMIT t means that child windows of WINDOW are
never (re-)combined with WINDOW's siblings. Other values are reserved
for future use.
set-window-configuration
(set-window-configuration configuration)
Set the configuration of windows and buffers as specified by CONFIGURATION.
CONFIGURATION must be a value previously returned
by `current-window-configuration' (which see).
If CONFIGURATION was made from a frame that is now deleted,
only frame-independent values can be restored. In this case,
the return value is nil. Otherwise the value is t.
set-window-dedicated-p
(set-window-dedicated-p window flag)
Mark WINDOW as dedicated according to FLAG.
WINDOW must be a live window and defaults to the selected one. FLAG
non-nil means mark WINDOW as dedicated to its buffer. FLAG nil means
mark WINDOW as non-dedicated. Return FLAG.
When a window is dedicated to its buffer, `display-buffer' will refrain
from displaying another buffer in it. `get-lru-window' and
`get-largest-window' treat dedicated windows specially.
`delete-windows-on', `replace-buffer-in-windows', `quit-window',
`quit-restore-window' and `kill-buffer' can delete a dedicated window
and the containing frame.
As a special case, if FLAG is t, mark WINDOW as "strongly" dedicated to
its buffer. Functions like `set-window-buffer' may change the buffer
displayed by a window, unless that window is strongly dedicated to its
buffer. If and when `set-window-buffer' displays another buffer in a
window, it also makes sure that the window is no more dedicated.
set-window-display-table
(set-window-display-table window table)
Set WINDOW's display-table to TABLE.
set-window-fringes
(set-window-fringes window left-width & [right-width outside-margins])
Set the fringe widths of window WINDOW.
If WINDOW is nil, set the fringe widths of the currently selected
window.
Second arg LEFT-WIDTH specifies the number of pixels to reserve for
the left fringe. Optional third arg RIGHT-WIDTH specifies the right
fringe width. If a fringe width arg is nil, that means to use the
frame's default fringe width. Default fringe widths can be set with
the command `set-fringe-style'.
If optional fourth arg OUTSIDE-MARGINS is non-nil, draw the fringes
outside of the display margins. By default, fringes are drawn between
display marginal areas and the text area.
set-window-margins
(set-window-margins window left-width & [right-width])
Set width of marginal areas of window WINDOW.
If WINDOW is nil, set margins of the currently selected window.
Second arg LEFT-WIDTH specifies the number of character cells to
reserve for the left marginal area. Optional third arg RIGHT-WIDTH
does the same for the right marginal area. A nil width parameter
means no margin.
set-window-new-normal
(set-window-new-normal window & [size])
Set new normal size of WINDOW to SIZE.
Return SIZE.
Note: This function does not operate on any child windows of WINDOW.
set-window-new-total
(set-window-new-total window size & [add])
Set new total size of WINDOW to SIZE.
Return SIZE.
Optional argument ADD non-nil means add SIZE to the new total size of
WINDOW and return the sum.
Note: This function does not operate on any child windows of WINDOW.
set-window-next-buffers
(set-window-next-buffers window next-buffers)
Set WINDOW's next buffers to NEXT-BUFFERS.
WINDOW must be a live window and defaults to the selected one.
NEXT-BUFFERS should be a list of buffers.
set-window-parameter
(set-window-parameter window parameter value)
Set WINDOW's value of PARAMETER to VALUE.
WINDOW defaults to the selected window. Return VALUE.
set-window-point
(set-window-point window pos)
Make point value in WINDOW be at position POS in WINDOW's buffer.
Return POS.
set-window-prev-buffers
(set-window-prev-buffers window prev-buffers)
Set WINDOW's previous buffers to PREV-BUFFERS.
WINDOW must be a live window and defaults to the selected one.
PREV-BUFFERS should be a list of elements (BUFFER WINDOW-START POS),
where BUFFER is a buffer, WINDOW-START is the start position of the
window for that buffer, and POS is a window-specific point value.
set-window-redisplay-end-trigger
(set-window-redisplay-end-trigger window value)
This function is obsolete since 23.1.
Set WINDOW's redisplay end trigger value to VALUE.
VALUE should be a buffer position (typically a marker) or nil.
If it is a buffer position, then if redisplay in WINDOW reaches a position
beyond VALUE, the functions in `redisplay-end-trigger-functions' are called
with two arguments: WINDOW, and the end trigger value.
Afterwards the end-trigger value is reset to nil.
set-window-start
(set-window-start window pos & [noforce])
Make display in WINDOW start at position POS in WINDOW's buffer.
If WINDOW is nil, the selected window is used. Return POS.
Optional third arg NOFORCE non-nil inhibits next redisplay from
overriding motion of point in order to display at this exact start.
split-window-internal
(split-window-internal old total-size side normal-size)
Split window OLD.
Second argument TOTAL-SIZE specifies the number of lines or columns of the
new window. In any case TOTAL-SIZE must be a positive integer.
Third argument SIDE nil (or `below') specifies that the new window shall
be located below WINDOW. SIDE `above' means the new window shall be
located above WINDOW. In both cases TOTAL-SIZE specifies the number of
lines of the new window including space reserved for the mode and/or
header line.
SIDE t (or `right') specifies that the new window shall be located on
the right side of WINDOW. SIDE `left' means the new window shall be
located on the left of WINDOW. In both cases TOTAL-SIZE specifies the
number of columns of the new window including space reserved for fringes
and the scrollbar or a divider column.
Fourth argument NORMAL-SIZE specifies the normal size of the new window
according to the SIDE argument.
The new total and normal sizes of all involved windows must have been
set correctly. See the code of `split-window' for how this is done.
window-absolute-pixel-edges
(window-absolute-pixel-edges & [window])
Return a list of the edge pixel coordinates of WINDOW.
The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
the top left corner of the display.
RIGHT is one more than the rightmost x position occupied by WINDOW.
BOTTOM is one more than the bottommost y position occupied by WINDOW.
The pixel edges include the space used by WINDOW's scroll bar, display
margins, fringes, header line, and/or mode line. For the pixel edges
of just the text area, use `window-inside-absolute-pixel-edges'.
window-at
(window-at x y & [frame])
Return window containing coordinates X and Y on FRAME.
FRAME must be a live frame and defaults to the selected one.
The top left corner of the frame is considered to be row 0,
column 0.
window-body-height
(window-body-height & [window])
Return the height, in lines, of WINDOW's text area.
If WINDOW is omitted or nil, it defaults to the selected window.
Signal an error if the window is not live.
The returned height does not include the mode line or header line.
On a graphical display, the height is expressed as an integer multiple
of the default character height. If a line at the bottom of the text
area is only partially visible, that counts as a whole line; to
exclude partially-visible lines, use `window-text-height'.
window-body-width
(window-body-width & [window])
Return the width, in columns, of WINDOW's text area.
If WINDOW is omitted or nil, it defaults to the selected window.
Signal an error if the window is not live.
The return value does not include any vertical dividers, fringe or
marginal areas, or scroll bars. On a graphical display, the width is
expressed as an integer multiple of the default character width.
window-buffer
(window-buffer & [window])
Return the buffer displayed in window WINDOW.
If WINDOW is omitted or nil, it defaults to the selected window.
Return nil for an internal window or a deleted window.
window-combination-limit
(window-combination-limit window)
Return combination limit of window WINDOW.
If the return value is nil, child windows of WINDOW can be recombined with
WINDOW's siblings. A return value of t means that child windows of
WINDOW are never (re-)combined with WINDOW's siblings.
window-configuration-frame
(window-configuration-frame config)
Return the frame that CONFIG, a window-configuration object, is about.
window-configuration-p
(window-configuration-p object)
Return t if OBJECT is a window-configuration object.
window-dedicated-p
(window-dedicated-p & [window])
Return non-nil when WINDOW is dedicated to its buffer.
More precisely, return the value assigned by the last call of
`set-window-dedicated-p' for WINDOW. Return nil if that function was
never called with WINDOW as its argument, or the value set by that
function was internally reset since its last call. WINDOW defaults to
the selected window.
When a window is dedicated to its buffer, `display-buffer' will refrain
from displaying another buffer in it. `get-lru-window' and
`get-largest-window' treat dedicated windows specially.
`delete-windows-on', `replace-buffer-in-windows', `quit-window' and
`kill-buffer' can delete a dedicated window and the containing frame.
Functions like `set-window-buffer' may change the buffer displayed by a
window, unless that window is "strongly" dedicated to its buffer, that
is the value returned by `window-dedicated-p' is t.
window-display-table
(window-display-table & [window])
Return the display-table that WINDOW is using.
WINDOW defaults to the selected window.
window-edges
(window-edges & [window])
Return a list of the edge coordinates of WINDOW.
The list has the form (LEFT TOP RIGHT BOTTOM).
TOP and BOTTOM count by lines, and LEFT and RIGHT count by columns,
all relative to 0, 0 at top left corner of frame.
RIGHT is one more than the rightmost column occupied by WINDOW.
BOTTOM is one more than the bottommost row occupied by WINDOW.
The edges include the space used by WINDOW's scroll bar, display
margins, fringes, header line, and/or mode line. For the edges of
just the text area, use `window-inside-edges'.
window-end
(window-end & [window update])
Return position at which display currently ends in WINDOW.
WINDOW must be a live window and defaults to the selected one.
This is updated by redisplay, when it runs to completion.
Simply changing the buffer text or setting `window-start'
does not update this value.
Return nil if there is no recorded value. (This can happen if the
last redisplay of WINDOW was preempted, and did not finish.)
If UPDATE is non-nil, compute the up-to-date position
if it isn't already recorded.
window-frame
(window-frame window)
Return the frame that window WINDOW is on.
If WINDOW is omitted or nil, it defaults to the selected window.
window-fringes
(window-fringes & [window])
Get width of fringes of window WINDOW.
If WINDOW is omitted or nil, it defaults to the selected window.
Value is a list of the form (LEFT-WIDTH RIGHT-WIDTH OUTSIDE-MARGINS).
window-inside-absolute-pixel-edges
(window-inside-absolute-pixel-edges & [window])
Return a list of the edge pixel coordinates of WINDOW's text area.
The list has the form (LEFT TOP RIGHT BOTTOM), all relative to (0,0)
at the top left corner of the frame's window area.
RIGHT is one more than the rightmost x position of WINDOW's text area.
BOTTOM is one more than the bottommost y position of WINDOW's text area.
The inside edges do not include the space used by WINDOW's scroll bar,
display margins, fringes, header line, and/or mode line.
window-inside-edges
(window-inside-edges & [window])
Return a list of the edge coordinates of WINDOW.
The list has the form (LEFT TOP RIGHT BOTTOM).
TOP and BOTTOM count by lines, and LEFT and RIGHT count by columns,
all relative to 0, 0 at top left corner of frame.
RIGHT is one more than the rightmost column of WINDOW's text area.
BOTTOM is one more than the bottommost row of WINDOW's text area.
The inside edges do not include the space used by the WINDOW's scroll
bar, display margins, fringes, header line, and/or mode line.
window-inside-pixel-edges
(window-inside-pixel-edges & [window])
Return a list of the edge pixel coordinates of WINDOW's text area.
The list has the form (LEFT TOP RIGHT BOTTOM), all relative to (0,0)
at the top left corner of the frame's window area.
RIGHT is one more than the rightmost x position of WINDOW's text area.
BOTTOM is one more than the bottommost y position of WINDOW's text area.
The inside edges do not include the space used by WINDOW's scroll bar,
display margins, fringes, header line, and/or mode line.
window-left-child
(window-left-child window)
Return the leftmost child window of window WINDOW.
Return nil if WINDOW is a live window (live windows have no children).
Return nil if WINDOW is an internal window whose children form a
vertical combination.
window-left-column
(window-left-column & [window])
Return left column of window WINDOW.
This is the distance, in columns, between the left edge of WINDOW and
the left edge of the frame's window area. For instance, the return
value is 0 if there is no window to the left of WINDOW.
If WINDOW is omitted or nil, it defaults to the selected window.
window-line-height
(window-line-height & [line window])
Return height in pixels of text line LINE in window WINDOW.
WINDOW defaults to the selected window.
Return height of current line if LINE is omitted or nil. Return height of
header or mode line if LINE is `header-line' or `mode-line'.
Otherwise, LINE is a text line number starting from 0. A negative number
counts from the end of the window.
Value is a list (HEIGHT VPOS YPOS OFFBOT), where HEIGHT is the height
in pixels of the visible part of the line, VPOS and YPOS are the
vertical position in lines and pixels of the line, relative to the top
of the first text line, and OFFBOT is the number of off-window pixels at
the bottom of the text line. If there are off-window pixels at the top
of the (first) text line, YPOS is negative.
Return nil if window display is not up-to-date. In that case, use
`pos-visible-in-window-p' to obtain the information.
window-list
(window-list & [frame minibuf window])
Return a list of windows on FRAME, starting with WINDOW.
FRAME nil or omitted means use the selected frame.
WINDOW nil or omitted means use the window selected within FRAME.
MINIBUF t means include the minibuffer window, even if it isn't active.
MINIBUF nil or omitted means include the minibuffer window only
if it's active.
MINIBUF neither nil nor t means never include the minibuffer window.
window-list-1
(window-list-1 & [window minibuf all-frames])
Return a list of all live windows.
WINDOW specifies the first window to list and defaults to the selected
window.
Optional argument MINIBUF nil or omitted means consider the minibuffer
window only if the minibuffer is active. MINIBUF t means consider the
minibuffer window even if the minibuffer is not active. Any other value
means do not consider the minibuffer window even if the minibuffer is
active.
Optional argument ALL-FRAMES nil or omitted means consider all windows
on WINDOW's frame, plus the minibuffer window if specified by the
MINIBUF argument. If the minibuffer counts, consider all windows on all
frames that share that minibuffer too. The following non-nil values of
ALL-FRAMES have special meanings:
- t means consider all windows on all existing frames.
- `visible' means consider all windows on all visible frames.
- 0 (the number zero) means consider all windows on all visible and
iconified frames.
- A frame means consider all windows on that frame only.
Anything else means consider all windows on WINDOW's frame and no
others.
If WINDOW is not on the list of windows returned, some other window will
be listed first but no error is signaled.
window-live-p
(window-live-p object)
Return t if OBJECT is a live window and nil otherwise.
A live window is a window that displays a buffer.
Internal windows and deleted windows are not live.
window-margins
(window-margins & [window])
Get width of marginal areas of window WINDOW.
If WINDOW is omitted or nil, it defaults to the selected window.
Value is a cons of the form (LEFT-WIDTH . RIGHT-WIDTH).
If a marginal area does not exist, its width will be returned
as nil.
window-minibuffer-p
(window-minibuffer-p & [window])
Return non-nil if WINDOW is a minibuffer window.
If WINDOW is omitted or nil, it defaults to the selected window.
window-new-normal
(window-new-normal & [window])
Return new normal size of window WINDOW.
If WINDOW is omitted or nil, it defaults to the selected window.
window-new-total
(window-new-total & [window])
Return the new total size of window WINDOW.
If WINDOW is omitted or nil, it defaults to the selected window.
window-next-buffers
(window-next-buffers & [window])
Return list of buffers recently re-shown in WINDOW.
WINDOW must be a live window and defaults to the selected one.
window-next-sibling
(window-next-sibling & [window])
Return the next sibling window of window WINDOW.
If WINDOW is omitted or nil, it defaults to the selected window.
Return nil if WINDOW has no next sibling.
window-normal-size
(window-normal-size & [window horizontal])
Return the normal height of window WINDOW.
If WINDOW is omitted or nil, it defaults to the selected window.
If HORIZONTAL is non-nil, return the normal width of WINDOW.
window-parameter
(window-parameter window parameter)
Return WINDOW's value for PARAMETER.
WINDOW defaults to the selected window.
window-parameters
(window-parameters & [window])
Return the parameters of WINDOW and their values.
WINDOW defaults to the selected window. The return value is a list of
elements of the form (PARAMETER . VALUE).
window-parent
(window-parent & [window])
Return the parent window of window WINDOW.
If WINDOW is omitted or nil, it defaults to the selected window.
Return nil for a window with no parent (e.g. a root window).
window-pixel-edges
(window-pixel-edges & [window])
Return a list of the edge pixel coordinates of WINDOW.
The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
the top left corner of the frame.
RIGHT is one more than the rightmost x position occupied by WINDOW.
BOTTOM is one more than the bottommost y position occupied by WINDOW.
The pixel edges include the space used by WINDOW's scroll bar, display
margins, fringes, header line, and/or mode line. For the pixel edges
of just the text area, use `window-inside-pixel-edges'.
window-point
(window-point & [window])
Return current value of point in WINDOW.
WINDOW must be a live window and defaults to the selected one.
For a nonselected window, this is the value point would have
if that window were selected.
Note that, when WINDOW is the selected window and its buffer
is also currently selected, the value returned is the same as (point).
It would be more strictly correct to return the `top-level' value
of point, outside of any save-excursion forms.
But that is hard to define.
window-prev-buffers
(window-prev-buffers & [window])
Return buffers previously shown in WINDOW.
WINDOW must be a live window and defaults to the selected one.
The return value is a list of elements (BUFFER WINDOW-START POS),
where BUFFER is a buffer, WINDOW-START is the start position of the
window for that buffer, and POS is a window-specific point value.
window-prev-sibling
(window-prev-sibling & [window])
Return the previous sibling window of window WINDOW.
If WINDOW is omitted or nil, it defaults to the selected window.
Return nil if WINDOW has no previous sibling.
window-redisplay-end-trigger
(window-redisplay-end-trigger & [window])
This function is obsolete since 23.1.
Return WINDOW's redisplay end trigger value.
WINDOW defaults to the selected window.
See `set-window-redisplay-end-trigger' for more information.
window-resize-apply
(window-resize-apply frame & [horizontal])
Apply requested size values for window-tree of FRAME.
Optional argument HORIZONTAL omitted or nil means apply requested height
values. HORIZONTAL non-nil means apply requested width values.
This function checks whether the requested values sum up to a valid
window layout, recursively assigns the new sizes of all child windows
and calculates and assigns the new start positions of these windows.
Note: This function does not check any of `window-fixed-size-p',
`window-min-height' or `window-min-width'. All these checks have to
be applied on the Elisp level.
window-start
(window-start & [window])
Return position at which display currently starts in WINDOW.
WINDOW must be a live window and defaults to the selected one.
This is updated by redisplay or by calling `set-window-start'.
window-text-height
(window-text-height & [window])
Return the height in lines of the text display area of WINDOW.
If WINDOW is omitted or nil, it defaults to the selected window.
The returned height does not include the mode line, any header line,
nor any partial-height lines at the bottom of the text area.
window-top-child
(window-top-child window)
Return the topmost child window of window WINDOW.
Return nil if WINDOW is a live window (live windows have no children).
Return nil if WINDOW is an internal window whose children form a
horizontal combination.
window-top-line
(window-top-line & [window])
Return top line of window WINDOW.
This is the distance, in lines, between the top of WINDOW and the top
of the frame's window area. For instance, the return value is 0 if
there is no window above WINDOW.
If WINDOW is omitted or nil, it defaults to the selected window.
window-total-height
(window-total-height & [window])
Return the total height, in lines, of window WINDOW.
If WINDOW is omitted or nil, it defaults to the selected window.
The return value includes the mode line and header line, if any.
If WINDOW is an internal window, the total height is the height
of the screen areas spanned by its children.
On a graphical display, this total height is reported as an
integer multiple of the default character height.
window-total-width
(window-total-width & [window])
Return the total width, in columns, of window WINDOW.
If WINDOW is omitted or nil, it defaults to the selected window.
The return value includes any vertical dividers or scroll bars
belonging to WINDOW. If WINDOW is an internal window, the total width
is the width of the screen areas spanned by its children.
On a graphical display, this total width is reported as an
integer multiple of the default character width.
window-use-time
(window-use-time & [window])
Return the use time of window WINDOW.
If WINDOW is omitted or nil, it defaults to the selected window.
The window with the highest use time is the most recently selected
one. The window with the lowest use time is the least recently
selected one.
windowp
(windowp object)
Return t if OBJECT is a window and nil otherwise.