X-Git-Url: http://git.chise.org/gitweb/?a=blobdiff_plain;f=man%2Flispref%2Fgutter.texi;h=f3f9b9c8419d845729bb8a57aac191bb4c85cf99;hb=682b150413bbb86eadb481299953bc42c8faca92;hp=4da9fa22e7303bc64fbb24e704fa9bd045aadf68;hpb=a92fd34d4e19af388237a0913a5c30ddbcfdde7a;p=chise%2Fxemacs-chise.git- diff --git a/man/lispref/gutter.texi b/man/lispref/gutter.texi index 4da9fa2..f3f9b9c 100644 --- a/man/lispref/gutter.texi +++ b/man/lispref/gutter.texi @@ -14,13 +14,15 @@ can contain arbitrary text or graphics. @menu * Gutter Intro:: An introduction. -* Gutter Descriptor Format:: How to create a gutter. +* Creating Gutter:: How to create a gutter. +* Gutter Descriptor Format:: Accessing and modifying a gutter's + properties. * Specifying a Gutter:: Setting a gutter's contents. * Other Gutter Variables:: Controlling the size of gutters. * Common Gutter Widgets:: Things to put in gutters. @end menu -@node Gutter Intro, Gutter Descriptor Format, , Gutter +@node Gutter Intro, Creating Gutter, Gutter, Gutter @section Gutter Intro A @dfn{gutter} is a rectangle displayed along one edge of a frame. It @@ -57,7 +59,70 @@ from the default just sets the position-specific specifiers, and if the user sets the default gutter to the same position, it will just not be visible. -@node Gutter Descriptor Format, Specifying a Gutter, Gutter Intro, Gutter +@node Creating Gutter, Gutter Descriptor Format, Gutter Intro, Gutter +@section Creating Gutter + +@defun make-gutter-specifier spec-list + +Return a new @code{gutter} specifier object with the given specification +list. @var{spec-list} can be a list of specifications (each of which is +a cons of a locale and a list of instantiators), a single instantiator, +or a list of instantiators. @xref{Specifiers}, for more information +about specifiers. + +Gutter specifiers are used to specify the format of a gutter. The +values of the variables @code{default-gutter}, @code{top-gutter}, +@code{left-gutter}, @code{right-gutter}, and @code{bottom-gutter} are +always gutter specifiers. + +Valid gutter instantiators are called "gutter descriptors" and are +either strings or property-lists of strings. See @code{default-gutter} +for a description of the exact format. +@end defun + +@defun make-gutter-size-specifier spec-list + +Return a new @code{gutter-size} specifier object with the given spec +list. @var{spec-list} can be a list of specifications (each of which is +a cons of a locale and a list of instantiators), a single instantiator, +or a list of instantiators. @xref{Specifiers}, for more information +about specifiers. + +Gutter-size specifiers are used to specify the size of a gutter. The +values of the variables @code{default-gutter-size}, +@code{top-gutter-size}, @code{left-gutter-size}, +@code{right-gutter-size}, and @code{bottom-gutter-size} are always +gutter-size specifiers. + +Valid gutter-size instantiators are either integers or the special +symbol @code{autodetect}. If a gutter-size is set to @code{autodetect} +them the size of the gutter will be adjusted to just accommodate the +gutters contents. @code{autodetect} only works for top and bottom +gutters. +@end defun + +@defun make-gutter-visible-specifier spec-list + +Return a new @code{gutter-visible} specifier object with the given spec +list. @var{spec-list} can be a list of specifications (each of which is +a cons of a locale and a list of instantiators), a single instantiator, +or a list of instantiators. @xref{Specifiers}, for more information +about specifiers. + +Gutter-visible specifiers are used to specify the visibility of a +gutter. The values of the variables @code{default-gutter-visible-p}, +@code{top-gutter-visible-p}, @code{left-gutter-visible-p}, +@code{right-gutter-visible-p}, and @code{bottom-gutter-visible-p} are +always gutter-visible specifiers. + +Valid gutter-visible instantiators are @code{t}, @code{nil} or a list of +symbols. If a gutter-visible instantiator is set to a list of symbols, +and the corresponding gutter specification is a property-list strings, +then elements of the gutter specification will only be visible if the +corresponding symbol occurs in the gutter-visible instantiator. +@end defun + +@node Gutter Descriptor Format, Specifying a Gutter, Creating Gutter, Gutter @section Gutter Descriptor Format The contents of a gutter are specified using a @dfn{gutter descriptor}. @@ -187,7 +252,7 @@ the user to choose where the gutter should go. @defvr Specifier default-gutter The position of this gutter is specified in the function -@code{default-gutter-position}. If the corresponding +@code{default-gutter-position}. If the corresponding position-specific gutter (e.g. @code{top-gutter} if @code{default-gutter-position} is @code{top}) does not specify a gutter in a particular domain, then the value of @code{default-gutter} @@ -247,7 +312,7 @@ Specifier for the gutter at the right edge of the frame. @end defvr @defun gutter-specifier-p object -This function returns non-nil if @var{object} is a gutter specifier. +This function returns non-@code{nil} if @var{object} is a gutter specifier. Gutter specifiers are the actual objects contained in the gutter variables described above, and their valid instantiators are gutter descriptors (@pxref{Gutter Descriptor Format}). @@ -343,7 +408,7 @@ visibility that is used in frame geometry calculations. left gutter width for that frame to 68 pixels, then the frame will be sized to fit 80 characters plus a 68-pixel left gutter. If you then set the left gutter width to 0 for a particular buffer (or if that -buffer does not specify a left gutter or has a nil value specified for +buffer does not specify a left gutter or has a @code{nil} value specified for @code{left-gutter-visible-p}), you will find that, when that buffer is displayed in the selected window, the window will have a width of 86 or 87 characters -- the frame is sized for a 68-pixel left gutter but the @@ -383,13 +448,13 @@ time-consuming operations like downloading. * Progress Bars:: Visual indication of operation progress. @end menu -@node Buffer Tabs, Progress Bars, , Common Gutter Widgets -@section Buffer Tabs +@node Buffer Tabs, Progress Bars, ,Common Gutter Widgets +@subsection Buffer Tabs Not documented yet. -@node Progress Bars, , Buffer Tabs, Common Gutter Widgets -@section Progress Bars +@node Progress Bars, , Buffer Tabs, Common Gutter Widgets +@subsection Progress Bars Not documented yet.