Mercurial > hg > xemacs-beta

comparison man/lispref/gutter.texi @ 408:501cfd01ee6d r21-2-34

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import from CVS: tag r21-2-34
author cvs
date Mon, 13 Aug 2007 11:18:11 +0200
parents 2f8bb876ab1d
children de805c49cfc1
comparison
equal deleted inserted replaced
407:ed6218a7d4d3 408:501cfd01ee6d
12 A gutter is a rectangle displayed along one edge of a frame. It 12 A gutter is a rectangle displayed along one edge of a frame. It
13 can contain arbitrary text or graphics. 13 can contain arbitrary text or graphics.
14 14
15 @menu 15 @menu
16 * Gutter Intro:: An introduction. 16 * Gutter Intro:: An introduction.
17 * Gutter Descriptor Format:: How to create a gutter. 17 * Creating Gutter:: How to create a gutter.
18 * Gutter Descriptor Format:: Accessing and modifying a gutter's
19 properties.
18 * Specifying a Gutter:: Setting a gutter's contents. 20 * Specifying a Gutter:: Setting a gutter's contents.
19 * Other Gutter Variables:: Controlling the size of gutters. 21 * Other Gutter Variables:: Controlling the size of gutters.
20 * Common Gutter Widgets:: Things to put in gutters. 22 * Common Gutter Widgets:: Things to put in gutters.
21 @end menu 23 @end menu
22 24
23 @node Gutter Intro, Gutter Descriptor Format, , Gutter 25 @node Gutter Intro, Creating Gutter, Gutter, Gutter
24 @section Gutter Intro 26 @section Gutter Intro
25 27
26 A @dfn{gutter} is a rectangle displayed along one edge of a frame. It 28 A @dfn{gutter} is a rectangle displayed along one edge of a frame. It
27 can contain arbitrary text or graphics. It could be considered a 29 can contain arbitrary text or graphics. It could be considered a
28 generalization of a toolbar, although toolbars are not currently 30 generalization of a toolbar, although toolbars are not currently
55 such as VM that wants to put its own gutter in a different location 57 such as VM that wants to put its own gutter in a different location
56 from the default just sets the position-specific specifiers, and if 58 from the default just sets the position-specific specifiers, and if
57 the user sets the default gutter to the same position, it will just 59 the user sets the default gutter to the same position, it will just
58 not be visible. 60 not be visible.
59 61
60 @node Gutter Descriptor Format, Specifying a Gutter, Gutter Intro, Gutter 62 @node Creating Gutter, Gutter Descriptor Format, Gutter Intro, Gutter
63 @section Creating Gutter
64
65 @defun make-gutter-specifier spec-list
66
67 Return a new @code{gutter} specifier object with the given specification
68 list. @var{spec-list} can be a list of specifications (each of which is
69 a cons of a locale and a list of instantiators), a single instantiator,
70 or a list of instantiators. @xref{Specifiers}, for more information
71 about specifiers.
72
73 Gutter specifiers are used to specify the format of a gutter. The
74 values of the variables @code{default-gutter}, @code{top-gutter},
75 @code{left-gutter}, @code{right-gutter}, and @code{bottom-gutter} are
76 always gutter specifiers.
77
78 Valid gutter instantiators are called "gutter descriptors" and are
79 either strings or property-lists of strings. See @code{default-gutter}
80 for a description of the exact format.
81 @end defun
82
83 @defun make-gutter-size-specifier spec-list
84
85 Return a new @code{gutter-size} specifier object with the given spec
86 list. @var{spec-list} can be a list of specifications (each of which is
87 a cons of a locale and a list of instantiators), a single instantiator,
88 or a list of instantiators. @xref{Specifiers}, for more information
89 about specifiers.
90
91 Gutter-size specifiers are used to specify the size of a gutter. The
92 values of the variables @code{default-gutter-size},
93 @code{top-gutter-size}, @code{left-gutter-size},
94 @code{right-gutter-size}, and @code{bottom-gutter-size} are always
95 gutter-size specifiers.
96
97 Valid gutter-size instantiators are either integers or the special
98 symbol @code{autodetect}. If a gutter-size is set to @code{autodetect}
99 them the size of the gutter will be adjusted to just accomodate the
100 gutters contents. @code{autodetect} only works for top and bottom
101 gutters.
102 @end defun
103
104 @defun make-gutter-visible-specifier spec-list
105
106 Return a new @code{gutter-visible} specifier object with the given spec
107 list. @var{spec-list} can be a list of specifications (each of which is
108 a cons of a locale and a list of instantiators), a single instantiator,
109 or a list of instantiators. @xref{Specifiers}, for more information
110 about specifiers.
111
112 Gutter-visible specifiers are used to specify the visibility of a
113 gutter. The values of the variables @code{default-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
116 always gutter-visible specifiers.
117
118 Valid gutter-visible instantiators are t, nil or a list of symbols. If
119 a gutter-visible instantiator is set to a list of symbols, and the
120 correspondong gutter specification is a property-list strings, then
121 elements of the gutter specification will only be visible if the
122 corresponding symbol occurs in the gutter-visible instantiator.
123 @end defun
124
125 @node Gutter Descriptor Format, Specifying a Gutter, Creating Gutter, Gutter
61 @section Gutter Descriptor Format 126 @section Gutter Descriptor Format
62 127
63 The contents of a gutter are specified using a @dfn{gutter descriptor}. 128 The contents of a gutter are specified using a @dfn{gutter descriptor}.
64 The format of a gutter descriptor is a list of @dfn{gutter button 129 The format of a gutter descriptor is a list of @dfn{gutter button
65 descriptors}. Each gutter button descriptor is a vector in one of the 130 descriptors}. Each gutter button descriptor is a vector in one of the
381 @menu 446 @menu
382 * Buffer Tabs:: Tabbed divider index metaphor for switching buffers. 447 * Buffer Tabs:: Tabbed divider index metaphor for switching buffers.
383 * Progress Bars:: Visual indication of operation progress. 448 * Progress Bars:: Visual indication of operation progress.
384 @end menu 449 @end menu
385 450
386 @node Buffer Tabs, Progress Bars, , Common Gutter Widgets 451 @node Buffer Tabs, Progress Bars, ,Common Gutter Widgets
387 @section Buffer Tabs 452 @subsection Buffer Tabs
388 453
389 Not documented yet. 454 Not documented yet.
390 455
391 @node Progress Bars, , Buffer Tabs, Common Gutter Widgets 456 @node Progress Bars, , Buffer Tabs, Common Gutter Widgets
392 @section Progress Bars 457 @subsection Progress Bars
393 458
394 Not documented yet. 459 Not documented yet.
395 460