Mercurial > hg > xemacs-beta

comparison man/lispref/windows.texi @ 292:6cb5e14cd98e r21-0b44

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import from CVS: tag r21-0b44
author cvs
date Mon, 13 Aug 2007 10:37:15 +0200
parents c9fe270a4101
children a4f53d9b3154
comparison
equal deleted inserted replaced
291:7aa74ac42bd2 292:6cb5e14cd98e
429 as focus changes from device to device. Optional argument @var{device} 429 as focus changes from device to device. Optional argument @var{device}
430 specifies which device to return the selected window for, and defaults 430 specifies which device to return the selected window for, and defaults
431 to the selected device. 431 to the selected device.
432 @end defun 432 @end defun
433 433
434 @defun select-window window 434 @defun select-window window &optional norecord
435 This function makes @var{window} the selected window. The cursor then 435 This function makes @var{window} the selected window. The cursor then
436 appears in @var{window} (on redisplay). The buffer being displayed in 436 appears in @var{window} (on redisplay). The buffer being displayed in
437 @var{window} is immediately designated the current buffer. 437 @var{window} is immediately designated the current buffer.
438
439 If optional argument @var{norecord} is non-@code{nil} then the global
440 and per-frame buffer orderings are not modified, as by the function
441 @code{record-buffer}.
438 442
439 The return value is @var{window}. 443 The return value is @var{window}.
440 444
441 @example 445 @example
442 @group 446 @group
1566 @result{} 600 1570 @result{} 600
1567 @end group 1571 @end group
1568 @end example 1572 @end example
1569 @end defun 1573 @end defun
1570 1574
1575 @defun window-text-area-pixel-height &optional window
1576 This function returns the height in pixels of the text displaying
1577 portion of @var{window}, which defaults to the selected window. Unlike
1578 @code{window-pixel-height}, the space occupied by the modeline and
1579 horizontal scrollbar, if any, is not counted.
1580 @end defun
1581
1582 @defun window-text-area-pixel-width &optional window
1583 This function returns the width in pixels of the text displaying
1584 portion of @var{window}, which defaults to the selected window. Unlike
1585 @code{window-pixel-width}, the space occupied by the vertical scrollbar
1586 and divider, if any, is not counted.
1587 @end defun
1588
1589 @defun window-displayed-text-pixel-height &optional window noclipped
1590 This function returns the height in pixels of the text displayed in
1591 @var{window}, which defaults to the selected window. Unlike
1592 @code{window-text-area-pixel-height}, any blank space below the
1593 end of the buffer is not included. If optional argument @var{noclipped}
1594 is non-@code{nil}, any space occupied by clipped lines will not be
1595 included.
1596 @end defun
1597
1571 @node Position of Window 1598 @node Position of Window
1572 @section The Position of a Window 1599 @section The Position of a Window
1573 @cindex window position 1600 @cindex window position
1574 @cindex position of window 1601 @cindex position of window
1575 1602
1612 @defun window-lowest-p window 1639 @defun window-lowest-p window
1613 This function returns non-@code{nil} if @var{window} is along the 1640 This function returns non-@code{nil} if @var{window} is along the
1614 bottom of its frame. 1641 bottom of its frame.
1615 @end defun 1642 @end defun
1616 1643
1644 @defun window-text-area-pixel-edges &optional window
1645 This function allows one to determine the location of the
1646 text-displaying portion of @var{window}, which defaults to the selected
1647 window, with respect to the top left corner of the window. It returns
1648 a list of integer pixel positions @code{(left top right bottom)}, all
1649 relative to @code{(0,0)} at the top left corner of the window.
1650 @end defun
1651
1617 @node Resizing Windows 1652 @node Resizing Windows
1618 @section Changing the Size of a Window 1653 @section Changing the Size of a Window
1619 @cindex window resizing 1654 @cindex window resizing
1620 @cindex changing window size 1655 @cindex changing window size
1621 @cindex window size, changing 1656 @cindex window size, changing
1623 The window size functions fall into two classes: high-level commands 1658 The window size functions fall into two classes: high-level commands
1624 that change the size of windows and low-level functions that access 1659 that change the size of windows and low-level functions that access
1625 window size. XEmacs does not permit overlapping windows or gaps between 1660 window size. XEmacs does not permit overlapping windows or gaps between
1626 windows, so resizing one window affects other windows. 1661 windows, so resizing one window affects other windows.
1627 1662
1628 @deffn Command enlarge-window size &optional horizontal 1663 @deffn Command enlarge-window size &optional horizontal window
1629 This function makes the selected window @var{size} lines taller, 1664 This function makes the selected window @var{size} lines taller,
1630 stealing lines from neighboring windows. It takes the lines from one 1665 stealing lines from neighboring windows. It takes the lines from one
1631 window at a time until that window is used up, then takes from another. 1666 window at a time until that window is used up, then takes from another.
1632 If a window from which lines are stolen shrinks below 1667 If a window from which lines are stolen shrinks below
1633 @code{window-min-height} lines, that window disappears. 1668 @code{window-min-height} lines, that window disappears.
1643 1678
1644 If @var{size} is negative, this function shrinks the window by 1679 If @var{size} is negative, this function shrinks the window by
1645 @minus{}@var{size} lines or columns. If that makes the window smaller 1680 @minus{}@var{size} lines or columns. If that makes the window smaller
1646 than the minimum size (@code{window-min-height} and 1681 than the minimum size (@code{window-min-height} and
1647 @code{window-min-width}), @code{enlarge-window} deletes the window. 1682 @code{window-min-width}), @code{enlarge-window} deletes the window.
1683
1684 If @var{window} is non-@code{nil}, it specifies a window to change
1685 instead of the selected window.
1648 1686
1649 @code{enlarge-window} returns @code{nil}. 1687 @code{enlarge-window} returns @code{nil}.
1650 @end deffn 1688 @end deffn
1651 1689
1652 @deffn Command enlarge-window-horizontally columns 1690 @deffn Command enlarge-window-horizontally columns
1667 means to grow sideways @var{count} pixels, and optional third argument 1705 means to grow sideways @var{count} pixels, and optional third argument
1668 @var{window} specifies the window to change instead of the selected 1706 @var{window} specifies the window to change instead of the selected
1669 window. 1707 window.
1670 @end deffn 1708 @end deffn
1671 1709
1672 @deffn Command shrink-window size &optional horizontal 1710 @deffn Command shrink-window size &optional horizontal window
1673 This function is like @code{enlarge-window} but negates the argument 1711 This function is like @code{enlarge-window} but negates the argument
1674 @var{size}, making the selected window smaller by giving lines (or 1712 @var{size}, making the selected window smaller by giving lines (or
1675 columns) to the other windows. If the window shrinks below 1713 columns) to the other windows. If the window shrinks below
1676 @code{window-min-height} or @code{window-min-width}, then it disappears. 1714 @code{window-min-height} or @code{window-min-width}, then it disappears.
1677 1715
1678 If @var{size} is negative, the window is enlarged by @minus{}@var{size} 1716 If @var{size} is negative, the window is enlarged by @minus{}@var{size}
1679 lines or columns. 1717 lines or columns.
1718
1719 If @var{window} is non-@code{nil}, it specifies a window to change
1720 instead of the selected window.
1680 @end deffn 1721 @end deffn
1681 1722
1682 @deffn Command shrink-window-horizontally columns 1723 @deffn Command shrink-window-horizontally columns
1683 This function makes the selected window @var{columns} narrower. 1724 This function makes the selected window @var{columns} narrower.
1684 It could be defined as follows: 1725 It could be defined as follows: