diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lispref/display.texi | 40 |
1 files changed, 28 insertions, 12 deletions
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index 4b10788862e..3c91092906c 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi | |||
| @@ -3959,7 +3959,7 @@ showing the buffer, unless you call @code{set-window-buffer} again in | |||
| 3959 | each affected window. You can also use @code{set-window-fringes} to | 3959 | each affected window. You can also use @code{set-window-fringes} to |
| 3960 | control the fringe display in individual windows. | 3960 | control the fringe display in individual windows. |
| 3961 | 3961 | ||
| 3962 | @defun set-window-fringes window left &optional right outside-margins | 3962 | @defun set-window-fringes window left &optional right outside-margins persistent |
| 3963 | This function sets the fringe widths of window @var{window}. | 3963 | This function sets the fringe widths of window @var{window}. |
| 3964 | If @var{window} is @code{nil}, the selected window is used. | 3964 | If @var{window} is @code{nil}, the selected window is used. |
| 3965 | 3965 | ||
| @@ -3974,14 +3974,18 @@ desired width, this leaves the fringes of @var{window} unchanged. | |||
| 3974 | 3974 | ||
| 3975 | The values specified here may be later overridden by invoking | 3975 | The values specified here may be later overridden by invoking |
| 3976 | @code{set-window-buffer} (@pxref{Buffers and Windows}) on @var{window} | 3976 | @code{set-window-buffer} (@pxref{Buffers and Windows}) on @var{window} |
| 3977 | with its @var{keep-margins} argument @code{nil} or omitted. | 3977 | with its @var{keep-margins} argument @code{nil} or omitted. However, |
| 3978 | if the optional fifth argument @var{persistent} is non-@code{nil} and | ||
| 3979 | the other arguments are processed successfully, the values specified | ||
| 3980 | here unconditionally survive subsequent invocations of | ||
| 3981 | @code{set-window-buffer}. | ||
| 3978 | @end defun | 3982 | @end defun |
| 3979 | 3983 | ||
| 3980 | @defun window-fringes &optional window | 3984 | @defun window-fringes &optional window |
| 3981 | This function returns information about the fringes of a window | 3985 | This function returns information about the fringes of a window |
| 3982 | @var{window}. If @var{window} is omitted or @code{nil}, the selected | 3986 | @var{window}. If @var{window} is omitted or @code{nil}, the selected |
| 3983 | window is used. The value has the form @code{(@var{left-width} | 3987 | window is used. The value has the form @code{(@var{left-width} |
| 3984 | @var{right-width} @var{outside-margins})}. | 3988 | @var{right-width} @var{outside-margins} @var{persistent})}. |
| 3985 | @end defun | 3989 | @end defun |
| 3986 | 3990 | ||
| 3987 | 3991 | ||
| @@ -4375,7 +4379,7 @@ This function returns the height of horizontal scroll bars of | |||
| 4375 | You can override the frame specific settings for individual windows by | 4379 | You can override the frame specific settings for individual windows by |
| 4376 | using the following function: | 4380 | using the following function: |
| 4377 | 4381 | ||
| 4378 | @defun set-window-scroll-bars window &optional width vertical-type height horizontal-type | 4382 | @defun set-window-scroll-bars window &optional width vertical-type height horizontal-type persistent |
| 4379 | This function sets the width and/or height and the types of scroll bars | 4383 | This function sets the width and/or height and the types of scroll bars |
| 4380 | for window @var{window}. If @var{window} is @code{nil}, the selected | 4384 | for window @var{window}. If @var{window} is @code{nil}, the selected |
| 4381 | window is used. | 4385 | window is used. |
| @@ -4387,18 +4391,26 @@ if so, where. The possible values are @code{left}, @code{right}, | |||
| 4387 | @code{t}, which means to use the frame's default, and @code{nil} for no | 4391 | @code{t}, which means to use the frame's default, and @code{nil} for no |
| 4388 | vertical scroll bar. | 4392 | vertical scroll bar. |
| 4389 | 4393 | ||
| 4390 | @var{height} specifies the height of the horizontal scroll bar in pixels | 4394 | @var{height} specifies the height of the horizontal scroll bar in |
| 4391 | (@code{nil} means use the height specified for the frame). | 4395 | pixels (@code{nil} means use the height specified for the frame). |
| 4392 | @var{horizontal-type} specifies whether to have a horizontal scroll bar. | 4396 | @var{horizontal-type} specifies whether to have a horizontal scroll |
| 4393 | The possible values are @code{bottom}, @code{t}, which means to use the | 4397 | bar. The possible values are @code{bottom}, @code{t}, which means to |
| 4394 | frame's default, and @code{nil} for no horizontal scroll bar. | 4398 | use the frame's default, and @code{nil} for no horizontal scroll bar. |
| 4399 | Note that for a mini window the value @code{t} has the same meaning as | ||
| 4400 | @code{nil}, namely to not show a horizontal scroll bar. You have to | ||
| 4401 | explicitly specify @code{bottom} in order to show a horizontal scroll | ||
| 4402 | bar in a mini window. | ||
| 4395 | 4403 | ||
| 4396 | If @var{window} is not large enough to accommodate a scroll bar of the | 4404 | If @var{window} is not large enough to accommodate a scroll bar of the |
| 4397 | desired dimension, this leaves the corresponding scroll bar unchanged. | 4405 | desired dimension, this leaves the corresponding scroll bar unchanged. |
| 4398 | 4406 | ||
| 4399 | The values specified here may be later overridden by invoking | 4407 | The values specified here may be later overridden by invoking |
| 4400 | @code{set-window-buffer} (@pxref{Buffers and Windows}) on @var{window} | 4408 | @code{set-window-buffer} (@pxref{Buffers and Windows}) on @var{window} |
| 4401 | with its @var{keep-margins} argument @code{nil} or omitted. | 4409 | with its @var{keep-margins} argument @code{nil} or omitted. However, |
| 4410 | if the optional fifth argument @var{persistent} is non-@code{nil} and | ||
| 4411 | the other arguments are processed successfully, the values specified | ||
| 4412 | here unconditionally survive subsequent invocations of | ||
| 4413 | @code{set-window-buffer}. | ||
| 4402 | @end defun | 4414 | @end defun |
| 4403 | 4415 | ||
| 4404 | The following four functions take as argument a live window which | 4416 | The following four functions take as argument a live window which |
| @@ -4407,7 +4419,7 @@ defaults to the selected one. | |||
| 4407 | @defun window-scroll-bars &optional window | 4419 | @defun window-scroll-bars &optional window |
| 4408 | This function returns a list of the form @code{(@var{width} | 4420 | This function returns a list of the form @code{(@var{width} |
| 4409 | @var{columns} @var{vertical-type} @var{height} @var{lines} | 4421 | @var{columns} @var{vertical-type} @var{height} @var{lines} |
| 4410 | @var{horizontal-type})}. | 4422 | @var{horizontal-type} @var{persistent})}. |
| 4411 | 4423 | ||
| 4412 | The value @var{width} is the value that was specified for the width of | 4424 | The value @var{width} is the value that was specified for the width of |
| 4413 | the vertical scroll bar (which may be @code{nil}); @var{columns} is the | 4425 | the vertical scroll bar (which may be @code{nil}); @var{columns} is the |
| @@ -4418,6 +4430,10 @@ The value @var{height} is the value that was specified for the height of | |||
| 4418 | the horizontal scroll bar (which may be @code{nil}); @var{lines} is the | 4430 | the horizontal scroll bar (which may be @code{nil}); @var{lines} is the |
| 4419 | (possibly rounded) number of lines that the horizontally scroll bar | 4431 | (possibly rounded) number of lines that the horizontally scroll bar |
| 4420 | actually occupies. | 4432 | actually occupies. |
| 4433 | |||
| 4434 | The value of @var{persistent} is the value specified for @var{window} | ||
| 4435 | with the last successful invocation of @code{set-window-scroll-bars}, | ||
| 4436 | @code{nil} if there never was one. | ||
| 4421 | @end defun | 4437 | @end defun |
| 4422 | 4438 | ||
| 4423 | @defun window-current-scroll-bars &optional window | 4439 | @defun window-current-scroll-bars &optional window |
| @@ -4438,7 +4454,7 @@ This function returns the height in pixels of @var{window}'s horizontal | |||
| 4438 | scrollbar. | 4454 | scrollbar. |
| 4439 | @end defun | 4455 | @end defun |
| 4440 | 4456 | ||
| 4441 | If you don't specify these values for a window with | 4457 | If you do not specify a window's scroll bar settings via |
| 4442 | @code{set-window-scroll-bars}, the buffer-local variables | 4458 | @code{set-window-scroll-bars}, the buffer-local variables |
| 4443 | @code{vertical-scroll-bar}, @code{horizontal-scroll-bar}, | 4459 | @code{vertical-scroll-bar}, @code{horizontal-scroll-bar}, |
| 4444 | @code{scroll-bar-width} and @code{scroll-bar-height} in the buffer being | 4460 | @code{scroll-bar-width} and @code{scroll-bar-height} in the buffer being |