annotate man/widget.texi @ 149:538048ae2ab8 r20-3b1

Import from CVS: tag r20-3b1
author cvs
date Mon, 13 Aug 2007 09:36:16 +0200
parents b980b6286996
children 25f70ba0133c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1 \input texinfo.tex
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
2
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
3 @c %**start of header
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
4 @setfilename widget
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
5 @settitle The Emacs Widget Library
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
6 @iftex
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
7 @afourpaper
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
8 @headings double
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
9 @end iftex
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
10 @c %**end of header
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
11
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
12 @node Top, Introduction, (dir), (dir)
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
13 @comment node-name, next, previous, up
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
14 @top The Emacs Widget Library
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
15
149
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
16 Version: 1.97
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
17
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
18 @menu
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
19 * Introduction::
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
20 * User Interface::
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
21 * Programming Example::
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
22 * Setting Up the Buffer::
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
23 * Basic Types::
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
24 * Sexp Types::
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
25 * Widget Properties::
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
26 * Defining New Widgets::
149
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
27 * Widget Browser::
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
28 * Widget Minor Mode::
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
29 * Utilities::
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
30 * Widget Wishlist::
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
31 @end menu
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
32
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
33 @node Introduction, User Interface, Top, Top
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
34 @comment node-name, next, previous, up
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
35 @section Introduction
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
36
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
37 Most graphical user interface toolkits, such as Motif and XView, provide
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
38 a number of standard user interface controls (sometimes known as
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
39 `widgets' or `gadgets'). Emacs doesn't really support anything like
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
40 this, except for an incredible powerful text ``widget''. On the other
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
41 hand, Emacs does provide the necessary primitives to implement many
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
42 other widgets within a text buffer. The @code{widget} package
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
43 simplifies this task.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
44
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
45 The basic widgets are:
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
46
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
47 @table @code
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
48 @item link
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
49 Areas of text with an associated action. Intended for hypertext links
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
50 embedded in text.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
51 @item push-button
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
52 Like link, but intended for stand-alone buttons.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
53 @item editable-field
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
54 An editable text field. It can be either variable or fixed length.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
55 @item menu-choice
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
56 Allows the user to choose one of multiple options from a menu, each
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
57 option is itself a widget. Only the selected option will be visible in
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
58 the buffer.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
59 @item radio-button-choice
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
60 Allows the user to choose one of multiple options by pushing radio
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
61 buttons. The options are implemented as widgets. All options will be
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
62 visible in the buffer.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
63 @item item
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
64 A simple constant widget intended to be used in the @code{menu-choice} and
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
65 @code{radio-button-choice} widgets.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
66 @item choice-item
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
67 An button item only intended for use in choices. When pushed, the user
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
68 will be asked to select another option from the choice widget.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
69 @item toggle
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
70 A simple @samp{on}/@samp{off} switch.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
71 @item checkbox
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
72 A checkbox (@samp{[ ]}/@samp{[X]}).
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
73 @item editable-list
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
74 Create an editable list. The user can insert or delete items in the
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
75 list. Each list item is itself a widget.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
76 @end table
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
77
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
78 Now of what possible use can support for widgets be in a text editor?
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
79 I'm glad you asked. The answer is that widgets are useful for
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
80 implementing forms. A @dfn{form} in emacs is a buffer where the user is
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
81 supposed to fill out a number of fields, each of which has a specific
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
82 meaning. The user is not supposed to change or delete any of the text
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
83 between the fields. Examples of forms in Emacs are the @file{forms}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
84 package (of course), the customize buffers, the mail and news compose
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
85 modes, and the @sc{html} form support in the @file{w3} browser.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
86
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
87 The advantages for a programmer of using the @code{widget} package to
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
88 implement forms are:
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
89
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
90 @enumerate
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
91 @item
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
92 More complex field than just editable text are supported.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
93 @item
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
94 You can give the user immediate feedback if he enters invalid data in a
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
95 text field, and sometimes prevent entering invalid data.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
96 @item
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
97 You can have fixed sized fields, thus allowing multiple field to be
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
98 lined up in columns.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
99 @item
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
100 It is simple to query or set the value of a field.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
101 @item
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
102 Editing happens in buffer, not in the mini-buffer.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
103 @item
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
104 Packages using the library get a uniform look, making them easier for
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
105 the user to learn.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
106 @item
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
107 As support for embedded graphics improve, the widget library will
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
108 extended to support it. This means that your code using the widget
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
109 library will also use the new graphic features by automatic.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
110 @end enumerate
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
111
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
112 In order to minimize the code that is loaded by users who does not
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
113 create any widgets, the code has been split in two files:
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
114
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
115 @table @file
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
116 @item widget.el
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
117 This will declare the user variables, define the function
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
118 @code{widget-define}, and autoload the function @code{widget-create}.
106
8ff55ebd4be9 Import from CVS: tag r20-1b5
cvs
parents: 102
diff changeset
119 @item wid-edit.el
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
120 Everything else is here, there is no reason to load it explicitly, as
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
121 it will be autoloaded when needed.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
122 @end table
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
123
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
124 @node User Interface, Programming Example, Introduction, Top
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
125 @comment node-name, next, previous, up
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
126 @section User Interface
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
127
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
128 A form consist of read only text for documentation and some fields,
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
129 where each the fields contain two parts, as tag and a value. The tags
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
130 are used to identify the fields, so the documentation can refer to the
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
131 foo field, meaning the field tagged with @samp{Foo}. Here is an example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
132 form:
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
133
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
134 @example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
135 Here is some documentation.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
136
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
137 Name: @i{My Name} @strong{Choose}: This option
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
138 Address: @i{Some Place
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
139 In some City
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
140 Some country.}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
141
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
142 See also @b{_other work_} for more information.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
143
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
144 Numbers: count to three below
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
145 @b{[INS]} @b{[DEL]} @i{One}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
146 @b{[INS]} @b{[DEL]} @i{Eh, two?}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
147 @b{[INS]} @b{[DEL]} @i{Five!}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
148 @b{[INS]}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
149
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
150 Select multiple:
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
151
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
152 @b{[X]} This
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
153 @b{[ ]} That
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
154 @b{[X]} Thus
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
155
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
156 Select one:
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
157
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
158 @b{(*)} One
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
159 @b{( )} Another One.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
160 @b{( )} A Final One.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
161
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
162 @b{[Apply Form]} @b{[Reset Form]}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
163 @end example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
164
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
165 The top level widgets in is example are tagged @samp{Name},
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
166 @samp{Choose}, @samp{Address}, @samp{_other work_}, @samp{Numbers},
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
167 @samp{Select multiple}, @samp{Select one}, @samp{[Apply Form]}, and
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
168 @samp{[Reset Form]}. There are basically two thing the user can do within
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
169 a form, namely editing the editable text fields and activating the
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
170 buttons.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
171
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
172 @subsection Editable Text Fields
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
173
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
174 In the example, the value for the @samp{Name} is most likely displayed
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
175 in an editable text field, and so are values for each of the members of
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
176 the @samp{Numbers} list. All the normal Emacs editing operations are
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
177 available for editing these fields. The only restriction is that each
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
178 change you make must be contained within a single editable text field.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
179 For example, capitalizing all text from the middle of one field to the
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
180 middle of another field is prohibited.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
181
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
182 Editing text fields are created by the @code{editable-field} widget.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
183
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
184 The editing text fields are highlighted with the
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
185 @code{widget-field-face} face, making them easy to find.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
186
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
187 @deffn Face widget-field-face
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
188 Face used for other editing fields.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
189 @end deffn
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
190
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
191 @subsection Buttons
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
192
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
193 Some portions of the buffer have an associated @dfn{action}, which can
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
194 be @dfn{activated} by a standard key or mouse command. These portions
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
195 are called @dfn{buttons}. The default commands for activating a button
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
196 are:
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
197
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
198 @table @kbd
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
199 @item @key{RET}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
200 @deffn Command widget-button-press @var{pos} &optional @var{event}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
201 Activate the button at @var{pos}, defaulting to point.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
202 If point is not located on a button, activate the binding in
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
203 @code{widget-global-map} (by default the global map).
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
204 @end deffn
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
205
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
206 @item mouse-2
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
207 @deffn Command widget-button-click @var{event}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
208 Activate the button at the location of the mouse pointer. If the mouse
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
209 pointer is located in an editable text field, activate the binding in
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
210 @code{widget-global-map} (by default the global map).
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
211 @end deffn
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
212 @end table
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
213
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
214 There are several different kind of buttons, all of which are present in
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
215 the example:
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
216
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
217 @table @emph
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
218 @item The Option Field Tags.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
219 When you activate one of these buttons, you will be asked to choose
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
220 between a number of different options. This is how you edit an option
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
221 field. Option fields are created by the @code{menu-choice} widget. In
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
222 the example, @samp{@b{Choose}} is an option field tag.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
223 @item The @samp{@b{[INS]}} and @samp{@b{[DEL]}} buttons.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
224 Activating these will insert or delete elements from a editable list.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
225 The list is created by the @code{editable-list} widget.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
226 @item Embedded Buttons.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
227 The @samp{@b{_other work_}} is an example of an embedded
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
228 button. Embedded buttons are not associated with a fields, but can serve
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
229 any purpose, such as implementing hypertext references. They are
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
230 usually created by the @code{link} widget.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
231 @item The @samp{@b{[ ]}} and @samp{@b{[X]}} buttons.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
232 Activating one of these will convert it to the other. This is useful
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
233 for implementing multiple-choice fields. You can create it wit
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
234 @item The @samp{@b{( )}} and @samp{@b{(*)}} buttons.
149
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
235 Only one radio button in a @code{radio-button-choice} widget can be
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
236 selected at any time. When you push one of the unselected radio
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
237 buttons, it will be selected and the previous selected radio button will
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
238 become unselected.
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
239 @item The @samp{@b{[Apply Form]}} @samp{@b{[Reset Form]}} buttons.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
240 These are explicit buttons made with the @code{push-button} widget. The main
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
241 difference from the @code{link} widget is that the buttons are will be
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
242 displayed as GUI buttons when possible.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
243 enough.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
244 @end table
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
245
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
246 To make them easier to locate, buttons are emphasized in the buffer.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
247
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
248 @deffn Face widget-button-face
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
249 Face used for buttons.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
250 @end deffn
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
251
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
252 @defopt widget-mouse-face
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
253 Face used for buttons when the mouse pointer is above it.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
254 @end defopt
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
255
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
256 @subsection Navigation
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
257
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
258 You can use all the normal Emacs commands to move around in a form
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
259 buffer, plus you will have these additional commands:
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
260
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
261 @table @kbd
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
262 @item @key{TAB}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
263 @deffn Command widget-forward &optional count
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
264 Move point @var{count} buttons or editing fields forward.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
265 @end deffn
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
266 @item @key{M-TAB}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
267 @deffn Command widget-backward &optional count
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
268 Move point @var{count} buttons or editing fields backward.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
269 @end deffn
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
270 @end table
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
271
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
272 @node Programming Example, Setting Up the Buffer, User Interface, Top
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
273 @comment node-name, next, previous, up
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
274 @section Programming Example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
275
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
276 Here is the code to implement the user interface example (see @ref{User
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
277 Interface}).
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
278
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
279 @lisp
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
280 (require 'widget)
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
281
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
282 (eval-when-compile
106
8ff55ebd4be9 Import from CVS: tag r20-1b5
cvs
parents: 102
diff changeset
283 (require 'wid-edit))
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
284
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
285 (defvar widget-example-repeat)
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
286
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
287 (defun widget-example ()
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
288 "Create the widgets from the Widget manual."
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
289 (interactive)
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
290 (switch-to-buffer "*Widget Example*")
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
291 (kill-all-local-variables)
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
292 (make-local-variable 'widget-example-repeat)
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
293 (let ((inhibit-read-only t))
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
294 (erase-buffer))
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
295 (widget-insert "Here is some documentation.\n\nName: ")
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
296 (widget-create 'editable-field
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
297 :size 13
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
298 "My Name")
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
299 (widget-create 'menu-choice
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
300 :tag "Choose"
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
301 :value "This"
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
302 :help-echo "Choose me, please!"
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
303 :notify (lambda (widget &rest ignore)
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
304 (message "%s is a good choice!"
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
305 (widget-value widget)))
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
306 '(item :tag "This option" :value "This")
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
307 '(choice-item "That option")
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
308 '(editable-field :menu-tag "No option" "Thus option"))
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
309 (widget-insert "Address: ")
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
310 (widget-create 'editable-field
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
311 "Some Place\nIn some City\nSome country.")
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
312 (widget-insert "\nSee also ")
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
313 (widget-create 'link
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
314 :notify (lambda (&rest ignore)
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
315 (widget-value-set widget-example-repeat
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
316 '("En" "To" "Tre"))
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
317 (widget-setup))
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
318 "other work")
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
319 (widget-insert " for more information.\n\nNumbers: count to three below\n")
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
320 (setq widget-example-repeat
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
321 (widget-create 'editable-list
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
322 :entry-format "%i %d %v"
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
323 :notify (lambda (widget &rest ignore)
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
324 (let ((old (widget-get widget
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
325 ':example-length))
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
326 (new (length (widget-value widget))))
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
327 (unless (eq old new)
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
328 (widget-put widget ':example-length new)
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
329 (message "You can count to %d." new))))
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
330 :value '("One" "Eh, two?" "Five!")
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
331 '(editable-field :value "three")))
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
332 (widget-insert "\n\nSelect multiple:\n\n")
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
333 (widget-create 'checkbox t)
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
334 (widget-insert " This\n")
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
335 (widget-create 'checkbox nil)
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
336 (widget-insert " That\n")
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
337 (widget-create 'checkbox
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
338 :notify (lambda (&rest ignore) (message "Tickle"))
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
339 t)
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
340 (widget-insert " Thus\n\nSelect one:\n\n")
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
341 (widget-create 'radio-button-choice
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
342 :value "One"
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
343 :notify (lambda (widget &rest ignore)
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
344 (message "You selected %s"
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
345 (widget-value widget)))
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
346 '(item "One") '(item "Anthor One.") '(item "A Final One."))
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
347 (widget-insert "\n")
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
348 (widget-create 'push-button
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
349 :notify (lambda (&rest ignore)
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
350 (if (= (length (widget-value widget-example-repeat))
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
351 3)
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
352 (message "Congratulation!")
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
353 (error "Three was the count!")))
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
354 "Apply Form")
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
355 (widget-insert " ")
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
356 (widget-create 'push-button
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
357 :notify (lambda (&rest ignore)
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
358 (widget-example))
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
359 "Reset Form")
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
360 (widget-insert "\n")
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
361 (use-local-map widget-keymap)
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
362 (widget-setup))
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
363 @end lisp
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
364
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
365 @node Setting Up the Buffer, Basic Types, Programming Example, Top
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
366 @comment node-name, next, previous, up
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
367 @section Setting Up the Buffer
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
368
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
369 Widgets are created with @code{widget-create}, which returns a
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
370 @dfn{widget} object. This object can be queried and manipulated by
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
371 other widget functions, until it is deleted with @code{widget-delete}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
372 After the widgets have been created, @code{widget-setup} must be called
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
373 to enable them.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
374
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
375 @defun widget-create type [ keyword argument ]@dots{}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
376 Create and return a widget of type @var{type}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
377 The syntax for the @var{type} argument is described in @ref{Basic Types}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
378
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
379 The keyword arguments can be used to overwrite the keyword arguments
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
380 that are part of @var{type}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
381 @end defun
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
382
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
383 @defun widget-delete widget
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
384 Delete @var{widget} and remove it from the buffer.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
385 @end defun
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
386
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
387 @defun widget-setup
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
388 Setup a buffer to support widgets.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
389
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
390 This should be called after creating all the widgets and before allowing
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
391 the user to edit them.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
392 @refill
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
393 @end defun
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
394
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
395 If you want to insert text outside the widgets in the form, the
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
396 recommended way to do that is with @code{widget-insert}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
397
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
398 @defun widget-insert
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
399 Insert the arguments, either strings or characters, at point.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
400 The inserted text will be read only.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
401 @end defun
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
402
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
403 There is a standard widget keymap which you might find useful.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
404
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
405 @defvr Const widget-keymap
108
360340f9fd5f Import from CVS: tag r20-1b6
cvs
parents: 106
diff changeset
406 A keymap with the global keymap as its parent.@*
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
407 @key{TAB} and @kbd{C-@key{TAB}} are bound to @code{widget-forward} and
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
408 @code{widget-backward}, respectively. @kbd{@key{RET}} and @kbd{mouse-2}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
409 are bound to @code{widget-button-press} and
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
410 @code{widget-button-}.@refill
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
411 @end defvr
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
412
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
413 @defvar widget-global-map
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
414 Keymap used by @code{widget-button-press} and @code{widget-button-click}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
415 when not on a button. By default this is @code{global-map}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
416 @end defvar
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
417
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
418 @node Basic Types, Sexp Types, Setting Up the Buffer, Top
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
419 @comment node-name, next, previous, up
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
420 @section Basic Types
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
421
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
422 The syntax of a type specification is given below:
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
423
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
424 @example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
425 NAME ::= (NAME [KEYWORD ARGUMENT]... ARGS)
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
426 | NAME
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
427 @end example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
428
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
429 Where, @var{name} is a widget name, @var{keyword} is the name of a
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
430 property, @var{argument} is the value of the property, and @var{args}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
431 are interpreted in a widget specific way.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
432
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
433 There following keyword arguments that apply to all widgets:
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
434
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
435 @table @code
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
436 @item :value
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
437 The initial value for widgets of this type.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
438
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
439 @item :format
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
440 This string will be inserted in the buffer when you create a widget.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
441 The following @samp{%} escapes are available:
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
442
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
443 @table @samp
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
444 @item %[
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
445 @itemx %]
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
446 The text inside will be marked as a button.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
447
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
448 @item %@{
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
449 @itemx %@}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
450 The text inside will be displayed with the face specified by
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
451 @code{:sample-face}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
452
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
453 @item %v
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
454 This will be replaces with the buffer representation of the widgets
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
455 value. What this is depends on the widget type.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
456
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
457 @item %d
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
458 Insert the string specified by @code{:doc} here.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
459
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
460 @item %h
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
461 Like @samp{%d}, with the following modifications: If the documentation
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
462 string is more than one line, it will add a button which will toggle
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
463 between showing only the first line, and showing the full text.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
464 Furthermore, if there is no @code{:doc} property in the widget, it will
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
465 instead examine the @code{:documentation-property} property. If it is a
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
466 lambda expression, it will be called with the widget's value as an
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
467 argument, and the result will be used as the documentation text.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
468
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
469 @item %t
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
470 Insert the string specified by @code{:tag} here, or the @code{princ}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
471 representation of the value if there is no tag.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
472
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
473 @item %%
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
474 Insert a literal @samp{%}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
475 @end table
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
476
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
477 @item :button-face
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
478 Face used to highlight text inside %[ %] in the format.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
479
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
480 @item :doc
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
481 The string inserted by the @samp{%d} escape in the format
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
482 string.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
483
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
484 @item :tag
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
485 The string inserted by the @samp{%t} escape in the format
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
486 string.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
487
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
488 @item :tag-glyph
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
489 Name of image to use instead of the string specified by `:tag' on
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
490 Emacsen that supports it.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
491
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
492 @item :help-echo
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
493 Message displayed whenever you move to the widget with either
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
494 @code{widget-forward} or @code{widget-backward}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
495
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
496 @item :indent
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
497 An integer indicating the absolute number of spaces to indent children
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
498 of this widget.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
499
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
500 @item :offset
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
501 An integer indicating how many extra spaces to add to the widget's
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
502 grandchildren compared to this widget.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
503
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
504 @item :extra-offset
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
505 An integer indicating how many extra spaces to add to the widget's
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
506 children compared to this widget.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
507
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
508 @item :notify
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
509 A function called each time the widget or a nested widget is changed.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
510 The function is called with two or three arguments. The first argument
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
511 is the widget itself, the second argument is the widget that was
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
512 changed, and the third argument is the event leading to the change, if
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
513 any.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
514
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
515 @item :menu-tag
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
516 Tag used in the menu when the widget is used as an option in a
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
517 @code{menu-choice} widget.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
518
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
519 @item :menu-tag-get
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
520 Function used for finding the tag when the widget is used as an option
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
521 in a @code{menu-choice} widget. By default, the tag used will be either the
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
522 @code{:menu-tag} or @code{:tag} property if present, or the @code{princ}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
523 representation of the @code{:value} property if not.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
524
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
525 @item :match
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
526 Should be a function called with two arguments, the widget and a value,
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
527 and returning non-nil if the widget can represent the specified value.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
528
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
529 @item :validate
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
530 A function which takes a widget as an argument, and return nil if the
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
531 widgets current value is valid for the widget. Otherwise, it should
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
532 return the widget containing the invalid data, and set that widgets
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
533 @code{:error} property to a string explaining the error.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
534
149
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
535 The following predefined function can be used:
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
536
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
537 @defun widget-children-validate widget
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
538 All the @code{:children} of @var{widget} must be valid.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
539 @end defun
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
540
110
fe104dbd9147 Import from CVS: tag r20-1b7
cvs
parents: 108
diff changeset
541 @item :tab-order
fe104dbd9147 Import from CVS: tag r20-1b7
cvs
parents: 108
diff changeset
542 Specify the order in which widgets are traversed with
fe104dbd9147 Import from CVS: tag r20-1b7
cvs
parents: 108
diff changeset
543 @code{widget-forward} or @code{widget-backward}. This is only partially
fe104dbd9147 Import from CVS: tag r20-1b7
cvs
parents: 108
diff changeset
544 implemented.
fe104dbd9147 Import from CVS: tag r20-1b7
cvs
parents: 108
diff changeset
545
fe104dbd9147 Import from CVS: tag r20-1b7
cvs
parents: 108
diff changeset
546 @enumerate a
fe104dbd9147 Import from CVS: tag r20-1b7
cvs
parents: 108
diff changeset
547 @item
fe104dbd9147 Import from CVS: tag r20-1b7
cvs
parents: 108
diff changeset
548 Widgets with tabbing order @code{-1} are ignored.
fe104dbd9147 Import from CVS: tag r20-1b7
cvs
parents: 108
diff changeset
549
fe104dbd9147 Import from CVS: tag r20-1b7
cvs
parents: 108
diff changeset
550 @item
fe104dbd9147 Import from CVS: tag r20-1b7
cvs
parents: 108
diff changeset
551 (Unimplemented) When on a widget with tabbing order @var{n}, go to the
fe104dbd9147 Import from CVS: tag r20-1b7
cvs
parents: 108
diff changeset
552 next widget in the buffer with tabbing order @var{n+1} or @code{nil},
fe104dbd9147 Import from CVS: tag r20-1b7
cvs
parents: 108
diff changeset
553 whichever comes first.
fe104dbd9147 Import from CVS: tag r20-1b7
cvs
parents: 108
diff changeset
554
fe104dbd9147 Import from CVS: tag r20-1b7
cvs
parents: 108
diff changeset
555 @item
fe104dbd9147 Import from CVS: tag r20-1b7
cvs
parents: 108
diff changeset
556 When on a widget with no tabbing order specified, go to the next widget
fe104dbd9147 Import from CVS: tag r20-1b7
cvs
parents: 108
diff changeset
557 in the buffer with a positive tabbing order, or @code{nil}
fe104dbd9147 Import from CVS: tag r20-1b7
cvs
parents: 108
diff changeset
558 @end enumerate
fe104dbd9147 Import from CVS: tag r20-1b7
cvs
parents: 108
diff changeset
559
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
560 @item :parent
110
fe104dbd9147 Import from CVS: tag r20-1b7
cvs
parents: 108
diff changeset
561 The parent of a nested widget (e.g. a @code{menu-choice} item or an
fe104dbd9147 Import from CVS: tag r20-1b7
cvs
parents: 108
diff changeset
562 element of a @code{editable-list} widget).
108
360340f9fd5f Import from CVS: tag r20-1b6
cvs
parents: 106
diff changeset
563
360340f9fd5f Import from CVS: tag r20-1b6
cvs
parents: 106
diff changeset
564 @item :sibling-args
360340f9fd5f Import from CVS: tag r20-1b6
cvs
parents: 106
diff changeset
565 This keyword is only used for members of a @code{radio-button-choice} or
360340f9fd5f Import from CVS: tag r20-1b6
cvs
parents: 106
diff changeset
566 @code{checklist}. The value should be a list of extra keyword
360340f9fd5f Import from CVS: tag r20-1b6
cvs
parents: 106
diff changeset
567 arguments, which will be used when creating the @code{radio-button} or
360340f9fd5f Import from CVS: tag r20-1b6
cvs
parents: 106
diff changeset
568 @code{checkbox} associated with this item.
360340f9fd5f Import from CVS: tag r20-1b6
cvs
parents: 106
diff changeset
569
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
570 @end table
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
571
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
572 @deffn {User Option} widget-glyph-directory
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
573 Directory where glyphs are found.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
574 Widget will look here for a file with the same name as specified for the
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
575 image, with either a @samp{.xpm} (if supported) or @samp{.xbm} extension.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
576 @end deffn
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
577
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
578 @deffn{User Option} widget-glyph-enable
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
579 If non-nil, allow glyphs to appear on displayes where they are supported.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
580 @end deffn
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
581
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
582
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
583 @menu
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
584 * link::
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
585 * url-link::
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
586 * info-link::
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
587 * push-button::
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
588 * editable-field::
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
589 * text::
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
590 * menu-choice::
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
591 * radio-button-choice::
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
592 * item::
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
593 * choice-item::
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
594 * toggle::
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
595 * checkbox::
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
596 * checklist::
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
597 * editable-list::
149
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
598 * group::
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
599 @end menu
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
600
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
601 @node link, url-link, Basic Types, Basic Types
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
602 @comment node-name, next, previous, up
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
603 @subsection The @code{link} Widget
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
604
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
605 Syntax:
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
606
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
607 @example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
608 TYPE ::= (link [KEYWORD ARGUMENT]... [ VALUE ])
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
609 @end example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
610
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
611 The @var{value}, if present, is used to initialize the @code{:value}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
612 property. The value should be a string, which will be inserted in the
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
613 buffer.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
614
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
615 @node url-link, info-link, link, Basic Types
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
616 @comment node-name, next, previous, up
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
617 @subsection The @code{url-link} Widget
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
618
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
619 Syntax:
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
620
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
621 @example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
622 TYPE ::= (url-link [KEYWORD ARGUMENT]... URL)
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
623 @end example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
624
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
625 When this link is activated, the @sc{www} browser specified by
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
626 @code{browse-url-browser-function} will be called with @var{url}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
627
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
628 @node info-link, push-button, url-link, Basic Types
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
629 @comment node-name, next, previous, up
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
630 @subsection The @code{info-link} Widget
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
631
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
632 Syntax:
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
633
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
634 @example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
635 TYPE ::= (info-link [KEYWORD ARGUMENT]... ADDRESS)
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
636 @end example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
637
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
638 When this link is activated, the build-in info browser is started on
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
639 @var{address}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
640
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
641 @node push-button, editable-field, info-link, Basic Types
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
642 @comment node-name, next, previous, up
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
643 @subsection The @code{push-button} Widget
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
644
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
645 Syntax:
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
646
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
647 @example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
648 TYPE ::= (push-button [KEYWORD ARGUMENT]... [ VALUE ])
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
649 @end example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
650
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
651 The @var{value}, if present, is used to initialize the @code{:value}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
652 property. The value should be a string, which will be inserted in the
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
653 buffer.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
654
120
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 118
diff changeset
655 The following extra properties are recognized.
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 118
diff changeset
656
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 118
diff changeset
657 @table @code
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 118
diff changeset
658 @item :text-format
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 118
diff changeset
659 The format string used when the push button cannot be displayed
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 118
diff changeset
660 graphically. There are two escapes, @code{%s}, which must be present
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 118
diff changeset
661 exactly once, will be substituted with the tag, and @code{%%} will be
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 118
diff changeset
662 substituted with a singe @samp{%}.
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 118
diff changeset
663 @end table
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 118
diff changeset
664
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 118
diff changeset
665 By default the tag will be shown in brackets.
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 118
diff changeset
666
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
667 @node editable-field, text, push-button, Basic Types
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
668 @comment node-name, next, previous, up
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
669 @subsection The @code{editable-field} Widget
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
670
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
671 Syntax:
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
672
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
673 @example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
674 TYPE ::= (editable-field [KEYWORD ARGUMENT]... [ VALUE ])
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
675 @end example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
676
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
677 The @var{value}, if present, is used to initialize the @code{:value}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
678 property. The value should be a string, which will be inserted in
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
679 field. This widget will match all string values.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
680
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
681 The following extra properties are recognized.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
682
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
683 @table @code
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
684 @item :size
108
360340f9fd5f Import from CVS: tag r20-1b6
cvs
parents: 106
diff changeset
685 The width of the editable field.@*
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
686 By default the field will reach to the end of the line.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
687
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
688 @item :value-face
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
689 Face used for highlighting the editable field. Default is
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
690 @code{widget-field-face}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
691
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
692 @item :secret
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
693 Character used to display the value. You can set this to e.g. @code{?*}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
694 if the field contains a password or other secret information. By
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
695 default, the value is not secret.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
696
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
697 @item :valid-regexp
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
698 By default the @code{:validate} function will match the content of the
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
699 field with the value of this attribute. The default value is @code{""}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
700 which matches everything.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
701
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
702 @item :keymap
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
703 Keymap used in the editable field. The default value is
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
704 @code{widget-field-keymap}, which allows you to use all the normal
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
705 editing commands, even if the buffers major mode supress some of them.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
706 Pressing return activates the function specified by @code{:activate}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
707
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
708 @item :hide-front-space
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
709 @itemx :hide-rear-space
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
710 In order to keep track of the editable field, emacs places an invisible
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
711 space character in front of the field, and for fixed sized fields also
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
712 in the rear end of the field. For fields that extent to the end of the
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
713 line, the terminating linefeed serves that purpose instead.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
714
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
715 Emacs will try to make the spaces intangible when it is safe to do so.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
716 Intangible means that the cursor motion commands will skip over the
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
717 character as if it didn't exist. This is safe to do when the text
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
718 preceding or following the widget cannot possible change during the
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
719 lifetime of the @code{editable-field} widget. The preferred way to tell
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
720 Emacs this, is to add text to the @code{:format} property around the
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
721 value. For example @code{:format "Tag: %v "}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
722
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
723 You can overwrite the internal safety check by setting the
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
724 @code{:hide-front-space} or @code{:hide-rear-space} properties to
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
725 non-nil. This is not recommended. For example, @emph{all} text that
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
726 belongs to a widget (i.e. is created from its @code{:format} string) will
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
727 change whenever the widget changes its value.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
728
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
729 @end table
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
730
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
731 @node text, menu-choice, editable-field, Basic Types
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
732 @comment node-name, next, previous, up
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
733 @subsection The @code{text} Widget
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
734
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
735 This is just like @code{editable-field}, but intended for multiline text
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
736 fields. The default @code{:keymap} is @code{widget-text-keymap}, which
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
737 does not rebind the return key.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
738
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
739 @node menu-choice, radio-button-choice, text, Basic Types
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
740 @comment node-name, next, previous, up
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
741 @subsection The @code{menu-choice} Widget
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
742
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
743 Syntax:
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
744
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
745 @example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
746 TYPE ::= (menu-choice [KEYWORD ARGUMENT]... TYPE ... )
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
747 @end example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
748
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
749 The @var{type} arguments represents each possible choice. The widgets
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
750 value of will be the value of the chosen @var{type} argument. This
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
751 widget will match any value that matches at least one of the specified
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
752 @var{type} arguments.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
753
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
754 @table @code
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
755 @item :void
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
756 Widget type used as a fallback when the value does not match any of the
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
757 specified @var{type} arguments.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
758
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
759 @item :case-fold
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
760 Set this to nil if you don't want to ignore case when prompting for a
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
761 choice through the minibuffer.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
762
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
763 @item :children
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
764 A list whose car is the widget representing the currently chosen type in
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
765 the buffer.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
766
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
767 @item :choice
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
768 The current chosen type
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
769
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
770 @item :args
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
771 The list of types.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
772 @end table
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
773
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
774 @node radio-button-choice, item, menu-choice, Basic Types
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
775 @comment node-name, next, previous, up
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
776 @subsection The @code{radio-button-choice} Widget
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
777
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
778 Syntax:
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
779
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
780 @example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
781 TYPE ::= (radio-button-choice [KEYWORD ARGUMENT]... TYPE ... )
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
782 @end example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
783
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
784 The @var{type} arguments represents each possible choice. The widgets
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
785 value of will be the value of the chosen @var{type} argument. This
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
786 widget will match any value that matches at least one of the specified
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
787 @var{type} arguments.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
788
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
789 The following extra properties are recognized.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
790
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
791 @table @code
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
792 @item :entry-format
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
793 This string will be inserted for each entry in the list.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
794 The following @samp{%} escapes are available:
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
795 @table @samp
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
796 @item %v
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
797 Replaced with the buffer representation of the @var{type} widget.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
798 @item %b
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
799 Replace with the radio button.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
800 @item %%
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
801 Insert a literal @samp{%}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
802 @end table
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
803
108
360340f9fd5f Import from CVS: tag r20-1b6
cvs
parents: 106
diff changeset
804 @item button-args
360340f9fd5f Import from CVS: tag r20-1b6
cvs
parents: 106
diff changeset
805 A list of keywords to pass to the radio buttons. Useful for setting
360340f9fd5f Import from CVS: tag r20-1b6
cvs
parents: 106
diff changeset
806 e.g. the @samp{:help-echo} for each button.
360340f9fd5f Import from CVS: tag r20-1b6
cvs
parents: 106
diff changeset
807
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
808 @item :buttons
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
809 The widgets representing the radio buttons.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
810
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
811 @item :children
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
812 The widgets representing each type.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
813
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
814 @item :choice
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
815 The current chosen type
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
816
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
817 @item :args
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
818 The list of types.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
819 @end table
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
820
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
821 You can add extra radio button items to a @code{radio-button-choice}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
822 widget after it has been created with the function
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
823 @code{widget-radio-add-item}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
824
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
825 @defun widget-radio-add-item widget type
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
826 Add to @code{radio-button-choice} widget @var{widget} a new radio button item of type
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
827 @var{type}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
828 @end defun
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
829
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
830 Please note that such items added after the @code{radio-button-choice}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
831 widget has been created will @strong{not} be properly destructed when
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
832 you call @code{widget-delete}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
833
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
834 @node item, choice-item, radio-button-choice, Basic Types
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
835 @comment node-name, next, previous, up
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
836 @subsection The @code{item} Widget
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
837
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
838 Syntax:
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
839
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
840 @example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
841 ITEM ::= (item [KEYWORD ARGUMENT]... VALUE)
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
842 @end example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
843
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
844 The @var{value}, if present, is used to initialize the @code{:value}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
845 property. The value should be a string, which will be inserted in the
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
846 buffer. This widget will only match the specified value.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
847
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
848 @node choice-item, toggle, item, Basic Types
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
849 @comment node-name, next, previous, up
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
850 @subsection The @code{choice-item} Widget
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
851
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
852 Syntax:
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
853
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
854 @example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
855 ITEM ::= (choice-item [KEYWORD ARGUMENT]... VALUE)
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
856 @end example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
857
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
858 The @var{value}, if present, is used to initialize the @code{:value}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
859 property. The value should be a string, which will be inserted in the
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
860 buffer as a button. Activating the button of a @code{choice-item} is
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
861 equivalent to activating the parent widget. This widget will only match
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
862 the specified value.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
863
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
864 @node toggle, checkbox, choice-item, Basic Types
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
865 @comment node-name, next, previous, up
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
866 @subsection The @code{toggle} Widget
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
867
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
868 Syntax:
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
869
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
870 @example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
871 TYPE ::= (toggle [KEYWORD ARGUMENT]...)
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
872 @end example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
873
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
874 The widget has two possible states, `on' and `off', which corresponds to
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
875 a @code{t} or @code{nil} value.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
876
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
877 The following extra properties are recognized.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
878
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
879 @table @code
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
880 @item :on
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
881 String representing the `on' state. By default the string @samp{on}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
882 @item :off
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
883 String representing the `off' state. By default the string @samp{off}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
884 @item :on-glyph
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
885 Name of a glyph to be used instead of the `:on' text string, on emacsen
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
886 that supports it.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
887 @item :off-glyph
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
888 Name of a glyph to be used instead of the `:off' text string, on emacsen
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
889 that supports it.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
890 @end table
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
891
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
892 @node checkbox, checklist, toggle, Basic Types
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
893 @comment node-name, next, previous, up
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
894 @subsection The @code{checkbox} Widget
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
895
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
896 The widget has two possible states, `selected' and `unselected', which
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
897 corresponds to a @code{t} or @code{nil} value.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
898
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
899 Syntax:
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
900
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
901 @example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
902 TYPE ::= (checkbox [KEYWORD ARGUMENT]...)
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
903 @end example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
904
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
905 @node checklist, editable-list, checkbox, Basic Types
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
906 @comment node-name, next, previous, up
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
907 @subsection The @code{checklist} Widget
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
908
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
909 Syntax:
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
910
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
911 @example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
912 TYPE ::= (checklist [KEYWORD ARGUMENT]... TYPE ... )
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
913 @end example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
914
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
915 The @var{type} arguments represents each checklist item. The widgets
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
916 value of will be a list containing the value of each ticked @var{type}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
917 argument. The checklist widget will match a list whose elements all
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
918 matches at least one of the specified @var{type} arguments.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
919
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
920 The following extra properties are recognized.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
921
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
922 @table @code
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
923 @item :entry-format
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
924 This string will be inserted for each entry in the list.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
925 The following @samp{%} escapes are available:
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
926 @table @samp
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
927 @item %v
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
928 Replaced with the buffer representation of the @var{type} widget.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
929 @item %b
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
930 Replace with the checkbox.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
931 @item %%
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
932 Insert a literal @samp{%}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
933 @end table
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
934
149
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
935 @item :greedy
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
936 Usually, a checklist will only match if the items are in the exact
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
937 sequence given in the specification. By setting @code{:greedy} to
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
938 non-nil, it will allow the items to come in any sequence. However, if
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
939 you extract the value they will be in the sequence given in the
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
940 checklist. I.e. the original sequence is forgotten.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
941
108
360340f9fd5f Import from CVS: tag r20-1b6
cvs
parents: 106
diff changeset
942 @item button-args
360340f9fd5f Import from CVS: tag r20-1b6
cvs
parents: 106
diff changeset
943 A list of keywords to pass to the checkboxes. Useful for setting
360340f9fd5f Import from CVS: tag r20-1b6
cvs
parents: 106
diff changeset
944 e.g. the @samp{:help-echo} for each checkbox.
360340f9fd5f Import from CVS: tag r20-1b6
cvs
parents: 106
diff changeset
945
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
946 @item :buttons
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
947 The widgets representing the checkboxes.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
948
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
949 @item :children
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
950 The widgets representing each type.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
951
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
952 @item :args
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
953 The list of types.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
954 @end table
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
955
149
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
956 @node editable-list, group, checklist, Basic Types
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
957 @comment node-name, next, previous, up
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
958 @subsection The @code{editable-list} Widget
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
959
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
960 Syntax:
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
961
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
962 @example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
963 TYPE ::= (editable-list [KEYWORD ARGUMENT]... TYPE)
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
964 @end example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
965
149
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
966 The value is a list, where each member represents one widget of type
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
967 @var{type}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
968
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
969 The following extra properties are recognized.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
970
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
971 @table @code
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
972 @item :entry-format
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
973 This string will be inserted for each entry in the list.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
974 The following @samp{%} escapes are available:
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
975 @table @samp
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
976 @item %v
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
977 This will be replaced with the buffer representation of the @var{type}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
978 widget.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
979 @item %i
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
980 Insert the @b{[INS]} button.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
981 @item %d
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
982 Insert the @b{[DEL]} button.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
983 @item %%
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
984 Insert a literal @samp{%}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
985 @end table
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
986
108
360340f9fd5f Import from CVS: tag r20-1b6
cvs
parents: 106
diff changeset
987 @item :insert-button-args
360340f9fd5f Import from CVS: tag r20-1b6
cvs
parents: 106
diff changeset
988 A list of keyword arguments to pass to the insert buttons.
360340f9fd5f Import from CVS: tag r20-1b6
cvs
parents: 106
diff changeset
989
360340f9fd5f Import from CVS: tag r20-1b6
cvs
parents: 106
diff changeset
990 @item :delete-button-args
360340f9fd5f Import from CVS: tag r20-1b6
cvs
parents: 106
diff changeset
991 A list of keyword arguments to pass to the delete buttons.
360340f9fd5f Import from CVS: tag r20-1b6
cvs
parents: 106
diff changeset
992
360340f9fd5f Import from CVS: tag r20-1b6
cvs
parents: 106
diff changeset
993 @item :append-button-args
360340f9fd5f Import from CVS: tag r20-1b6
cvs
parents: 106
diff changeset
994 A list of keyword arguments to pass to the trailing insert button.
360340f9fd5f Import from CVS: tag r20-1b6
cvs
parents: 106
diff changeset
995
360340f9fd5f Import from CVS: tag r20-1b6
cvs
parents: 106
diff changeset
996
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
997 @item :buttons
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
998 The widgets representing the insert and delete buttons.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
999
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1000 @item :children
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1001 The widgets representing the elements of the list.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1002
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1003 @item :args
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1004 List whose car is the type of the list elements.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1005
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1006 @end table
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1007
149
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1008 @node group, , editable-list, Basic Types
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1009 @comment node-name, next, previous, up
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1010 @subsection The @code{group} Widget
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1011
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1012 This widget simply group other widget together.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1013
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1014 Syntax:
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1015
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1016 @example
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1017 TYPE ::= (group [KEYWORD ARGUMENT]... TYPE...)
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1018 @end example
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1019
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1020 The value is a list, with one member for each @var{type}.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1021
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1022 @node Sexp Types, Widget Properties, Basic Types, Top
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1023 @comment
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1024 @section Sexp Types
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1025
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1026 A number of widgets for editing s-expressions (lisp types) are also
149
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1027 available. These basically fall in the following categories.
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1028
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1029 @menu
149
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1030 * constants::
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1031 * generic::
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1032 * atoms::
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1033 * composite::
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1034 @end menu
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1035
149
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1036 @node constants, generic, Sexp Types, Sexp Types
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1037 @comment node-name, next, previous, up
149
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1038 @subsection The Constant Widgets.
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1039
149
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1040 The @code{const} widget can contain any lisp expression, but the user is
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1041 prohibited from editing edit it, which is mainly useful as a component
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1042 of one of the composite widgets.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1043
149
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1044 The syntax for the @code{const} widget is
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1045
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1046 @example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1047 TYPE ::= (const [KEYWORD ARGUMENT]... [ VALUE ])
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1048 @end example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1049
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1050 The @var{value}, if present, is used to initialize the @code{:value}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1051 property and can be any s-expression.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1052
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1053 @deffn Widget const
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1054 This will display any valid s-expression in an immutable part of the
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1055 buffer.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1056 @end deffn
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1057
149
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1058 There are two variations of the @code{const} widget, namely
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1059 @code{variable-item} and @code{function-item}. These should contain a
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1060 symbol with a variable or function binding. The major difference from
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1061 the @code{const} widget is that they will allow the user to see the
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1062 variable or function documentation for the symbol.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1063
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1064 @deffn Widget variable-item
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1065 An immutable symbol that is bound as a variable.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1066 @end deffn
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1067
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1068 @deffn Widget function-item
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1069 An immutable symbol that is bound as a function.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1070 @end deffn
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1071
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1072 @node generic, atoms, constants, Sexp Types
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1073 @comment node-name, next, previous, up
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1074 @subsection Generic Sexp Widget.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1075
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1076 The @code{sexp} widget can contain any lisp expression, and allows the
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1077 user to edit it inline in the buffer.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1078
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1079 The syntax for the @code{sexp} widget is
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1080
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1081 @example
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1082 TYPE ::= (sexp [KEYWORD ARGUMENT]... [ VALUE ])
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1083 @end example
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1084
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1085 @deffn Widget sexp
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1086 This will allow you to edit any valid s-expression in an editable buffer
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1087 field.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1088
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1089 The @code{sexp} widget takes the same keyword arguments as the
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1090 @code{editable-field} widget.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1091 @end deffn
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1092
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1093 @node atoms, composite, generic, Sexp Types
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1094 @comment node-name, next, previous, up
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1095 @subsection Atomic Sexp Widgets.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1096
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1097 The atoms are s-expressions that does not consist of other
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1098 s-expressions. A string is an atom, while a list is a composite type.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1099 You can edit the value of an atom with the following widgets.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1100
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1101 The syntax for all the atoms are
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1102
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1103 @example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1104 TYPE ::= (NAME [KEYWORD ARGUMENT]... [ VALUE ])
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1105 @end example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1106
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1107 The @var{value}, if present, is used to initialize the @code{:value}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1108 property and must be an expression of the same type as the widget.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1109 I.e. the string widget can only be initialized with a string.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1110
124
9b50b4588a93 Import from CVS: tag r20-1b15
cvs
parents: 120
diff changeset
1111 All the atom widgets take the same keyword arguments as the
9b50b4588a93 Import from CVS: tag r20-1b15
cvs
parents: 120
diff changeset
1112 @code{editable-field} widget.
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1113
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1114 @deffn Widget string
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1115 Allows you to edit a string in an editable field.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1116 @end deffn
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1117
149
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1118 @deffn Widget regexp
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1119 Allows you to edit a regular expression in an editable field.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1120 @end deffn
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1121
124
9b50b4588a93 Import from CVS: tag r20-1b15
cvs
parents: 120
diff changeset
1122 @deffn Widget character
9b50b4588a93 Import from CVS: tag r20-1b15
cvs
parents: 120
diff changeset
1123 Allows you to enter a character in an editable field.
9b50b4588a93 Import from CVS: tag r20-1b15
cvs
parents: 120
diff changeset
1124 @end deffn
9b50b4588a93 Import from CVS: tag r20-1b15
cvs
parents: 120
diff changeset
1125
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1126 @deffn Widget file
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1127 Allows you to edit a file name in an editable field. You you activate
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1128 the tag button, you can edit the file name in the mini-buffer with
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1129 completion.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1130
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1131 Keywords:
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1132 @table @code
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1133 @item :must-match
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1134 If this is set to non-nil, only existing file names will be allowed in
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1135 the minibuffer.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1136 @end table
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1137 @end deffn
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1138
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1139 @deffn Widget directory
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1140 Allows you to edit a directory name in an editable field.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1141 Similar to the @code{file} widget.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1142 @end deffn
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1143
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1144 @deffn Widget symbol
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1145 Allows you to edit a lisp symbol in an editable field.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1146 @end deffn
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1147
149
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1148 @deffn Widget function
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1149 Allows you to edit a lambda expression, or a function name with completion.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1150 @end deffn
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1151
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1152 @deffn Widget variable
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1153 Allows you to edit a variable name, with completion.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1154 @end deffn
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1155
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1156 @deffn Widget integer
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1157 Allows you to edit an integer in an editable field.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1158 @end deffn
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1159
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1160 @deffn Widget number
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1161 Allows you to edit a number in an editable field.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1162 @end deffn
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1163
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1164 @deffn Widget boolean
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1165 Allows you to edit a boolean. In lisp this means a variable which is
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1166 either nil meaning false, or non-nil meaning true.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1167 @end deffn
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1168
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1169
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1170 @node composite, , atoms, Sexp Types
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1171 @comment node-name, next, previous, up
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1172 @subsection Composite Sexp Widgets.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1173
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1174 The syntax for the composite are
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1175
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1176 @example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1177 TYPE ::= (NAME [KEYWORD ARGUMENT]... COMPONENT...)
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1178 @end example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1179
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1180 Where each @var{component} must be a widget type. Each component widget
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1181 will be displayed in the buffer, and be editable to the user.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1182
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1183 @deffn Widget cons
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1184 The value of a @code{cons} widget is a cons-cell where the car is the
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1185 value of the first component and the cdr is the value of the second
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1186 component. There must be exactly two components.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1187 @end deffn
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1188
149
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1189 @deffn Widget list
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1190 The value of a @code{list} widget is a list containing the value of
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1191 each of its component.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1192 @end deffn
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1193
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1194 @deffn Widget vector
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1195 The value of a @code{vector} widget is a vector containing the value of
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1196 each of its component.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1197 @end deffn
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1198
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1199 The above suffice for specifying fixed size lists and vectors. To get
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1200 variable length lists and vectors, you can use a @code{choice},
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1201 @code{set} or @code{repeat} widgets together with the @code{:inline}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1202 keywords. If any component of a composite widget has the @code{:inline}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1203 keyword set, its value must be a list which will then be spliced into
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1204 the composite. For example, to specify a list whose first element must
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1205 be a file name, and whose remaining arguments should either by the
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1206 symbol @code{t} or two files, you can use the following widget
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1207 specification:
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1208
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1209 @example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1210 (list file
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1211 (choice (const t)
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1212 (list :inline t
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1213 :value ("foo" "bar")
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1214 string string)))
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1215 @end example
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1216
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1217 The value of a widget of this type will either have the form
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1218 @samp{(file t)} or @code{(file string string)}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1219
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1220 This concept of inline is probably hard to understand. It was certainly
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1221 hard to implement so instead of confuse you more by trying to explain it
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1222 here, I'll just suggest you meditate over it for a while.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1223
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1224 @deffn Widget choice
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1225 Allows you to edit a sexp which may have one of fixed set of types. It
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1226 is currently implemented with the @code{choice-menu} basic widget, and
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1227 has a similar syntax.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1228 @end deffn
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1229
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1230 @deffn Widget set
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1231 Allows you to specify a type which must be a list whose elements all
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1232 belong to given set. The elements of the list is not significant. This
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1233 is implemented on top of the @code{checklist} basic widget, and has a
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1234 similar syntax.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1235 @end deffn
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1236
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1237 @deffn Widget repeat
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1238 Allows you to specify a variable length list whose members are all of
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1239 the same type. Implemented on top of the `editable-list' basic widget,
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1240 and has a similar syntax.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1241 @end deffn
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1242
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1243 @node Widget Properties, Defining New Widgets, Sexp Types, Top
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1244 @comment node-name, next, previous, up
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1245 @section Properties
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1246
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1247 You can examine or set the value of a widget by using the widget object
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1248 that was returned by @code{widget-create}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1249
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1250 @defun widget-value widget
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1251 Return the current value contained in @var{widget}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1252 It is an error to call this function on an uninitialized widget.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1253 @end defun
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1254
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1255 @defun widget-value-set widget value
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1256 Set the value contained in @var{widget} to @var{value}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1257 It is an error to call this function with an invalid @var{value}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1258 @end defun
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1259
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1260 @strong{Important:} You @emph{must} call @code{widget-setup} after
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1261 modifying the value of a widget before the user is allowed to edit the
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1262 widget again. It is enough to call @code{widget-setup} once if you
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1263 modify multiple widgets. This is currently only necessary if the widget
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1264 contains an editing field, but may be necessary for other widgets in the
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1265 future.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1266
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1267 If your application needs to associate some information with the widget
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1268 objects, for example a reference to the item being edited, it can be
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1269 done with @code{widget-put} and @code{widget-get}. The property names
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1270 must begin with a @samp{:}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1271
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1272 @defun widget-put widget property value
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1273 In @var{widget} set @var{property} to @var{value}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1274 @var{property} should be a symbol, while @var{value} can be anything.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1275 @end defun
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1276
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1277 @defun widget-get widget property
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1278 In @var{widget} return the value for @var{property}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1279 @var{property} should be a symbol, the value is what was last set by
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1280 @code{widget-put} for @var{property}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1281 @end defun
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1282
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1283 @defun widget-member widget property
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1284 Non-nil if @var{widget} has a value (even nil) for property @var{property}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1285 @end defun
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1286
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1287 Occasionally it can be useful to know which kind of widget you have,
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1288 i.e. the name of the widget type you gave when the widget was created.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1289
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1290 @defun widget-type widget
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1291 Return the name of @var{widget}, a symbol.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1292 @end defun
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1293
116
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1294 Widgets can be in two states: active, which means they are modifiable by
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1295 the user, or inactive, which means they cannot be modified by the user.
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1296 You can query or set the state with the following code:
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1297
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1298 @lisp
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1299 ;; Examine if @var{widget} is active or not.
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1300 (if (widget-apply @var{widget} :active)
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1301 (message "Widget is active.")
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1302 (message "Widget is inactive.")
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1303
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1304 ;; Make @var{widget} inactive.
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1305 (widget-apply @var{widget} :deactivate)
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1306
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1307 ;; Make @var{widget} active.
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1308 (widget-apply @var{widget} :activate)
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1309 @end lisp
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1310
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1311 A widget is inactive if itself, or any of its ancestors (found by
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1312 following the @code{:parent} link) have been deactivated. To make sure
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1313 a widget is really active, you must therefore activate both itself, and
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1314 all its ancestors.
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1315
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1316 @lisp
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1317 (while widget
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1318 (widget-apply widget :activate)
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1319 (setq widget (widget-get widget :parent)))
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1320 @end lisp
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1321
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1322 You can check if a widget has been made inactive by examining the value
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1323 of @code{:inactive} keyword. If this is non-nil, the widget itself has
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1324 been deactivated. This is different from using the @code{:active}
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1325 keyword, in that the later tell you if the widget @strong{or} any of its
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1326 ancestors have been deactivated. Do not attempt to set the
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1327 @code{:inactive} keyword directly. Use the @code{:activate}
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1328 @code{:deactivated} keywords instead.
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1329
9f59509498e1 Import from CVS: tag r20-1b10
cvs
parents: 114
diff changeset
1330
149
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1331 @node Defining New Widgets, Widget Browser, Widget Properties, Top
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1332 @comment node-name, next, previous, up
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1333 @section Defining New Widgets
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1334
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1335 You can define specialized widgets with @code{define-widget}. It allows
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1336 you to create a shorthand for more complex widgets, including specifying
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1337 component widgets and default new default values for the keyword
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1338 arguments.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1339
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1340 @defun widget-define name class doc &rest args
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1341 Define a new widget type named @var{name} from @code{class}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1342
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1343 @var{name} and class should both be symbols, @code{class} should be one
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1344 of the existing widget types.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1345
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1346 The third argument @var{DOC} is a documentation string for the widget.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1347
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1348 After the new widget has been defined, the following two calls will
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1349 create identical widgets:
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1350
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1351 @itemize @bullet
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1352 @item
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1353 @lisp
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1354 (widget-create @var{name})
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1355 @end lisp
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1356
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1357 @item
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1358 @lisp
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1359 (apply widget-create @var{class} @var{args})
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1360 @end lisp
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1361 @end itemize
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1362
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1363 @end defun
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1364
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1365 Using @code{widget-define} does just store the definition of the widget
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1366 type in the @code{widget-type} property of @var{name}, which is what
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1367 @code{widget-create} uses.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1368
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1369 If you just want to specify defaults for keywords with no complex
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1370 conversions, you can use @code{identity} as your conversion function.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1371
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1372 The following additional keyword arguments are useful when defining new
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1373 widgets:
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1374 @table @code
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1375 @item :convert-widget
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1376 Function to convert a widget type before creating a widget of that
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1377 type. It takes a widget type as an argument, and returns the converted
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1378 widget type. When a widget is created, this function is called for the
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1379 widget type and all the widgets parent types, most derived first.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1380
149
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1381 The following predefined functions can be used here:
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1382
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1383 @defun widget-types-convert-widget widget
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1384 Convert @code{:args} as widget types in @var{widget}.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1385 @end defun
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1386
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1387 @defun widget-value-convert-widget widget
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1388 Initialize @code{:value} from @code{:args} in @var{widget}.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1389 @end defun
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1390
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1391 @item :value-to-internal
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1392 Function to convert the value to the internal format. The function
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1393 takes two arguments, a widget and an external value, and returns the
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1394 internal value. The function is called on the present @code{:value}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1395 when the widget is created, and on any value set later with
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1396 @code{widget-value-set}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1397
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1398 @item :value-to-external
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1399 Function to convert the value to the external format. The function
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1400 takes two arguments, a widget and an internal value, and returns the
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1401 internal value. The function is called on the present @code{:value}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1402 when the widget is created, and on any value set later with
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1403 @code{widget-value-set}.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1404
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1405 @item :create
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1406 Function to create a widget from scratch. The function takes one
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1407 argument, a widget type, and create a widget of that type, insert it in
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1408 the buffer, and return a widget object.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1409
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1410 @item :delete
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1411 Function to delete a widget. The function takes one argument, a widget,
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1412 and should remove all traces of the widget from the buffer.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1413
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1414 @item :value-create
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1415 Function to expand the @samp{%v} escape in the format string. It will
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1416 be called with the widget as its argument. Should
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1417 insert a representation of the widgets value in the buffer.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1418
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1419 @item :value-delete
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1420 Should remove the representation of the widgets value from the buffer.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1421 It will be called with the widget as its argument. It doesn't have to
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1422 remove the text, but it should release markers and delete nested widgets
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1423 if such has been used.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1424
149
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1425 The following predefined function can be used here:
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1426
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1427 @defun widget-children-value-delete widget
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1428 Delete all @code{:children} and @code{:buttons} in @var{widget}.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1429 @end defun
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1430
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1431 @item :value-get
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1432 Function to extract the value of a widget, as it is displayed in the
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1433 buffer.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1434
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1435 The following predefined function can be used here:
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1436
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1437 @defun widget-value-value-get widget
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1438 Return the @code{:value} property of @var{widget}.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1439 @end defun
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1440
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1441 @item :format-handler
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1442 Function to handle unknown @samp{%} escapes in the format string. It
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1443 will be called with the widget and the escape character as arguments.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1444 You can set this to allow your widget to handle non-standard escapes.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1445
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1446 You should end up calling @code{widget-default-format-handler} to handle
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1447 unknown escape sequences, which will handle the @samp{%h} and any future
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1448 escape sequences, as well as give an error for unknown escapes.
149
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1449
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1450 @item :action
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1451 Function to handle user initiated events. By default, @code{:notify}
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1452 the parent.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1453
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1454 The following predefined function can be used here:
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1455
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1456 @defun widget-parent-action widget &optional event
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1457 Tell @code{:parent} of @var{widget} to handle the @code{:action}.@br
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1458 Optional @var{event} is the event that triggered the action.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1459 @end defun
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1460
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1461 @item :prompt-value
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1462 Function to prompt for a value in the minibuffer. The function should
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1463 take four arguments, @var{widget}, @var{prompt}, @var{value}, and
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1464 @var{unbound} and should return a value for widget entered by the user.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1465 @var{prompt} is the prompt to use. @var{value} is the default value to
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1466 use, unless @var{unbound} is non-nil in which case there are no default
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1467 value. The function should read the value using the method most natural
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1468 for this widget, and does not have to check that it matches.
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1469 @end table
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1470
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1471 If you want to define a new widget from scratch, use the @code{default}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1472 widget as its base.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1473
149
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1474 @deffn Widget default
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1475 Widget used as a base for other widgets.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1476
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1477 It provides most of the functionality that is referred to as ``by
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1478 default'' in this text.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1479 @end deffn
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1480
149
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1481 @node Widget Browser, Widget Minor Mode, Defining New Widgets, Top
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1482 @comment node-name, next, previous, up
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1483 @section Widget Browser
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1484
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1485 There is a separate package to browse widgets. This is intended to help
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1486 programmers who want to examine the content of a widget. The browser
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1487 shows the value of each keyword, but uses links for certain keywords
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1488 such as `:parent', which avoids printing cyclic structures.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1489
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1490 @deffn Command widget-browse WIDGET
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1491 Create a widget browser for WIDGET.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1492 When called interactively, prompt for WIDGET.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1493 @end deffn
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1494
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1495 @deffn Command widget-browse-other-window WIDGET
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1496 Create a widget browser for WIDGET and show it in another window.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1497 When called interactively, prompt for WIDGET.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1498 @end deffn
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1499
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1500 @deffn Command widget-browse-at POS
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1501 Create a widget browser for the widget at POS.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1502 When called interactively, use the position of point.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1503 @end deffn
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1504
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1505 @node Widget Minor Mode, Utilities, Widget Browser, Top
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1506 @comment node-name, next, previous, up
149
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1507 @section Widget Minor Mode
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1508
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1509 There is a minor mode for manipulating widgets in major modes that
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1510 doesn't provide any support for widgets themselves. This is mostly
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1511 intended to be useful for programmers doing experiments.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1512
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1513 @deffn Command widget-minor-mode
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1514 Togle minor mode for traversing widgets.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1515 With arg, turn widget mode on if and only if arg is positive.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1516 @end deffn
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1517
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1518 @defvar widget-minor-mode-keymap
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1519 Keymap used in @code{widget-minor-mode}.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1520 @end defvar
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1521
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1522 @node Utilities, Widget Wishlist, Widget Minor Mode, Top
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1523 @comment node-name, next, previous, up
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1524 @section Utilities.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1525
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1526 @defun widget-prompt-value widget prompt [ value unbound ]
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1527 Prompt for a value matching @var{widget}, using @var{prompt}.@br
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1528 The current value is assumed to be @var{value}, unless @var{unbound} is
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1529 non-nil.@refill
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1530 @end defun
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1531
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1532 @defun widget-get-sibling widget
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1533 Get the item @var{widget} is assumed to toggle.@br
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1534 This is only meaningful for radio buttons or checkboxes in a list.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1535 @end defun
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1536
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1537 @node Widget Wishlist, , Utilities, Top
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1538 @comment node-name, next, previous, up
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1539 @section Wishlist
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1540
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1541 @itemize @bullet
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1542 @item
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1543 It should be possible to add or remove items from a list with @kbd{C-k}
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1544 and @kbd{C-o} (suggested by @sc{rms}).
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1545
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1546 @item
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1547 The @samp{[INS]} and @samp{[DEL]} buttons should be replaced by a single
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1548 dash (@samp{-}). The dash should be a button that, when activated, ask
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1549 whether you want to add or delete an item (@sc{rms} wanted to git rid of
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1550 the ugly buttons, the dash is my idea).
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1551
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1552 @item
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1553 The @code{menu-choice} tag should be prettier, something like the abbreviated
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1554 menus in Open Look.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1555
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1556 @item
149
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1557 Finish @code{:tab-order}.
136
b980b6286996 Import from CVS: tag r20-2b2
cvs
parents: 134
diff changeset
1558
b980b6286996 Import from CVS: tag r20-2b2
cvs
parents: 134
diff changeset
1559 @item
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1560 Make indentation work with glyphs and propertional fonts.
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1561
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1562 @item
149
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1563 Add commands to show overview of object and class hierarchies to the
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1564 browser.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1565
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1566 @item
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1567 Find a way to disable mouse highlight for inactive widgets.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1568
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1569 @item
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1570 Find a way to make glyphs look inactive.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1571
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1572 @item
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1573 Add @code{property-list} widget.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1574
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1575 @item
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1576 Add @code{association-list} widget.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1577
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1578 @item
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1579 Add @code{key-binding} widget.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1580
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1581 @item
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1582 Add @code{widget} widget for editing widget specifications.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1583
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1584 @item
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1585 Find clean way to implement variable length list.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1586 See @code{TeX-printer-list} for an explanation.
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1587
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1588 @item
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 136
diff changeset
1589 @kbd{C-h} in @code{widget-prompt-value} should give type specific help.
98
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1590
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1591 @end itemize
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1592
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1593 @contents
0d2f883870bc Import from CVS: tag r20-1b1
cvs
parents:
diff changeset
1594 @bye