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