comparison man/lispref/gutter.texi @ 444:576fb035e263 r21-2-37

Import from CVS: tag r21-2-37
author cvs
date Mon, 13 Aug 2007 11:36:19 +0200
parents abe6d1db359e
children 2ba4f06a264d
comparison
equal deleted inserted replaced
443:a8296e22da4e 444:576fb035e263
113 gutter. The values of the variables @code{default-gutter-visible-p}, 113 gutter. The values of the variables @code{default-gutter-visible-p},
114 @code{top-gutter-visible-p}, @code{left-gutter-visible-p}, 114 @code{top-gutter-visible-p}, @code{left-gutter-visible-p},
115 @code{right-gutter-visible-p}, and @code{bottom-gutter-visible-p} are 115 @code{right-gutter-visible-p}, and @code{bottom-gutter-visible-p} are
116 always gutter-visible specifiers. 116 always gutter-visible specifiers.
117 117
118 Valid gutter-visible instantiators are t, nil or a list of symbols. If 118 Valid gutter-visible instantiators are @code{t}, @code{nil} or a list of
119 a gutter-visible instantiator is set to a list of symbols, and the 119 symbols. If a gutter-visible instantiator is set to a list of symbols,
120 corresponding gutter specification is a property-list strings, then 120 and the corresponding gutter specification is a property-list strings,
121 elements of the gutter specification will only be visible if the 121 then elements of the gutter specification will only be visible if the
122 corresponding symbol occurs in the gutter-visible instantiator. 122 corresponding symbol occurs in the gutter-visible instantiator.
123 @end defun 123 @end defun
124 124
125 @node Gutter Descriptor Format, Specifying a Gutter, Creating Gutter, Gutter 125 @node Gutter Descriptor Format, Specifying a Gutter, Creating Gutter, Gutter
126 @section Gutter Descriptor Format 126 @section Gutter Descriptor Format
250 Most of the time, you will set @code{default-gutter}, which allows 250 Most of the time, you will set @code{default-gutter}, which allows
251 the user to choose where the gutter should go. 251 the user to choose where the gutter should go.
252 252
253 @defvr Specifier default-gutter 253 @defvr Specifier default-gutter
254 The position of this gutter is specified in the function 254 The position of this gutter is specified in the function
255 @code{default-gutter-position}. If the corresponding 255 @code{default-gutter-position}. If the corresponding
256 position-specific gutter (e.g. @code{top-gutter} if 256 position-specific gutter (e.g. @code{top-gutter} if
257 @code{default-gutter-position} is @code{top}) does not specify a 257 @code{default-gutter-position} is @code{top}) does not specify a
258 gutter in a particular domain, then the value of @code{default-gutter} 258 gutter in a particular domain, then the value of @code{default-gutter}
259 in that domain, of any, will be used instead. 259 in that domain, of any, will be used instead.
260 @end defvr 260 @end defvr
310 @defvr Specifier right-gutter 310 @defvr Specifier right-gutter
311 Specifier for the gutter at the right edge of the frame. 311 Specifier for the gutter at the right edge of the frame.
312 @end defvr 312 @end defvr
313 313
314 @defun gutter-specifier-p object 314 @defun gutter-specifier-p object
315 This function returns non-nil if @var{object} is a gutter specifier. 315 This function returns non-@code{nil} if @var{object} is a gutter specifier.
316 Gutter specifiers are the actual objects contained in the gutter 316 Gutter specifiers are the actual objects contained in the gutter
317 variables described above, and their valid instantiators are 317 variables described above, and their valid instantiators are
318 gutter descriptors (@pxref{Gutter Descriptor Format}). 318 gutter descriptors (@pxref{Gutter Descriptor Format}).
319 @end defun 319 @end defun
320 320
406 406
407 Thus, for example, if you set the frame width to 80 characters and the 407 Thus, for example, if you set the frame width to 80 characters and the
408 left gutter width for that frame to 68 pixels, then the frame will be 408 left gutter width for that frame to 68 pixels, then the frame will be
409 sized to fit 80 characters plus a 68-pixel left gutter. If you then 409 sized to fit 80 characters plus a 68-pixel left gutter. If you then
410 set the left gutter width to 0 for a particular buffer (or if that 410 set the left gutter width to 0 for a particular buffer (or if that
411 buffer does not specify a left gutter or has a nil value specified for 411 buffer does not specify a left gutter or has a @code{nil} value specified for
412 @code{left-gutter-visible-p}), you will find that, when that buffer is 412 @code{left-gutter-visible-p}), you will find that, when that buffer is
413 displayed in the selected window, the window will have a width of 86 or 413 displayed in the selected window, the window will have a width of 86 or
414 87 characters -- the frame is sized for a 68-pixel left gutter but the 414 87 characters -- the frame is sized for a 68-pixel left gutter but the
415 selected window specifies that the left gutter is not visible, so it is 415 selected window specifies that the left gutter is not visible, so it is
416 expanded to take up the slack. 416 expanded to take up the slack.