diff options
| author | Eli Zaretskii | 2017-04-13 20:52:30 +0300 |
|---|---|---|
| committer | Eli Zaretskii | 2017-04-13 20:52:30 +0300 |
| commit | 030c4f94b630f8ca925ad59e814dc1f4fa69cfe3 (patch) | |
| tree | 50672beff759c88e5bc02ae27c66443208533b8f | |
| parent | dbae41896c325de5cae3d98afedb27f42e306ed5 (diff) | |
| download | emacs-030c4f94b630f8ca925ad59e814dc1f4fa69cfe3.tar.gz emacs-030c4f94b630f8ca925ad59e814dc1f4fa69cfe3.zip | |
Minor copyedits of recent changes in documentation
* doc/lispref/frames.texi (Frame Layout, Frame Position)
(Frame Size, Frame Interaction Parameters, Input Focus)
(Raising and Lowering, Child Frames): Improve wording and indexing.
* doc/emacs/cmdargs.texi (Borders X): Improve indexing.
| -rw-r--r-- | doc/emacs/cmdargs.texi | 1 | ||||
| -rw-r--r-- | doc/lispref/frames.texi | 174 | ||||
| -rw-r--r-- | doc/lispref/windows.texi | 6 |
3 files changed, 96 insertions, 85 deletions
diff --git a/doc/emacs/cmdargs.texi b/doc/emacs/cmdargs.texi index 721a2cebb22..6c39fe7b644 100644 --- a/doc/emacs/cmdargs.texi +++ b/doc/emacs/cmdargs.texi | |||
| @@ -1077,6 +1077,7 @@ frame's text area), in pixels. | |||
| 1077 | @itemx --border-width=@var{width} | 1077 | @itemx --border-width=@var{width} |
| 1078 | @opindex --border-width | 1078 | @opindex --border-width |
| 1079 | @cindex main border width, command-line argument | 1079 | @cindex main border width, command-line argument |
| 1080 | @cindex outer border width, command-line argument | ||
| 1080 | Specify @var{width} as the width of the outer border, in pixels. | 1081 | Specify @var{width} as the width of the outer border, in pixels. |
| 1081 | @end table | 1082 | @end table |
| 1082 | 1083 | ||
diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi index 2fac8020ffb..b8f42578111 100644 --- a/doc/lispref/frames.texi +++ b/doc/lispref/frames.texi | |||
| @@ -505,17 +505,17 @@ two frames adjacent to each other on the screen. Usually, the outer | |||
| 505 | size of a frame is available only after the frame has been mapped (made | 505 | size of a frame is available only after the frame has been mapped (made |
| 506 | visible, @pxref{Visibility of Frames}) at least once. For the initial | 506 | visible, @pxref{Visibility of Frames}) at least once. For the initial |
| 507 | frame or a frame that has not been created yet, the outer size can be | 507 | frame or a frame that has not been created yet, the outer size can be |
| 508 | estimated only or must be calculated from the window-system's or window | 508 | only estimated or must be calculated from the window-system's or window |
| 509 | manager defaults. One workaround is to obtain the differences of the | 509 | manager's defaults. One workaround is to obtain the differences of the |
| 510 | outer and native (see below) sizes of a mapped frame and use them for | 510 | outer and native (see below) sizes of a mapped frame and use them for |
| 511 | calculating the outer size of the new frame. | 511 | calculating the outer size of the new frame. |
| 512 | 512 | ||
| 513 | @cindex outer position | 513 | @cindex outer position |
| 514 | The upper left corner of the outer frame (indicated by @samp{(0)} in the | 514 | The position of the upper left corner of the outer frame (indicated by |
| 515 | drawing above) is the @dfn{outer position} of the frame. The outer | 515 | @samp{(0)} in the drawing above) is the @dfn{outer position} of the |
| 516 | position of a graphical frame is also referred to as ``the position'' of | 516 | frame. The outer position of a graphical frame is also referred to as |
| 517 | the frame because it usually remains unchanged on its display whenever | 517 | ``the position'' of the frame because it usually remains unchanged on |
| 518 | the frame is resized or its layout is changed. | 518 | its display whenever the frame is resized or its layout is changed. |
| 519 | 519 | ||
| 520 | The outer position is specified by and can be set via the @code{left} | 520 | The outer position is specified by and can be set via the @code{left} |
| 521 | and @code{top} frame parameters (@pxref{Position Parameters}). For a | 521 | and @code{top} frame parameters (@pxref{Position Parameters}). For a |
| @@ -551,22 +551,24 @@ frames (@pxref{Child Frames}) and @code{undecorated} or | |||
| 551 | @code{override-redirect} frames (@pxref{Management Parameters}). | 551 | @code{override-redirect} frames (@pxref{Management Parameters}). |
| 552 | 552 | ||
| 553 | Outer borders are never shown on text terminal frames and on frames | 553 | Outer borders are never shown on text terminal frames and on frames |
| 554 | generated by GTK+ routines. On Windows, the outer border is emulated | 554 | generated by GTK+ routines. On MS-Windows, the outer border is emulated |
| 555 | with the help of a one pixel wide external border. Non-toolkit builds | 555 | with the help of a one pixel wide external border. Non-toolkit builds |
| 556 | allow to change the color of the outer border by setting the | 556 | on X allow to change the color of the outer border by setting the |
| 557 | @code{border-color} frame parameter (@pxref{Layout Parameters}). | 557 | @code{border-color} frame parameter (@pxref{Layout Parameters}). |
| 558 | 558 | ||
| 559 | @item Title Bar | 559 | @item Title Bar |
| 560 | @cindex title bar | 560 | @cindex title bar |
| 561 | The @dfn{title bar} is also part of the window manager's decorations and | 561 | @cindex caption bar |
| 562 | typically displays the title of the frame (@pxref{Frame Titles}) as well | 562 | The @dfn{title bar}, a.k.a.@ @dfn{caption bar}, is also part of the |
| 563 | as buttons for minimizing, maximizing and deleting the frame. It can be | 563 | window manager's decorations and typically displays the title of the |
| 564 | also used for dragging the frame with the mouse. The title bar is | 564 | frame (@pxref{Frame Titles}) as well as buttons for minimizing, |
| 565 | usually not displayed for fullboth (@pxref{Size Parameters}), tooltip | 565 | maximizing and deleting the frame. It can be also used for dragging |
| 566 | (@pxref{Tooltips}) and child frames (@pxref{Child Frames}) and doesn't | 566 | the frame with the mouse. The title bar is usually not displayed for |
| 567 | exist for terminal frames. Display of the title bar can be suppressed | 567 | fullboth (@pxref{Size Parameters}), tooltip (@pxref{Tooltips}) and |
| 568 | by setting the @code{override-redirect} or the @code{undecorated} frame | 568 | child frames (@pxref{Child Frames}) and doesn't exist for terminal |
| 569 | parameters (@pxref{Management Parameters}). | 569 | frames. Display of the title bar can be suppressed by setting the |
| 570 | @code{override-redirect} or the @code{undecorated} frame parameters | ||
| 571 | (@pxref{Management Parameters}). | ||
| 570 | 572 | ||
| 571 | @item Menu Bar | 573 | @item Menu Bar |
| 572 | @cindex internal menu bar | 574 | @cindex internal menu bar |
| @@ -582,11 +584,12 @@ and Frames}). As a rule, menu bars are never shown on child frames | |||
| 582 | setting the @code{menu-bar-lines} parameter (@pxref{Layout Parameters}) | 584 | setting the @code{menu-bar-lines} parameter (@pxref{Layout Parameters}) |
| 583 | to zero. | 585 | to zero. |
| 584 | 586 | ||
| 585 | It depends on the toolkit whether to wrap or truncate the menu bar | 587 | Whether the menu bar is wrapped or truncated whenever its width |
| 586 | whenever it becomes too long to fit on its frame. Usually, only Motif | 588 | becomes too large to fit on its frame depends on the toolkit . |
| 587 | and Windows builds can wrap the menu bar. When they (un-)wrap the menu | 589 | Usually, only Motif and MS-Windows builds can wrap the menu bar. When |
| 588 | bar, they try to keep the outer height of the frame unchanged, so the | 590 | they (un-)wrap the menu bar, they try to keep the outer height of the |
| 589 | native height of the frame (see below) will change instead. | 591 | frame unchanged, so the native height of the frame (see below) will |
| 592 | change instead. | ||
| 590 | 593 | ||
| 591 | @item Tool Bar | 594 | @item Tool Bar |
| 592 | @cindex internal tool bar | 595 | @cindex internal tool bar |
| @@ -602,12 +605,13 @@ setting the @code{tool-bar-lines} parameter (@pxref{Layout | |||
| 602 | Parameters}) to zero. | 605 | Parameters}) to zero. |
| 603 | 606 | ||
| 604 | If the variable @code{auto-resize-tool-bars} is non-@code{nil}, Emacs | 607 | If the variable @code{auto-resize-tool-bars} is non-@code{nil}, Emacs |
| 605 | wraps the internal tool bar when it becomes too long for its frame. If | 608 | wraps the internal tool bar when its width becomes too large for its |
| 606 | and when Emacs (un-)wraps the internal tool bar, it by default keeps the | 609 | frame. If and when Emacs (un-)wraps the internal tool bar, it by |
| 607 | outer height of the frame unchanged, so the native height of the frame | 610 | default keeps the outer height of the frame unchanged, so the native |
| 608 | (see below) will change instead. Emacs built with GTK+, on the other | 611 | height of the frame (see below) will change instead. Emacs built with |
| 609 | hand, never wraps the tool bar but may automatically increase the outer | 612 | GTK+, on the other hand, never wraps the tool bar but may |
| 610 | width of a frame in order to accommodate an overlong tool bar. | 613 | automatically increase the outer width of a frame in order to |
| 614 | accommodate an overlong tool bar. | ||
| 611 | 615 | ||
| 612 | @item Native Frame | 616 | @item Native Frame |
| 613 | @cindex native frame | 617 | @cindex native frame |
| @@ -631,14 +635,14 @@ button in the title bar or when dragging its external border with the | |||
| 631 | mouse. | 635 | mouse. |
| 632 | 636 | ||
| 633 | @cindex native position | 637 | @cindex native position |
| 634 | The top left corner of the native frame specifies the @dfn{native | 638 | The position of the top left corner of the native frame specifies the |
| 635 | position} of the frame. (1)--(3) in the drawing above indicate that | 639 | @dfn{native position} of the frame. (1)--(3) in the drawing above |
| 636 | position for the various builds: | 640 | indicate that position for the various builds: |
| 637 | 641 | ||
| 638 | @itemize @w{} | 642 | @itemize @w{} |
| 639 | @item (1) non-toolkit and terminal frames | 643 | @item (1) non-toolkit and terminal frames |
| 640 | 644 | ||
| 641 | @item (2) Lucid, Motif and Windows frames | 645 | @item (2) Lucid, Motif and MS-Windows frames |
| 642 | 646 | ||
| 643 | @item (3) GTK+ and NS frames | 647 | @item (3) GTK+ and NS frames |
| 644 | @end itemize | 648 | @end itemize |
| @@ -697,11 +701,11 @@ The @dfn{text area} of a frame is a somewhat fictitious area that can be | |||
| 697 | embedded in the native frame. Its position is unspecified. Its width | 701 | embedded in the native frame. Its position is unspecified. Its width |
| 698 | can be obtained by removing from that of the native width the widths of | 702 | can be obtained by removing from that of the native width the widths of |
| 699 | the internal border, one vertical scroll bar, and one left and one right | 703 | the internal border, one vertical scroll bar, and one left and one right |
| 700 | fringe as specified for this frame, see @ref{Layout Parameters}. Its | 704 | fringe if they are specified for this frame, see @ref{Layout |
| 701 | height can be obtained by removing from that of the native height the | 705 | Parameters}. Its height can be obtained by removing from that of the |
| 702 | widths of the internal border and the heights of the frame's internal | 706 | native height the widths of the internal border and the heights of the |
| 703 | menu and tool bars and one horizontal scroll bar as specified for this | 707 | frame's internal menu and tool bars and one horizontal scroll bar if |
| 704 | frame. | 708 | specified for this frame. |
| 705 | @end table | 709 | @end table |
| 706 | 710 | ||
| 707 | @cindex absolute position | 711 | @cindex absolute position |
| @@ -715,7 +719,7 @@ horizontal and vertical pixel offsets relative to an origin (0, 0) of | |||
| 715 | the frame's display. Correspondingly, the @dfn{absolute edges} of a | 719 | the frame's display. Correspondingly, the @dfn{absolute edges} of a |
| 716 | frame are given as pixel offsets from that origin. | 720 | frame are given as pixel offsets from that origin. |
| 717 | 721 | ||
| 718 | Note that with multiple monitors the origin of the display does not | 722 | Note that with multiple monitors, the origin of the display does not |
| 719 | necessarily coincide with the top-left corner of the entire usable | 723 | necessarily coincide with the top-left corner of the entire usable |
| 720 | display area of the terminal. Hence the absolute position of a frame | 724 | display area of the terminal. Hence the absolute position of a frame |
| 721 | can be negative in such an environment even when that frame is | 725 | can be negative in such an environment even when that frame is |
| @@ -724,7 +728,7 @@ completely visible. | |||
| 724 | By convention, vertical offsets increase ``downwards''. This means | 728 | By convention, vertical offsets increase ``downwards''. This means |
| 725 | that the height of a frame is obtained by subtracting the offset of its | 729 | that the height of a frame is obtained by subtracting the offset of its |
| 726 | top edge from that of its bottom edge. Horizontal offsets increase | 730 | top edge from that of its bottom edge. Horizontal offsets increase |
| 727 | ``leftwards'' as expected so a frame's width is calculated by | 731 | ``rightwards'', as expected, so a frame's width is calculated by |
| 728 | subtracting the offset of its left edge from that of its right edge. | 732 | subtracting the offset of its left edge from that of its right edge. |
| 729 | 733 | ||
| 730 | For a frame on a graphical terminal the following function returns the | 734 | For a frame on a graphical terminal the following function returns the |
| @@ -734,9 +738,10 @@ sizes of the areas described above: | |||
| 734 | This function returns geometric attributes of @var{frame}. The return | 738 | This function returns geometric attributes of @var{frame}. The return |
| 735 | value is an association list of the attributes listed below. All | 739 | value is an association list of the attributes listed below. All |
| 736 | coordinate, height and width values are integers counting pixels. Note | 740 | coordinate, height and width values are integers counting pixels. Note |
| 737 | that if @var{frame} has not been mapped (@pxref{Visibility of Frames}) | 741 | that if @var{frame} has not been mapped yet, (@pxref{Visibility of |
| 738 | yet, some of the return values may only represent approximations of the | 742 | Frames}) some of the return values may only represent approximations of |
| 739 | actual values---those that can be seen after the frame has been mapped. | 743 | the actual values---those that can be seen after the frame has been |
| 744 | mapped. | ||
| 740 | 745 | ||
| 741 | @table @code | 746 | @table @code |
| 742 | @item outer-position | 747 | @item outer-position |
| @@ -792,10 +797,10 @@ native and inner frame. | |||
| 792 | @defun frame-edges &optional frame type | 797 | @defun frame-edges &optional frame type |
| 793 | This function returns the absolute edges of the outer, native or inner | 798 | This function returns the absolute edges of the outer, native or inner |
| 794 | frame of @var{frame}. @var{frame} must be a live frame and defaults to | 799 | frame of @var{frame}. @var{frame} must be a live frame and defaults to |
| 795 | the selected one. The list returned has the form (@var{left} @var{top} | 800 | the selected one. The returned list has the form @w{@code{(@var{left} |
| 796 | @var{right} @var{bottom}) where all values are in pixels relative to the | 801 | @var{top} @var{right} @var{bottom})}} where all values are in pixels |
| 797 | origin of @var{frame}'s display. For terminal frames the values | 802 | relative to the origin of @var{frame}'s display. For terminal frames |
| 798 | returned for @var{left} and @var{top} are always zero. | 803 | the values returned for @var{left} and @var{top} are always zero. |
| 799 | 804 | ||
| 800 | Optional argument @var{type} specifies the type of the edges to return: | 805 | Optional argument @var{type} specifies the type of the edges to return: |
| 801 | @code{outer-edges} means to return the outer edges of @var{frame}, | 806 | @code{outer-edges} means to return the outer edges of @var{frame}, |
| @@ -803,14 +808,15 @@ Optional argument @var{type} specifies the type of the edges to return: | |||
| 803 | @code{inner-edges} means to return its inner edges. | 808 | @code{inner-edges} means to return its inner edges. |
| 804 | 809 | ||
| 805 | By convention, the pixels of the display at the values returned for | 810 | By convention, the pixels of the display at the values returned for |
| 806 | @var{left} and @var{top} are inside (part of) @var{frame}. Hence, if | 811 | @var{left} and @var{top} are considered to be inside (part of) |
| 807 | @var{left} and @var{top} are both zero, the pixel at the display's | 812 | @var{frame}. Hence, if @var{left} and @var{top} are both zero, the |
| 808 | origin is part of @var{frame}. The pixels at @var{bottom} and | 813 | pixel at the display's origin is part of @var{frame}. The pixels at |
| 809 | @var{right}, on the other hand, lie immediately outside @var{frame}. | 814 | @var{bottom} and @var{right}, on the other hand, are considered to lie |
| 810 | This means that if you have, for example, two side-by-side frames | 815 | immediately outside @var{frame}. This means that if you have, for |
| 811 | positioned such that the right outer edge of the frame on the left | 816 | example, two side-by-side frames positioned such that the right outer |
| 812 | equals the left outer edge of the frame on the right, the pixels at that | 817 | edge of the frame on the left equals the left outer edge of the frame on |
| 813 | edge show a part of the frame on the right. | 818 | the right, the pixels at that edge show a part of the frame on the |
| 819 | right. | ||
| 814 | @end defun | 820 | @end defun |
| 815 | 821 | ||
| 816 | 822 | ||
| @@ -878,21 +884,21 @@ Geometry}). The position of a child frame (@pxref{Child Frames}) is | |||
| 878 | specified via pixel offsets of its outer edges relative to the native | 884 | specified via pixel offsets of its outer edges relative to the native |
| 879 | position of its parent frame. | 885 | position of its parent frame. |
| 880 | 886 | ||
| 881 | You can read or change the position of a frame using the frame | 887 | You can access or change the position of a frame using the frame |
| 882 | parameters @code{left} and @code{top} (@pxref{Position Parameters}). | 888 | parameters @code{left} and @code{top} (@pxref{Position Parameters}). |
| 883 | Here are two additional functions for working with the positions of an | 889 | Here are two additional functions for working with the positions of an |
| 884 | existing, visible frame. For both functions, the argument @var{frame} | 890 | existing, visible frame. For both functions, the argument @var{frame} |
| 885 | must denote a live frame and defaults to the selected frame. | 891 | must denote a live frame and defaults to the selected frame. |
| 886 | 892 | ||
| 887 | @defun frame-position &optional frame | 893 | @defun frame-position &optional frame |
| 888 | For a normal, non-child frame this function returns a cons of the (X, Y) | 894 | For a normal, non-child frame this function returns a cons of the pixel |
| 889 | pixel coordinates of its outer position (@pxref{Frame Layout}) with | 895 | coordinates of its outer position (@pxref{Frame Layout}) with respect to |
| 890 | respect to the origin (0, 0) of its display. For a child frame | 896 | the origin @code{(0, 0)} of its display. For a child frame |
| 891 | (@pxref{Child Frames}) this function returns the pixel coordinates of | 897 | (@pxref{Child Frames}) this function returns the pixel coordinates of |
| 892 | its outer position with respect to an origin (0, 0) at the native | 898 | its outer position with respect to an origin @code{(0, 0)} at the native |
| 893 | position of @var{frame}'s parent. | 899 | position of @var{frame}'s parent. |
| 894 | 900 | ||
| 895 | Negative return values never indicate an offset from the right or bottom | 901 | Negative values never indicate an offset from the right or bottom |
| 896 | edge of @var{frame}'s display or parent frame. Rather, they mean that | 902 | edge of @var{frame}'s display or parent frame. Rather, they mean that |
| 897 | @var{frame}'s outer position is on the left and/or above the origin of | 903 | @var{frame}'s outer position is on the left and/or above the origin of |
| 898 | its display or the native position of its parent frame. This usually | 904 | its display or the native position of its parent frame. This usually |
| @@ -907,7 +913,7 @@ On a text terminal frame both values are zero. | |||
| 907 | @defun set-frame-position frame x y | 913 | @defun set-frame-position frame x y |
| 908 | This function sets the outer frame position of @var{frame} to (@var{x}, | 914 | This function sets the outer frame position of @var{frame} to (@var{x}, |
| 909 | @var{y}). The latter arguments specify pixels and normally count from | 915 | @var{y}). The latter arguments specify pixels and normally count from |
| 910 | an origin at the position (0, 0) of @var{frame}'s display. For child | 916 | the origin at the position (0, 0) of @var{frame}'s display. For child |
| 911 | frames, they count from the native position of @var{frame}'s parent | 917 | frames, they count from the native position of @var{frame}'s parent |
| 912 | frame. | 918 | frame. |
| 913 | 919 | ||
| @@ -921,14 +927,15 @@ edge of @var{frame} exactly at the right or bottom edge of its display | |||
| 921 | or parent frame. Neither do they allow to specify a position that does | 927 | or parent frame. Neither do they allow to specify a position that does |
| 922 | not lie within the edges of the display or parent frame. The frame | 928 | not lie within the edges of the display or parent frame. The frame |
| 923 | parameters @code{left} and @code{top} (@pxref{Position Parameters}) | 929 | parameters @code{left} and @code{top} (@pxref{Position Parameters}) |
| 924 | allow to do that but may still fail to provide good results for the | 930 | allow to do that, but may still fail to provide good results for the |
| 925 | initial or a new frame. | 931 | initial or a new frame. |
| 926 | 932 | ||
| 927 | This function has no effect on text terminal frames. | 933 | This function has no effect on text terminal frames. |
| 928 | @end defun | 934 | @end defun |
| 929 | 935 | ||
| 930 | @defvar move-frame-functions | 936 | @defvar move-frame-functions |
| 931 | This hook specifies the functions run when an Emacs frame is moved | 937 | @cindex frame position changes, a hook |
| 938 | This hook specifies the functions that are run when an Emacs frame is moved | ||
| 932 | (assigned a new position) by the window-system or window manager. The | 939 | (assigned a new position) by the window-system or window manager. The |
| 933 | functions are run with one argument, the frame that moved. For a child | 940 | functions are run with one argument, the frame that moved. For a child |
| 934 | frame (@pxref{Child Frames}), the functions are run only when the | 941 | frame (@pxref{Child Frames}), the functions are run only when the |
| @@ -954,8 +961,8 @@ This means that in general you cannot use the native size to specify the | |||
| 954 | initial size of a frame. As soon as you know the native size of a | 961 | initial size of a frame. As soon as you know the native size of a |
| 955 | visible frame, you can calculate its outer size (@pxref{Frame Layout}) | 962 | visible frame, you can calculate its outer size (@pxref{Frame Layout}) |
| 956 | by adding in the remaining components from the return value of | 963 | by adding in the remaining components from the return value of |
| 957 | @code{frame-geometry} . For invisible frames or for frames that have | 964 | @code{frame-geometry}. For invisible frames or for frames that have |
| 958 | yet to be created, however, the outer size can be estimated only. This | 965 | yet to be created, however, the outer size can only be estimated. This |
| 959 | also means that calculating an exact initial position of a frame | 966 | also means that calculating an exact initial position of a frame |
| 960 | specified via offsets from the right or bottom edge of the screen | 967 | specified via offsets from the right or bottom edge of the screen |
| 961 | (@pxref{Frame Position}) is impossible. | 968 | (@pxref{Frame Position}) is impossible. |
| @@ -1006,8 +1013,8 @@ leaving some empty space below and/or on the right of the frame. The | |||
| 1006 | following option may help in that case. | 1013 | following option may help in that case. |
| 1007 | 1014 | ||
| 1008 | @defopt frame-resize-pixelwise | 1015 | @defopt frame-resize-pixelwise |
| 1009 | If this option is @code{nil}, a frame's text pixel size is usually | 1016 | If this option is @code{nil} (the default), a frame's text pixel size is |
| 1010 | rounded to a multiple of the current values of that frame's | 1017 | usually rounded to a multiple of the current values of that frame's |
| 1011 | @code{frame-char-height} and @code{frame-char-width} whenever the frame | 1018 | @code{frame-char-height} and @code{frame-char-width} whenever the frame |
| 1012 | is resized. If this is non-@code{nil}, no rounding occurs, hence frame | 1019 | is resized. If this is non-@code{nil}, no rounding occurs, hence frame |
| 1013 | sizes can increase/decrease by one pixel. | 1020 | sizes can increase/decrease by one pixel. |
| @@ -1747,6 +1754,8 @@ If non-@code{nil}, this frame's window is never split automatically. | |||
| 1747 | 1754 | ||
| 1748 | @node Frame Interaction Parameters | 1755 | @node Frame Interaction Parameters |
| 1749 | @subsubsection Frame Interaction Parameters | 1756 | @subsubsection Frame Interaction Parameters |
| 1757 | @cindex frame interaction parameters | ||
| 1758 | @cindex interaction parameters between frames | ||
| 1750 | 1759 | ||
| 1751 | These parameters supply forms of interactions between different frames. | 1760 | These parameters supply forms of interactions between different frames. |
| 1752 | 1761 | ||
| @@ -1754,7 +1763,7 @@ These parameters supply forms of interactions between different frames. | |||
| 1754 | @vindex parent-frame, a frame parameter | 1763 | @vindex parent-frame, a frame parameter |
| 1755 | @item parent-frame | 1764 | @item parent-frame |
| 1756 | If non-@code{nil}, this means that this frame is a child frame | 1765 | If non-@code{nil}, this means that this frame is a child frame |
| 1757 | (@pxref{Child Frames}) and this parameter specifies its parent frame. | 1766 | (@pxref{Child Frames}), and this parameter specifies its parent frame. |
| 1758 | If nil, this means that this frame is a normal, top-level frame. | 1767 | If nil, this means that this frame is a normal, top-level frame. |
| 1759 | 1768 | ||
| 1760 | @vindex delete-before, a frame parameter | 1769 | @vindex delete-before, a frame parameter |
| @@ -1852,13 +1861,13 @@ display bugs or pine for that retro, flicker-y feeling. | |||
| 1852 | If non-@code{nil}, this tells the window manager to remove the frame's | 1861 | If non-@code{nil}, this tells the window manager to remove the frame's |
| 1853 | icon from the taskbar associated with the frame's display and inhibit | 1862 | icon from the taskbar associated with the frame's display and inhibit |
| 1854 | switching to the frame's window via the combination @kbd{Alt-@key{TAB}}. | 1863 | switching to the frame's window via the combination @kbd{Alt-@key{TAB}}. |
| 1855 | On Windows, iconifying such a frame will "roll in" its window-system | 1864 | On MS-Windows, iconifying such a frame will "roll in" its window-system |
| 1856 | window at the bottom of the desktop. Some window managers may not honor | 1865 | window at the bottom of the desktop. Some window managers may not honor |
| 1857 | this parameter. | 1866 | this parameter. |
| 1858 | 1867 | ||
| 1859 | @vindex no-focus-on-map, a frame parameter | 1868 | @vindex no-focus-on-map, a frame parameter |
| 1860 | @item no-focus-on-map | 1869 | @item no-focus-on-map |
| 1861 | If non-@code{nil}, this means that the frame dos not want to receive | 1870 | If non-@code{nil}, this means that the frame does not want to receive |
| 1862 | input focus when it is mapped (@pxref{Visibility of Frames}). Some | 1871 | input focus when it is mapped (@pxref{Visibility of Frames}). Some |
| 1863 | window managers may not honor this parameter. | 1872 | window managers may not honor this parameter. |
| 1864 | 1873 | ||
| @@ -1875,8 +1884,8 @@ this parameter. | |||
| 1875 | @vindex undecorated, a frame parameter | 1884 | @vindex undecorated, a frame parameter |
| 1876 | @item undecorated | 1885 | @item undecorated |
| 1877 | If non-@code{nil}, this frame's window-system window is drawn without | 1886 | If non-@code{nil}, this frame's window-system window is drawn without |
| 1878 | decorations like title, minimize/maximize boxes and external borders. | 1887 | decorations, like the title, minimize/maximize boxes and external |
| 1879 | This usually means that the window cannot be dragged, resized, | 1888 | borders. This usually means that the window cannot be dragged, resized, |
| 1880 | iconified, maximized or deleted with the mouse. If nil, the frame's | 1889 | iconified, maximized or deleted with the mouse. If nil, the frame's |
| 1881 | window is usually drawn with all the elements listed above unless their | 1890 | window is usually drawn with all the elements listed above unless their |
| 1882 | display has been suspended via window manager settings. | 1891 | display has been suspended via window manager settings. |
| @@ -2266,8 +2275,8 @@ frame. | |||
| 2266 | It first deletes any child frame of @var{frame} (@pxref{Child Frames}) | 2275 | It first deletes any child frame of @var{frame} (@pxref{Child Frames}) |
| 2267 | and any frame whose @code{delete-before} frame parameter (@pxref{Frame | 2276 | and any frame whose @code{delete-before} frame parameter (@pxref{Frame |
| 2268 | Interaction Parameters}) specifies @var{frame}. All such deletions are | 2277 | Interaction Parameters}) specifies @var{frame}. All such deletions are |
| 2269 | performed recursively; so this step makes sure that there will not exist | 2278 | performed recursively; so this step makes sure that there no other |
| 2270 | any other frames with @var{frame} as their ancestor. Then, unless | 2279 | frames with @var{frame} as their ancestor will exist. Then, unless |
| 2271 | @var{frame} specifies a tooltip, this function runs the hook | 2280 | @var{frame} specifies a tooltip, this function runs the hook |
| 2272 | @code{delete-frame-functions} (each function getting one argument, | 2281 | @code{delete-frame-functions} (each function getting one argument, |
| 2273 | @var{frame}) before actually killing the frame. | 2282 | @var{frame}) before actually killing the frame. |
| @@ -2468,7 +2477,7 @@ non-@code{nil}, means to avoid making @var{frame}'s window-system window | |||
| 2468 | the ``active'' window which should insist a bit more on avoiding to | 2477 | the ``active'' window which should insist a bit more on avoiding to |
| 2469 | raise @var{frame} above other frames. | 2478 | raise @var{frame} above other frames. |
| 2470 | 2479 | ||
| 2471 | On Windows the @var{noactivate} argument has no effect. However, if | 2480 | On MS-Windows the @var{noactivate} argument has no effect. However, if |
| 2472 | @var{frame} is a child frame (@pxref{Child Frames}), this function | 2481 | @var{frame} is a child frame (@pxref{Child Frames}), this function |
| 2473 | usualy does focus @var{frame} without raising it above other child | 2482 | usualy does focus @var{frame} without raising it above other child |
| 2474 | frames. | 2483 | frames. |
| @@ -2593,7 +2602,7 @@ Note that this option does not distinguish ``sloppy'' focus (where the | |||
| 2593 | frame that previously had focus retains focus as long as the mouse | 2602 | frame that previously had focus retains focus as long as the mouse |
| 2594 | pointer does not move into another window manager window) from | 2603 | pointer does not move into another window manager window) from |
| 2595 | ``strict'' focus (where a frame immediately loses focus when it's left | 2604 | ``strict'' focus (where a frame immediately loses focus when it's left |
| 2596 | by the mouse pointer). It neither recognizes whether your window | 2605 | by the mouse pointer). Neither does it recognize whether your window |
| 2597 | manager supports delayed focusing or auto-raising where you can | 2606 | manager supports delayed focusing or auto-raising where you can |
| 2598 | explicitly specify the time until a new frame gets focus or is | 2607 | explicitly specify the time until a new frame gets focus or is |
| 2599 | auto-raised. | 2608 | auto-raised. |
| @@ -2656,7 +2665,7 @@ you can do that with @code{raise-frame} if you wish (@pxref{Raising and | |||
| 2656 | Lowering}). | 2665 | Lowering}). |
| 2657 | 2666 | ||
| 2658 | Making a frame visible usually makes all its child frames (and their | 2667 | Making a frame visible usually makes all its child frames (and their |
| 2659 | descendants) visible too (@pxref{Child Frames}). | 2668 | descendants) visible as well (@pxref{Child Frames}). |
| 2660 | @end deffn | 2669 | @end deffn |
| 2661 | 2670 | ||
| 2662 | @deffn Command make-frame-invisible &optional frame force | 2671 | @deffn Command make-frame-invisible &optional frame force |
| @@ -2691,6 +2700,7 @@ selected frame. | |||
| 2691 | @cindex restacking a frame | 2700 | @cindex restacking a frame |
| 2692 | @cindex frame stacking order | 2701 | @cindex frame stacking order |
| 2693 | @cindex frame Z-order | 2702 | @cindex frame Z-order |
| 2703 | @cindex Z-order | ||
| 2694 | Most window systems use a desktop metaphor. Part of this metaphor is | 2704 | Most window systems use a desktop metaphor. Part of this metaphor is |
| 2695 | the idea that system-level windows (representing, e.g., Emacs frames) | 2705 | the idea that system-level windows (representing, e.g., Emacs frames) |
| 2696 | are stacked in a notional third dimension perpendicular to the screen | 2706 | are stacked in a notional third dimension perpendicular to the screen |
| @@ -2865,8 +2875,8 @@ frame does not show a menu or tool bar, any other of the frame's borders | |||
| 2865 | (@pxref{Layout Parameters}) can be used instead of the external borders. | 2875 | (@pxref{Layout Parameters}) can be used instead of the external borders. |
| 2866 | 2876 | ||
| 2867 | In particular, under X (but not when building with GTK+), the frame's | 2877 | In particular, under X (but not when building with GTK+), the frame's |
| 2868 | outer border can be used. On Windows, specifying a non-zero outer | 2878 | outer border can be used. On MS-Windows, specifying a non-zero outer |
| 2869 | border width will show a one pixel wide external border. Under all | 2879 | border width will show a one-pixel wide external border. Under all |
| 2870 | window-systems, the internal border can be used. In either case, it's | 2880 | window-systems, the internal border can be used. In either case, it's |
| 2871 | advisable to disable a child frame's window manager decorations with the | 2881 | advisable to disable a child frame's window manager decorations with the |
| 2872 | @code{undecorated} frame parameter @pxref{Management Parameters}). | 2882 | @code{undecorated} frame parameter @pxref{Management Parameters}). |
| @@ -2902,9 +2912,9 @@ policy to child frames. Customizing @code{mouse-autoselect-window} can | |||
| 2902 | help in this regard (@pxref{Mouse Window Auto-selection}). | 2912 | help in this regard (@pxref{Mouse Window Auto-selection}). |
| 2903 | 2913 | ||
| 2904 | @item | 2914 | @item |
| 2905 | Dropping (@pxref{Drag and Drop}) on child frames is not guaranteed too | 2915 | Dropping (@pxref{Drag and Drop}) on child frames is not guaranteed to |
| 2906 | work on all window-systems. Some will drop the object on the parent | 2916 | work on all window-systems. Some will drop the object on the parent |
| 2907 | frame or some ancestor instead. | 2917 | frame or on some ancestor instead. |
| 2908 | @end itemize | 2918 | @end itemize |
| 2909 | 2919 | ||
| 2910 | The following two functions may be useful when working with child and | 2920 | The following two functions may be useful when working with child and |
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi index 931d1060d5d..fed2dea7572 100644 --- a/doc/lispref/windows.texi +++ b/doc/lispref/windows.texi | |||
| @@ -1752,9 +1752,9 @@ whenever a window gets selected more ``permanently''. | |||
| 1752 | not related to window management, it will usually make sense to save the | 1752 | not related to window management, it will usually make sense to save the |
| 1753 | value of the selected window somewhere and compare it with the value of | 1753 | value of the selected window somewhere and compare it with the value of |
| 1754 | @code{selected-window} while running that hook. Also, to avoid false | 1754 | @code{selected-window} while running that hook. Also, to avoid false |
| 1755 | positives when using @code{buffer-list-update-hook} it is good practice | 1755 | positives when using @code{buffer-list-update-hook}, it is good practice |
| 1756 | that every @code{select-window} call supposed to select a window only | 1756 | that every @code{select-window} call supposed to select a window only |
| 1757 | temporarily, passes a non-@code{nil} @var{norecord} argument. If | 1757 | temporarily passes a non-@code{nil} @var{norecord} argument. If |
| 1758 | possible, the macro @code{with-selected-window} (see below) should be | 1758 | possible, the macro @code{with-selected-window} (see below) should be |
| 1759 | used in such cases. | 1759 | used in such cases. |
| 1760 | 1760 | ||
| @@ -4623,7 +4623,7 @@ Any other non-@code{nil} value means to select a window instantaneously | |||
| 4623 | as soon as the mouse pointer enters it. | 4623 | as soon as the mouse pointer enters it. |
| 4624 | @end table | 4624 | @end table |
| 4625 | 4625 | ||
| 4626 | In either case the mouse pointer must enter the text area of a window in | 4626 | In either case, the mouse pointer must enter the text area of a window in |
| 4627 | order to trigger its selection. Dragging the scroll bar slider or the | 4627 | order to trigger its selection. Dragging the scroll bar slider or the |
| 4628 | mode line of a window conceptually should not cause its auto-selection. | 4628 | mode line of a window conceptually should not cause its auto-selection. |
| 4629 | 4629 | ||