Mercurial > hg > xemacs-beta

comparison man/lispref/windows.texi @ 5791:9fae6227ede5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Silence texinfo 5.2 warnings, primarily by adding next, prev, and up pointers to all nodes. See xemacs-patches message with ID <5315f7bf.sHpFD7lXYR05GH6E%james@xemacs.org>.
author Jerry James <james@xemacs.org>
date Thu, 27 Mar 2014 08:59:03 -0600
parents c6b1500299a7
children
comparison
equal deleted inserted replaced
5790:dcf9067f26bb 5791:9fae6227ede5
29 * Position of Window:: Accessing the position of a window. 29 * Position of Window:: Accessing the position of a window.
30 * Resizing Windows:: Changing the size of a window. 30 * Resizing Windows:: Changing the size of a window.
31 * Window Configurations:: Saving and restoring the state of the screen. 31 * Window Configurations:: Saving and restoring the state of the screen.
32 @end menu 32 @end menu
33 33
34 @node Basic Windows 34 @node Basic Windows, Splitting Windows, Windows, Windows
35 @section Basic Concepts of Emacs Windows 35 @section Basic Concepts of Emacs Windows
36 @cindex window 36 @cindex window
37 @cindex selected window 37 @cindex selected window
38 38
39 A @dfn{window} in XEmacs is the physical area of the screen in which a 39 A @dfn{window} in XEmacs is the physical area of the screen in which a
123 123
124 @defun windowp object 124 @defun windowp object
125 This function returns @code{t} if @var{object} is a window. 125 This function returns @code{t} if @var{object} is a window.
126 @end defun 126 @end defun
127 127
128 @node Splitting Windows 128 @node Splitting Windows, Deleting Windows, Basic Windows, Windows
129 @section Splitting Windows 129 @section Splitting Windows
130 @cindex splitting windows 130 @cindex splitting windows
131 @cindex window splitting 131 @cindex window splitting
132 132
133 The functions described here are the primitives used to split a window 133 The functions described here are the primitives used to split a window
292 (split-window nil (and arg (prefix-numeric-value arg)) t)) 292 (split-window nil (and arg (prefix-numeric-value arg)) t))
293 @end group 293 @end group
294 @end smallexample 294 @end smallexample
295 @end deffn 295 @end deffn
296 296
297 @node Deleting Windows 297 @node Deleting Windows, Selecting Windows, Splitting Windows, Windows
298 @section Deleting Windows 298 @section Deleting Windows
299 @cindex deleting windows 299 @cindex deleting windows
300 300
301 A window remains visible on its frame unless you @dfn{delete} it by 301 A window remains visible on its frame unless you @dfn{delete} it by
302 calling certain functions that delete windows. A deleted window cannot 302 calling certain functions that delete windows. A deleted window cannot
404 @end table 404 @end table
405 405
406 This function always returns @code{nil}. 406 This function always returns @code{nil}.
407 @end deffn 407 @end deffn
408 408
409 @node Selecting Windows 409 @node Selecting Windows, Cyclic Window Ordering, Deleting Windows, Windows
410 @section Selecting Windows 410 @section Selecting Windows
411 @cindex selecting windows 411 @cindex selecting windows
412 412
413 When a window is selected, the buffer in the window becomes the current 413 When a window is selected, the buffer in the window becomes the current
414 buffer, and the cursor will appear in it. 414 buffer, and the cursor will appear in it.
524 524
525 The remaining arguments control which set of windows are considered. 525 The remaining arguments control which set of windows are considered.
526 See @code{next-window}, above. 526 See @code{next-window}, above.
527 @end defun 527 @end defun
528 528
529 @node Cyclic Window Ordering 529 @node Cyclic Window Ordering, Buffers and Windows, Selecting Windows, Windows
530 @section Cyclic Ordering of Windows 530 @section Cyclic Ordering of Windows
531 @cindex cyclic ordering of windows 531 @cindex cyclic ordering of windows
532 @cindex ordering of windows, cyclic 532 @cindex ordering of windows, cyclic
533 @cindex window ordering, cyclic 533 @cindex window ordering, cyclic
534 534
667 667
668 The other arguments specify which windows to cycle through, as in 668 The other arguments specify which windows to cycle through, as in
669 @code{next-window}. 669 @code{next-window}.
670 @end defun 670 @end defun
671 671
672 @node Buffers and Windows 672 @node Buffers and Windows, Displaying Buffers, Cyclic Window Ordering, Windows
673 @section Buffers and Windows 673 @section Buffers and Windows
674 @cindex examining windows 674 @cindex examining windows
675 @cindex windows, controlling precisely 675 @cindex windows, controlling precisely
676 @cindex buffers, controlled in windows 676 @cindex buffers, controlled in windows
677 677
742 @code{(current-time)} in the specified buffer (@pxref{Time of Day}). 742 @code{(current-time)} in the specified buffer (@pxref{Time of Day}).
743 When a buffer is first created, @code{buffer-display-time} starts out 743 When a buffer is first created, @code{buffer-display-time} starts out
744 with the value @code{nil}. 744 with the value @code{nil}.
745 @end defvar 745 @end defvar
746 746
747 @node Displaying Buffers 747 @node Displaying Buffers, Choosing Window, Buffers and Windows, Windows
748 @section Displaying Buffers in Windows 748 @section Displaying Buffers in Windows
749 @cindex switching to a buffer 749 @cindex switching to a buffer
750 @cindex displaying a buffer 750 @cindex displaying a buffer
751 751
752 In this section we describe convenient functions that choose a window 752 In this section we describe convenient functions that choose a window
861 the same meaning as with @code{delete-windows-on}. 861 the same meaning as with @code{delete-windows-on}.
862 862
863 This function returns @code{nil}. 863 This function returns @code{nil}.
864 @end deffn 864 @end deffn
865 865
866 @node Choosing Window 866 @node Choosing Window, Window Point, Displaying Buffers, Windows
867 @section Choosing a Window for Display 867 @section Choosing a Window for Display
868 868
869 This section describes the basic facility that chooses a window to 869 This section describes the basic facility that chooses a window to
870 display a buffer in---@code{display-buffer}. All the higher-level 870 display a buffer in---@code{display-buffer}. All the higher-level
871 functions and commands use this subroutine. Here we describe how to use 871 functions and commands use this subroutine. Here we describe how to use
1056 @defun set-window-dedicated-p window flag 1056 @defun set-window-dedicated-p window flag
1057 This function marks @var{window} as dedicated if @var{flag} is 1057 This function marks @var{window} as dedicated if @var{flag} is
1058 non-@code{nil}, and nondedicated otherwise. 1058 non-@code{nil}, and nondedicated otherwise.
1059 @end defun 1059 @end defun
1060 1060
1061 @node Window Point 1061 @node Window Point, Window Start, Choosing Window, Windows
1062 @section Windows and Point 1062 @section Windows and Point
1063 @cindex window position 1063 @cindex window position
1064 @cindex window point 1064 @cindex window point
1065 @cindex position in window 1065 @cindex position in window
1066 @cindex point in window 1066 @cindex point in window
1181 If one of these is not done, the return value may be incorrect, even if 1181 If one of these is not done, the return value may be incorrect, even if
1182 it is non-nil. 1182 it is non-nil.
1183 1183
1184 @end defun 1184 @end defun
1185 1185
1186 @node Window Start 1186 @node Window Start, Vertical Scrolling, Window Point, Windows
1187 @section The Window Start Position 1187 @section The Window Start Position
1188 1188
1189 Each window contains a marker used to keep track of a buffer position 1189 Each window contains a marker used to keep track of a buffer position
1190 that specifies where in the buffer display should start. This position 1190 that specifies where in the buffer display should start. This position
1191 is called the @dfn{display-start} position of the window (or just the 1191 is called the @dfn{display-start} position of the window (or just the
1328 scrolling. If @var{position} is out of view only because @var{window} 1328 scrolling. If @var{position} is out of view only because @var{window}
1329 has been scrolled horizontally, @code{pos-visible-in-window-p} returns 1329 has been scrolled horizontally, @code{pos-visible-in-window-p} returns
1330 @code{t}. @xref{Horizontal Scrolling}. 1330 @code{t}. @xref{Horizontal Scrolling}.
1331 @end defun 1331 @end defun
1332 1332
1333 @node Vertical Scrolling 1333 @node Vertical Scrolling, Horizontal Scrolling, Window Start, Windows
1334 @section Vertical Scrolling 1334 @section Vertical Scrolling
1335 @cindex vertical scrolling 1335 @cindex vertical scrolling
1336 @cindex scrolling vertically 1336 @cindex scrolling vertically
1337 1337
1338 Vertical scrolling means moving the text up or down in a window. It 1338 Vertical scrolling means moving the text up or down in a window. It
1491 @code{recenter-top-bottom} with no argument cycle between placing 1491 @code{recenter-top-bottom} with no argument cycle between placing
1492 point at the middle, top, and bottom of the window. 1492 point at the middle, top, and bottom of the window.
1493 @end defopt 1493 @end defopt
1494 1494
1495 1495
1496 @node Horizontal Scrolling 1496 @node Horizontal Scrolling, Size of Window, Vertical Scrolling, Windows
1497 @section Horizontal Scrolling 1497 @section Horizontal Scrolling
1498 @cindex horizontal scrolling 1498 @cindex horizontal scrolling
1499 1499
1500 Because we read English first from top to bottom and second from left 1500 Because we read English first from top to bottom and second from left
1501 to right, horizontal scrolling is not like vertical scrolling. Vertical 1501 to right, horizontal scrolling is not like vertical scrolling. Vertical
1588 (>= (- (current-column) (window-hscroll window)) 0) 1588 (>= (- (current-column) (window-hscroll window)) 0)
1589 (< (- (current-column) (window-hscroll window)) 1589 (< (- (current-column) (window-hscroll window))
1590 (window-width window))))) 1590 (window-width window)))))
1591 @end group 1591 @end group
1592 @end example 1592 @end example
1593 @node Size of Window 1593 @node Size of Window, Position of Window, Horizontal Scrolling, Windows
1594 @section The Size of a Window 1594 @section The Size of a Window
1595 @cindex window size 1595 @cindex window size
1596 @cindex size of window 1596 @cindex size of window
1597 1597
1598 An Emacs window is rectangular, and its size information consists of 1598 An Emacs window is rectangular, and its size information consists of
1742 end of the buffer is not included. If optional argument @var{noclipped} 1742 end of the buffer is not included. If optional argument @var{noclipped}
1743 is non-@code{nil}, any space occupied by clipped lines will not be 1743 is non-@code{nil}, any space occupied by clipped lines will not be
1744 included. 1744 included.
1745 @end defun 1745 @end defun
1746 1746
1747 @node Position of Window 1747 @node Position of Window, Resizing Windows, Size of Window, Windows
1748 @section The Position of a Window 1748 @section The Position of a Window
1749 @cindex window position 1749 @cindex window position
1750 @cindex position of window 1750 @cindex position of window
1751 1751
1752 XEmacs provides functions to determine the absolute location of windows 1752 XEmacs provides functions to determine the absolute location of windows
1796 window, with respect to the top left corner of the window. It returns 1796 window, with respect to the top left corner of the window. It returns
1797 a list of integer pixel positions @code{(left top right bottom)}, all 1797 a list of integer pixel positions @code{(left top right bottom)}, all
1798 relative to @code{(0,0)} at the top left corner of the window. 1798 relative to @code{(0,0)} at the top left corner of the window.
1799 @end defun 1799 @end defun
1800 1800
1801 @node Resizing Windows 1801 @node Resizing Windows, Window Configurations, Position of Window, Windows
1802 @section Changing the Size of a Window 1802 @section Changing the Size of a Window
1803 @cindex window resizing 1803 @cindex window resizing
1804 @cindex changing window size 1804 @cindex changing window size
1805 @cindex window size, changing 1805 @cindex window size, changing
1806 1806
1932 functions, because that always counts as a size change, and it would 1932 functions, because that always counts as a size change, and it would
1933 cause these functions to be called over and over. In most cases, 1933 cause these functions to be called over and over. In most cases,
1934 @code{save-selected-window} is what you need here. 1934 @code{save-selected-window} is what you need here.
1935 @end defvar 1935 @end defvar
1936 1936
1937 @node Window Configurations 1937 @node Window Configurations, , Resizing Windows, Windows
1938 @section Window Configurations 1938 @section Window Configurations
1939 @cindex window configurations 1939 @cindex window configurations
1940 @cindex saving window information 1940 @cindex saving window information
1941 1941
1942 A @dfn{window configuration} records the entire layout of a 1942 A @dfn{window configuration} records the entire layout of a