annotate man/widget.texi @ 30244:bfc202f38a22

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