aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlan Mackenzie2015-12-15 11:41:54 +0000
committerAlan Mackenzie2015-12-15 11:41:54 +0000
commit64ad54734dc720b4e14fe75475cc767f2e421e06 (patch)
tree60908c2fb5e0654b99bf406d03577ffc5a7be55a
parent16dac3f9af08ba5591f7dd06efe99a3f6b2d3965 (diff)
downloademacs-64ad54734dc720b4e14fe75475cc767f2e421e06.tar.gz
emacs-64ad54734dc720b4e14fe75475cc767f2e421e06.zip
Tidy up documentation associated with window groups.
* doc/lispref/windows.texi (Basic Windows): Add an @anchor for "Window Groups". Correct example function to `window-group-start'. (Window Start and End, Textual scrolling): Point to the new anchor. State that (most of) the args in window group functions have the same meaning as for the corresponding window primitives. * doc/lispref/positions.texi (Screen Lines). Same as above.
-rw-r--r--doc/lispref/positions.texi9
-rw-r--r--doc/lispref/windows.texi44
2 files changed, 27 insertions, 26 deletions
diff --git a/doc/lispref/positions.texi b/doc/lispref/positions.texi
index 090eb4598a8..9daf5cef059 100644
--- a/doc/lispref/positions.texi
+++ b/doc/lispref/positions.texi
@@ -575,14 +575,13 @@ the top line in the window numbered 0.
575@vindex move-to-window-group-line-function 575@vindex move-to-window-group-line-function
576@defun move-to-window-group-line count 576@defun move-to-window-group-line count
577This function is like @code{move-to-window-line}, except that when the 577This function is like @code{move-to-window-line}, except that when the
578selected window is a part of a group of windows (@pxref{Basic 578selected window is a part of a group of windows (@pxref{Window
579Windows}), @code{move-to-window-group-line} will move to a position 579Group}), @code{move-to-window-group-line} will move to a position with
580with respect to the entire group, not just the single window. This 580respect to the entire group, not just the single window. This
581condition holds when the buffer local variable 581condition holds when the buffer local variable
582@code{move-to-window-group-line-function} is set to a function. In 582@code{move-to-window-group-line-function} is set to a function. In
583this case, @code{move-to-window-group-line} calls the function with 583this case, @code{move-to-window-group-line} calls the function with
584the argument @var{count}, then returns its result. The argument has 584the argument @var{count}, then returns its result.
585the same meaning as in @code{move-to-window-line}.
586@end defun 585@end defun
587 586
588@defun compute-motion from frompos to topos width offsets window 587@defun compute-motion from frompos to topos width offsets window
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi
index 45899588c32..0c0c1bce3b9 100644
--- a/doc/lispref/windows.texi
+++ b/doc/lispref/windows.texi
@@ -133,14 +133,14 @@ This function returns the selected window (which is always a live
133window). 133window).
134@end defun 134@end defun
135 135
136 Sometimes several windows collectively and cooperatively display a 136@anchor{Window Group}Sometimes several windows collectively and
137buffer, for example, under the management of Follow Mode, where the 137cooperatively display a buffer, for example, under the management of
138windows together display a bigger portion of the buffer than one 138Follow Mode (@pxref{Follow Mode,,, emacs}), where the windows together
139window could alone. It is often useful to consider such a @dfn{group 139display a bigger portion of the buffer than one window could alone.
140of windows} as a single entity. Several functions such as 140It is often useful to consider such a @dfn{window group} as a single
141@code{window-start} (@pxref{Window Start and End}) allow you to do 141entity. Several functions such as @code{window-group-start}
142this by supplying, as an argument, one of the windows as a stand in 142(@pxref{Window Start and End}) allow you to do this by supplying, as
143for the whole group. 143an argument, one of the windows as a stand in for the whole group.
144 144
145@defun selected-window-group 145@defun selected-window-group
146@vindex selected-window-group-function 146@vindex selected-window-group-function
@@ -3125,13 +3125,12 @@ position to change in response until after the next redisplay.
3125@defun window-group-start &optional window 3125@defun window-group-start &optional window
3126@vindex window-group-start-function 3126@vindex window-group-start-function
3127This function is like @code{window-start}, except that when 3127This function is like @code{window-start}, except that when
3128@var{window} is a part of a group of windows (@pxref{Basic Windows}), 3128@var{window} is a part of a group of windows (@pxref{Window Group}),
3129@code{window-group-start} returns the start position of the entire 3129@code{window-group-start} returns the start position of the entire
3130group. This condition holds when the buffer local variable 3130group. This condition holds when the buffer local variable
3131@code{window-group-start-function} is set to a function. In this 3131@code{window-group-start-function} is set to a function. In this
3132case, @code{window-group-start} calls the function with the single 3132case, @code{window-group-start} calls the function with the single
3133argument @var{window}, then returns its result. The argument to this 3133argument @var{window}, then returns its result.
3134function has the same meaning as in @code{window-start}.
3135@end defun 3134@end defun
3136 3135
3137@cindex window end position 3136@cindex window end position
@@ -3163,13 +3162,13 @@ text will end if scrolling is not required.
3163@vindex window-group-end-function 3162@vindex window-group-end-function
3164@defun window-group-end window update 3163@defun window-group-end window update
3165This function is like @code{window-end}, except that when @var{window} 3164This function is like @code{window-end}, except that when @var{window}
3166is a part of a group of windows (@pxref{Basic Windows}), 3165is a part of a group of windows (@pxref{Window Group}),
3167@code{window-group-end} returns the end position of the entire group. 3166@code{window-group-end} returns the end position of the entire group.
3168This condition holds when the buffer local variable 3167This condition holds when the buffer local variable
3169@code{window-group-end-function} is set to a function. In this case, 3168@code{window-group-end-function} is set to a function. In this case,
3170@code{window-group-end} calls the function with the two arguments 3169@code{window-group-end} calls the function with the two arguments
3171@var{window} and @var{update}, then returns its result. The arguments 3170@var{window} and @var{update}, then returns its result. The argument
3172to this function have the same meaning as in @code{window-end}. 3171@var{update} has the same meaning as in @code{window-end}.
3173@end defun 3172@end defun
3174 3173
3175@defun set-window-start window position &optional noforce 3174@defun set-window-start window position &optional noforce
@@ -3238,14 +3237,14 @@ position that works well with point, and thus @var{position} is not used.
3238@vindex set-window-group-start-function 3237@vindex set-window-group-start-function
3239@defun set-window-group-start window position &optional noforce 3238@defun set-window-group-start window position &optional noforce
3240This function is like @code{set-window-start}, except that when 3239This function is like @code{set-window-start}, except that when
3241@var{window} is a part of a group of windows (@pxref{Basic Windows}), 3240@var{window} is a part of a group of windows (@pxref{Window Group}),
3242@code{set-window-group-start} sets the start position of the entire 3241@code{set-window-group-start} sets the start position of the entire
3243group. This condition holds when the buffer local variable 3242group. This condition holds when the buffer local variable
3244@code{set-window-group-start-function} is set to a function. In this 3243@code{set-window-group-start-function} is set to a function. In this
3245case, @code{set-window-group-start} calls the function with the three 3244case, @code{set-window-group-start} calls the function with the three
3246arguments @var{window}, @var{position}, and @var{noforce}, then 3245arguments @var{window}, @var{position}, and @var{noforce}, then
3247returns its result. The arguments in this function have the same 3246returns its result. The arguments @var{position} and @var{noforce} in
3248meaning as in @code{set-window-start}. 3247this function have the same meaning as in @code{set-window-start}.
3249@end defun 3248@end defun
3250 3249
3251@defun pos-visible-in-window-p &optional position window partially 3250@defun pos-visible-in-window-p &optional position window partially
@@ -3292,14 +3291,16 @@ Here is an example:
3292@vindex pos-visible-in-window-group-p-function 3291@vindex pos-visible-in-window-group-p-function
3293@defun pos-visible-in-window-group-p &optional position window partially 3292@defun pos-visible-in-window-group-p &optional position window partially
3294This function is like @code{pos-visible-in-window-p}, except that when 3293This function is like @code{pos-visible-in-window-p}, except that when
3295@var{window} is a part of a group of windows (@pxref{Basic Windows}), 3294@var{window} is a part of a group of windows (@pxref{Window Group}),
3296@code{pos-visible-in-window-group-p} tests the visibility of @var{pos} 3295@code{pos-visible-in-window-group-p} tests the visibility of @var{pos}
3297in the entire group, not just in the single @var{window}. This 3296in the entire group, not just in the single @var{window}. This
3298condition holds when the buffer local variable 3297condition holds when the buffer local variable
3299@code{pos-visible-in-window-group-p-function} is set to a function. 3298@code{pos-visible-in-window-group-p-function} is set to a function.
3300In this case @code{pos-visible-in-window-group-p} calls the function 3299In this case @code{pos-visible-in-window-group-p} calls the function
3301with the three arguments @var{position}, @var{window}, and 3300with the three arguments @var{position}, @var{window}, and
3302@var{partially}, then returns its result. 3301@var{partially}, then returns its result. The arguments
3302@var{position} and @var{partially} have the same meaning as in
3303@code{pos-visible-in-window-p}.
3303@end defun 3304@end defun
3304 3305
3305@defun window-line-height &optional line window 3306@defun window-line-height &optional line window
@@ -3548,12 +3549,13 @@ a more convenient way to achieve this.
3548@vindex recenter-group-function 3549@vindex recenter-group-function
3549@defun recenter-group &optional count 3550@defun recenter-group &optional count
3550This function is like @code{recenter}, except that when the selected 3551This function is like @code{recenter}, except that when the selected
3551window is part of a group of windows (@pxref{Basic Windows}), 3552window is part of a group of windows (@pxref{Window Group}),
3552@code{recenter-group} scrolls the entire group. This condition holds 3553@code{recenter-group} scrolls the entire group. This condition holds
3553when the buffer local variable @code{recenter-group-function} is set 3554when the buffer local variable @code{recenter-group-function} is set
3554to a function. In this case, @code{recenter-group} calls the function 3555to a function. In this case, @code{recenter-group} calls the function
3555with the argument @var{count}, then returns its result. The argument 3556with the argument @var{count}, then returns its result. The argument
3556has the same meaning as in @code{recenter}. 3557@var{count} has the same meaning as in @code{recenter}, but with
3558respect to the entire window group.
3557@end defun 3559@end defun
3558 3560
3559@defopt recenter-redisplay 3561@defopt recenter-redisplay