diff options
| author | Martin Rudalics | 2011-11-16 11:10:40 +0100 |
|---|---|---|
| committer | Martin Rudalics | 2011-11-16 11:10:40 +0100 |
| commit | b6f6789018b0bd41368126cfb45307334d6ff4d6 (patch) | |
| tree | eb2f35085b12fa731c3dcfdb82ac97abafc913a7 /doc | |
| parent | ce7ddba00114b8876179e87c222fd8697da19ac0 (diff) | |
| download | emacs-b6f6789018b0bd41368126cfb45307334d6ff4d6.tar.gz emacs-b6f6789018b0bd41368126cfb45307334d6ff4d6.zip | |
Rename window-nest to window-combination-limit.
* window.h (window): Rename slot "nest" to "combination_limit".
* window.c (Fwindow_nest): Rename to Fwindow_combination_limit.
(Fset_window_nest): Rename to Fset_window_combination_limit.
(Vwindow_nest): Rename to Vwindow_combination_limit.
(recombine_windows, make_parent_window, make_window)
(Fsplit_window_internal, saved_window)
(Fset_window_configuration, save_window_save): Rename all
occurrences of window_nest to window_combination_limit.
* window.el (split-window, window-state-get-1)
(window-state-put-1, window-state-put-2): Rename occurrences of
window-nest to window-combination-limit.
* cus-start.el (window-nest): Rename to
window-combination-limit.
* windows.texi (Resizing Windows, Splitting Windows): Rename
occurrences of window-nest to window-combination-limit.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lispref/ChangeLog | 5 | ||||
| -rw-r--r-- | doc/lispref/windows.texi | 89 |
2 files changed, 52 insertions, 42 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index 1e7f0529bd5..3ca675a2144 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -1,3 +1,8 @@ | |||
| 1 | 2011-11-16 Martin Rudalics <rudalics@gmx.at> | ||
| 2 | |||
| 3 | * windows.texi (Resizing Windows, Splitting Windows): Rename | ||
| 4 | occurrences of window-nest to window-combination-limit. | ||
| 5 | |||
| 1 | 2011-11-14 Juanma Barranquero <lekktu@gmail.com> | 6 | 2011-11-14 Juanma Barranquero <lekktu@gmail.com> |
| 2 | 7 | ||
| 3 | * intro.texi (Lisp History): Fix typo. | 8 | * intro.texi (Lisp History): Fix typo. |
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi index b6bacc27684..6c5247bd144 100644 --- a/doc/lispref/windows.texi +++ b/doc/lispref/windows.texi | |||
| @@ -632,11 +632,12 @@ the window cannot be resized as demanded, an error is signaled. | |||
| 632 | The optional argument @var{ignore} has the same meaning as for the | 632 | The optional argument @var{ignore} has the same meaning as for the |
| 633 | function @code{window-resizable} above. | 633 | function @code{window-resizable} above. |
| 634 | 634 | ||
| 635 | The choice of which window edge this function alters depends on the | 635 | The choice of which window edges this function alters depends on the |
| 636 | splitting and nesting status of the involved windows; in some cases, | 636 | values of the option @code{window-splits} and the combination-limit |
| 637 | it may alter both edges. @xref{Splitting Windows}. To resize by | 637 | status of the involved windows; in some cases, it may alter both edges. |
| 638 | moving only the bottom or right edge of a window, use the function | 638 | @xref{Splitting Windows}. To resize by moving only the bottom or right |
| 639 | @code{adjust-window-trailing-edge}, below. | 639 | edge of a window, use the function @code{adjust-window-trailing-edge}, |
| 640 | below. | ||
| 640 | @end defun | 641 | @end defun |
| 641 | 642 | ||
| 642 | @c The commands enlarge-window, enlarge-window-horizontally, | 643 | @c The commands enlarge-window, enlarge-window-horizontally, |
| @@ -859,8 +860,8 @@ Also if this variable is non-@code{nil}, subsequent resizing and | |||
| 859 | deleting @var{window} will usually affect @emph{all} windows in | 860 | deleting @var{window} will usually affect @emph{all} windows in |
| 860 | @var{window}'s combination. | 861 | @var{window}'s combination. |
| 861 | 862 | ||
| 862 | The setting of this variable has no effect if @code{window-nest} (see | 863 | The setting of this variable has no effect if |
| 863 | below) is non-@code{nil}. | 864 | @code{window-combination-limit} (see below) is non-@code{nil}. |
| 864 | @end defopt | 865 | @end defopt |
| 865 | 866 | ||
| 866 | To illustrate the use of @code{window-splits} consider the following | 867 | To illustrate the use of @code{window-splits} consider the following |
| @@ -931,34 +932,36 @@ height: | |||
| 931 | @end group | 932 | @end group |
| 932 | @end smallexample | 933 | @end smallexample |
| 933 | 934 | ||
| 934 | @defopt window-nest | 935 | @defopt window-combination-limit |
| 935 | If this variable is @code{nil}, @code{split-window} creates a new parent | 936 | If this variable is @code{nil}, @code{split-window} creates a new parent |
| 936 | window if and only if the old window has no parent window or shall be | 937 | window if and only if the old window has no parent window or shall be |
| 937 | split orthogonally to the combination it is part of. If this variable | 938 | split orthogonally to the combination it is part of. If this variable |
| 938 | is non-@code{nil}, @code{split-window} always creates a new parent | 939 | is @code{t}, @code{split-window} always creates a new parent window. If |
| 939 | window. If this variable is always non-@code{nil}, a frame's window | 940 | this variable is always @code{t}, a frame's window tree is a binary tree |
| 940 | tree is a binary tree so every window but the frame's root window has | 941 | so every window but the frame's root window has exactly one sibling. |
| 941 | exactly one sibling. | 942 | Other values are reserved for future use. |
| 942 | 943 | ||
| 943 | The value of this variable is also assigned to the nest status of the | 944 | The value of this variable is also assigned to the combination-limit |
| 944 | new parent window. The nest status of any window can be retrieved via | 945 | status of the new parent window. The combination-limit status of any |
| 945 | the function @code{window-nest} and altered by the function | 946 | window can be retrieved via the function @code{window-combination-limit} |
| 946 | @code{set-window-nest}, see below. | 947 | and altered by the function @code{set-window-combination-limit}, see |
| 948 | below. | ||
| 947 | @end defopt | 949 | @end defopt |
| 948 | 950 | ||
| 949 | @defun window-nest &optional window | 951 | @defun window-combination-limit &optional window |
| 950 | This function returns the nest status of @var{window}. The argument | 952 | This function returns the combination-limit status of @var{window}. The |
| 951 | @var{window} can be any window and defaults to the selected one. Note, | 953 | argument @var{window} can be any window and defaults to the selected |
| 952 | however, that the nest status is currently meaningful for internal | 954 | one. Note, however, that the combination-limit status is currently |
| 953 | windows only. | 955 | meaningful for internal windows only. |
| 954 | 956 | ||
| 955 | @cindex nest status | 957 | @cindex combination-limit status |
| 956 | The @dfn{nest status} of a window specifies whether that window may be | 958 | The @dfn{combination-limit status} of a window specifies whether that |
| 957 | removed and its child windows recombined with that window's siblings | 959 | window may be removed and its child windows recombined with that |
| 958 | when such a sibling's child window is deleted. The nest status is | 960 | window's siblings when such a sibling's child window is deleted. The |
| 959 | initially assigned by @code{split-window} from the current value of the | 961 | combination-limit status is initially assigned by @code{split-window} |
| 960 | variable @code{window-nest} (see above) and can be reset by the function | 962 | from the current value of the variable @code{window-combination-limit} |
| 961 | @code{set-window-nest} (see below). | 963 | (see above) and can be reset by the function |
| 964 | @code{set-window-combination-limit} (see below). | ||
| 962 | 965 | ||
| 963 | If the return value is @code{nil}, child windows of @var{window} may be | 966 | If the return value is @code{nil}, child windows of @var{window} may be |
| 964 | recombined with @var{window}'s siblings when a window gets deleted. A | 967 | recombined with @var{window}'s siblings when a window gets deleted. A |
| @@ -966,16 +969,17 @@ return value of @code{nil} means that child windows of @var{window} are | |||
| 966 | never (re-)combined with @var{window}'s siblings in such a case. | 969 | never (re-)combined with @var{window}'s siblings in such a case. |
| 967 | @end defun | 970 | @end defun |
| 968 | 971 | ||
| 969 | @defun set-window-nest window &optional status | 972 | @defun set-window-combination-limit window &optional status |
| 970 | This functions sets the nest status (see above) of @var{window} to | 973 | This functions sets the combination-limit status (see above) of |
| 971 | @var{status}. The argument @var{window} can be any window and defaults | 974 | @var{window} to @var{status}. The argument @var{window} can be any |
| 972 | to the selected one. Note that setting the nest status is meaningful | 975 | window and defaults to the selected one. Note that setting the |
| 973 | for internal windows only. The return value is @var{status}. | 976 | combination-limit status is meaningful for internal windows only. The |
| 977 | return value is @var{status}. | ||
| 974 | @end defun | 978 | @end defun |
| 975 | 979 | ||
| 976 | To illustrate the use of @code{window-nest} consider the following | 980 | To illustrate the use of @code{window-combination-limit} consider the |
| 977 | configuration (throughout the following examples we shall assume that | 981 | following configuration (throughout the following examples we shall |
| 978 | @code{window-splits} invariantly is @code{nil}). | 982 | assume that @code{window-splits} invariantly is @code{nil}). |
| 979 | @smallexample | 983 | @smallexample |
| 980 | @group | 984 | @group |
| 981 | ______________________________________ | 985 | ______________________________________ |
| @@ -997,7 +1001,8 @@ configuration (throughout the following examples we shall assume that | |||
| 997 | @end smallexample | 1001 | @end smallexample |
| 998 | 1002 | ||
| 999 | Splitting @code{W2} into two windows above each other with | 1003 | Splitting @code{W2} into two windows above each other with |
| 1000 | @code{window-nest} equal @code{nil} will get you a configuration like: | 1004 | @code{window-combination-limit} equal @code{nil} will get you a |
| 1005 | configuration like: | ||
| 1001 | @smallexample | 1006 | @smallexample |
| 1002 | @group | 1007 | @group |
| 1003 | ______________________________________ | 1008 | ______________________________________ |
| @@ -1064,9 +1069,9 @@ follows: | |||
| 1064 | 1069 | ||
| 1065 | Hence, with respect to the initial configuration, window @code{W2} has | 1070 | Hence, with respect to the initial configuration, window @code{W2} has |
| 1066 | grown at the expense of window @code{W3}. If, however, in the initial | 1071 | grown at the expense of window @code{W3}. If, however, in the initial |
| 1067 | configuration you had split @code{W2} with @code{window-nest} bound to | 1072 | configuration you had split @code{W2} with |
| 1068 | @code{t}, a new internal window @code{W5} would have been created as | 1073 | @code{window-combination-limit} bound to @code{t}, a new internal window |
| 1069 | depicted below. | 1074 | @code{W5} would have been created as depicted below. |
| 1070 | @smallexample | 1075 | @smallexample |
| 1071 | @group | 1076 | @group |
| 1072 | ______________________________________ | 1077 | ______________________________________ |