4 @setfilename ../info/widget
5 @settitle The Emacs Widget Library
13 Copyright @copyright{} 2000, 2002, 2003, 2004, 2005,
14 2006 Free Software Foundation, Inc.
17 Permission is granted to copy, distribute and/or modify this document
18 under the terms of the GNU Free Documentation License, Version 1.2 or
19 any later version published by the Free Software Foundation; with the
20 Invariant Sections being ``The GNU Manifesto'', ``Distribution'' and
21 ``GNU GENERAL PUBLIC LICENSE'', with the Front-Cover texts being ``A GNU
22 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
23 license is included in the section entitled ``GNU Free Documentation
24 License'' in the Emacs manual.
26 This document is part of a collection distributed under the GNU Free
27 Documentation License. If you want to distribute this document
28 separately from the collection, you can do so by adding a copy of the
29 license to the document, as described in section 6 of the license.
31 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
32 this GNU Manual, like GNU software. Copies published by the Free
33 Software Foundation raise funds for GNU development.''
39 * Widget: (widget). The "widget" package used by the Emacs Customization
43 @node Top, Introduction, (dir), (dir)
44 @comment node-name, next, previous, up
45 @top The Emacs Widget Library
50 * Programming Example::
51 * Setting Up the Buffer::
55 * Defining New Widgets::
63 @node Introduction, User Interface, Top, Top
64 @comment node-name, next, previous, up
67 Most graphical user interface toolkits provide a number of standard
68 user interface controls (sometimes known as `widgets' or `gadgets').
69 Emacs doesn't really support anything like this, except for an
70 incredibly powerful text ``widget.'' On the other hand, Emacs does
71 provide the necessary primitives to implement many other widgets
72 within a text buffer. The @code{widget} package simplifies this task.
75 @cindex widgets, basic types
76 The basic widgets are:
80 Areas of text with an associated action. Intended for hypertext links
83 Like link, but intended for stand-alone buttons.
85 An editable text field. It can be either variable or fixed length.
87 Allows the user to choose one of multiple options from a menu, each
88 option is itself a widget. Only the selected option will be visible in
90 @item radio-button-choice
91 Allows the user to choose one of multiple options by activating radio
92 buttons. The options are implemented as widgets. All options will be
93 visible in the buffer.
95 A simple constant widget intended to be used in the @code{menu-choice} and
96 @code{radio-button-choice} widgets.
98 A button item only intended for use in choices. When invoked, the user
99 will be asked to select another option from the choice widget.
101 A simple @samp{on}/@samp{off} switch.
103 A checkbox (@samp{[ ]}/@samp{[X]}).
105 Create an editable list. The user can insert or delete items in the
106 list. Each list item is itself a widget.
109 Now, of what possible use can support for widgets be in a text editor?
110 I'm glad you asked. The answer is that widgets are useful for
111 implementing forms. A @dfn{form} in Emacs is a buffer where the user is
112 supposed to fill out a number of fields, each of which has a specific
113 meaning. The user is not supposed to change or delete any of the text
114 between the fields. Examples of forms in Emacs are the @file{forms}
115 package (of course), the customize buffers, the mail and news compose
116 modes, and the @acronym{HTML} form support in the @file{w3} browser.
118 @cindex widget library, why use it
119 The advantages for a programmer of using the @code{widget} package to
124 More complex fields than just editable text are supported.
126 You can give the users immediate feedback if they enter invalid data in a
127 text field, and sometimes prevent entering invalid data.
129 You can have fixed sized fields, thus allowing multiple fields to be
132 It is simple to query or set the value of a field.
134 Editing happens in the buffer, not in the mini-buffer.
136 Packages using the library get a uniform look, making them easier for
139 As support for embedded graphics improve, the widget library will be
140 extended to use the GUI features. This means that your code using the
141 widget library will also use the new graphic features automatically.
144 In order to minimize the code that is loaded by users who do not
145 create any widgets, the code has been split in two files:
147 @cindex widget library, files
150 This will declare the user variables, define the function
151 @code{define-widget}, and autoload the function @code{widget-create}.
153 Everything else is here, there is no reason to load it explicitly, as
154 it will be autoloaded when needed.
157 @node User Interface, Programming Example, Introduction, Top
158 @comment node-name, next, previous, up
159 @section User Interface
161 A form consists of read only text for documentation and some fields,
162 where each field contains two parts, a tag and a value. The tags are
163 used to identify the fields, so the documentation can refer to the
164 @samp{foo field}, meaning the field tagged with @samp{Foo}. Here is an
168 Here is some documentation.
170 Name: @i{My Name} @strong{Choose}: This option
171 Address: @i{Some Place
175 See also @b{_other work_} for more information.
177 Numbers: count to three below
178 @b{[INS]} @b{[DEL]} @i{One}
179 @b{[INS]} @b{[DEL]} @i{Eh, two?}
180 @b{[INS]} @b{[DEL]} @i{Five!}
195 @b{[Apply Form]} @b{[Reset Form]}
198 The top level widgets in this example are tagged @samp{Name},
199 @samp{Choose}, @samp{Address}, @samp{_other work_}, @samp{Numbers},
200 @samp{Select multiple}, @samp{Select one}, @samp{[Apply Form]}, and
201 @samp{[Reset Form]}. There are basically two things the user can do
202 within a form, namely editing the editable text fields and activating
205 @subsection Editable Text Fields
207 In the example, the value for the @samp{Name} is most likely displayed
208 in an editable text field, and so are values for each of the members of
209 the @samp{Numbers} list. All the normal Emacs editing operations are
210 available for editing these fields. The only restriction is that each
211 change you make must be contained within a single editable text field.
212 For example, capitalizing all text from the middle of one field to the
213 middle of another field is prohibited.
215 Editable text fields are created by the @code{editable-field} widget.
217 @strong{Warning:} In an @code{editable-field} widget, the editable
218 field must not be adjacent to another widget---that won't work.
219 You must put some text in between. Either make this text part of
220 the @code{editable-field} widget itself, or insert it with
221 @code{widget-insert}.
223 The @code{:format} keyword is useful for generating the necessary
224 text; for instance, if you give it a value of @code{"Name: %v "},
225 the @samp{Name: } part will provide the necessary separating text
226 before the field and the trailing space will provide the
227 separating text after the field. If you don't include the
228 @code{:size} keyword, the field will extend to the end of the
229 line, and the terminating newline will provide separation after.
231 The editing text fields are highlighted with the
232 @code{widget-field-face} face, making them easy to find.
234 @deffn Face widget-field-face
235 Face used for other editing fields.
240 @cindex widget buttons
241 @cindex button widgets
242 Some portions of the buffer have an associated @dfn{action}, which can
243 be @dfn{invoked} by a standard key or mouse command. These portions
244 are called @dfn{buttons}. The default commands for activating a button
249 @deffn Command widget-button-press @var{pos} &optional @var{event}
250 Invoke the button at @var{pos}, defaulting to point.
251 If point is not located on a button, invoke the binding in
252 @code{widget-global-map} (by default the global map).
255 @kindex Mouse-2 @r{(on button widgets})
257 @deffn Command widget-button-click @var{event}
258 Invoke the button at the location of the mouse pointer. If the mouse
259 pointer is located in an editable text field, invoke the binding in
260 @code{widget-global-map} (by default the global map).
264 There are several different kind of buttons, all of which are present in
268 @cindex option field tag
269 @item The Option Field Tags
270 When you invoke one of these buttons, you will be asked to choose
271 between a number of different options. This is how you edit an option
272 field. Option fields are created by the @code{menu-choice} widget. In
273 the example, @samp{@b{Choose}} is an option field tag.
274 @item The @samp{@b{[INS]}} and @samp{@b{[DEL]}} buttons
275 Activating these will insert or delete elements from an editable list.
276 The list is created by the @code{editable-list} widget.
277 @cindex embedded buttons
278 @item Embedded Buttons
279 The @samp{@b{_other work_}} is an example of an embedded
280 button. Embedded buttons are not associated with any fields, but can serve
281 any purpose, such as implementing hypertext references. They are
282 usually created by the @code{link} widget.
283 @item The @samp{@b{[ ]}} and @samp{@b{[X]}} buttons
284 Activating one of these will convert it to the other. This is useful
285 for implementing multiple-choice fields. You can create them with the
286 @code{checkbox} widget.
287 @item The @samp{@b{( )}} and @samp{@b{(*)}} buttons
288 Only one radio button in a @code{radio-button-choice} widget can be
289 selected at any time. When you invoke one of the unselected radio
290 buttons, it will be selected and the previous selected radio button will
292 @item The @samp{@b{[Apply Form]}} and @samp{@b{[Reset Form]}} buttons
293 These are explicit buttons made with the @code{push-button} widget. The
294 main difference from the @code{link} widget is that the buttons will be
295 displayed as GUI buttons when possible.
298 To make them easier to locate, buttons are emphasized in the buffer.
300 @deffn Face widget-button-face
301 Face used for buttons.
304 @defopt widget-mouse-face
305 Face used for highlighting a button when the mouse pointer moves across
309 @subsection Navigation
311 You can use all the normal Emacs commands to move around in a form
312 buffer, plus you will have these additional commands:
316 @deffn Command widget-forward &optional count
317 Move point @var{count} buttons or editing fields forward.
319 @item @kbd{M-@key{TAB}}
320 @itemx @kbd{S-@key{TAB}}
321 @deffn Command widget-backward &optional count
322 Move point @var{count} buttons or editing fields backward.
326 @node Programming Example, Setting Up the Buffer, User Interface, Top
327 @comment node-name, next, previous, up
328 @section Programming Example
330 @cindex widgets, programming example
331 @cindex example of using widgets
332 Here is the code to implement the user interface example (@pxref{User
341 (defvar widget-example-repeat)
343 (defun widget-example ()
344 "Create the widgets from the Widget manual."
346 (switch-to-buffer "*Widget Example*")
347 (kill-all-local-variables)
348 (make-local-variable 'widget-example-repeat)
349 (let ((inhibit-read-only t))
352 (widget-insert "Here is some documentation.\n\nName: ")
353 (widget-create 'editable-field
355 :format "%v " ; Text after the field!
357 (widget-create 'menu-choice
360 :help-echo "Choose me, please!"
361 :notify (lambda (widget &rest ignore)
362 (message "%s is a good choice!"
363 (widget-value widget)))
364 '(item :tag "This option" :value "This")
365 '(choice-item "That option")
366 '(editable-field :menu-tag "No option" "Thus option"))
367 (widget-insert "Address: ")
368 (widget-create 'editable-field
369 "Some Place\nIn some City\nSome country.")
370 (widget-insert "\nSee also ")
372 :notify (lambda (&rest ignore)
373 (widget-value-set widget-example-repeat
378 " for more information.\n\nNumbers: count to three below\n")
379 (setq widget-example-repeat
380 (widget-create 'editable-list
381 :entry-format "%i %d %v"
382 :notify (lambda (widget &rest ignore)
383 (let ((old (widget-get widget
385 (new (length (widget-value widget))))
387 (widget-put widget ':example-length new)
388 (message "You can count to %d." new))))
389 :value '("One" "Eh, two?" "Five!")
390 '(editable-field :value "three")))
391 (widget-insert "\n\nSelect multiple:\n\n")
392 (widget-create 'checkbox t)
393 (widget-insert " This\n")
394 (widget-create 'checkbox nil)
395 (widget-insert " That\n")
396 (widget-create 'checkbox
397 :notify (lambda (&rest ignore) (message "Tickle"))
399 (widget-insert " Thus\n\nSelect one:\n\n")
400 (widget-create 'radio-button-choice
402 :notify (lambda (widget &rest ignore)
403 (message "You selected %s"
404 (widget-value widget)))
405 '(item "One") '(item "Another One.") '(item "A Final One."))
407 (widget-create 'push-button
408 :notify (lambda (&rest ignore)
409 (if (= (length (widget-value widget-example-repeat))
411 (message "Congratulation!")
412 (error "Three was the count!")))
415 (widget-create 'push-button
416 :notify (lambda (&rest ignore)
420 (use-local-map widget-keymap)
424 @node Setting Up the Buffer, Basic Types, Programming Example, Top
425 @comment node-name, next, previous, up
426 @section Setting Up the Buffer
428 Widgets are created with @code{widget-create}, which returns a
429 @dfn{widget} object. This object can be queried and manipulated by
430 other widget functions, until it is deleted with @code{widget-delete}.
431 After the widgets have been created, @code{widget-setup} must be called
434 @defun widget-create type [ keyword argument ]@dots{}
435 Create and return a widget of type @var{type}.
436 The syntax for the @var{type} argument is described in @ref{Basic Types}.
438 The keyword arguments can be used to overwrite the keyword arguments
439 that are part of @var{type}.
442 @defun widget-delete widget
443 Delete @var{widget} and remove it from the buffer.
447 Set up a buffer to support widgets.
449 This should be called after creating all the widgets and before allowing
450 the user to edit them.
454 If you want to insert text outside the widgets in the form, the
455 recommended way to do that is with @code{widget-insert}.
458 Insert the arguments, either strings or characters, at point.
459 The inserted text will be read-only.
462 There is a standard widget keymap which you might find useful.
464 @findex widget-button-press
465 @findex widget-button-click
466 @defvr Const widget-keymap
467 A keymap with the global keymap as its parent.@*
468 @key{TAB} and @kbd{C-@key{TAB}} are bound to @code{widget-forward} and
469 @code{widget-backward}, respectively. @key{RET} and @kbd{Mouse-2}
470 are bound to @code{widget-button-press} and
471 @code{widget-button-click}.@refill
474 @defvar widget-global-map
475 Keymap used by @code{widget-button-press} and @code{widget-button-click}
476 when not on a button. By default this is @code{global-map}.
479 @node Basic Types, Sexp Types, Setting Up the Buffer, Top
480 @comment node-name, next, previous, up
483 This is the general syntax of a type specification:
486 @var{name} ::= (@var{name} [@var{keyword} @var{argument}]... @var{args})
490 Where, @var{name} is a widget name, @var{keyword} is the name of a
491 property, @var{argument} is the value of the property, and @var{args}
492 are interpreted in a widget specific way.
494 @cindex keyword arguments
495 The following keyword arguments apply to all widgets:
498 @vindex value@r{ keyword}
500 The initial value for widgets of this type.
502 @vindex format@r{ keyword}
504 This string will be inserted in the buffer when you create a widget.
505 The following @samp{%} escapes are available:
510 The text inside will be marked as a button.
512 By default, the text will be shown in @code{widget-button-face}, and
513 surrounded by brackets.
515 @defopt widget-button-prefix
516 String to prefix buttons.
519 @defopt widget-button-suffix
520 String to suffix buttons.
525 The text inside will be displayed with the face specified by
529 This will be replaced with the buffer representation of the widget's
530 value. What this is depends on the widget type.
533 Insert the string specified by @code{:doc} here.
536 Like @samp{%d}, with the following modifications: If the documentation
537 string is more than one line, it will add a button which will toggle
538 between showing only the first line, and showing the full text.
539 Furthermore, if there is no @code{:doc} property in the widget, it will
540 instead examine the @code{:documentation-property} property. If it is a
541 lambda expression, it will be called with the widget's value as an
542 argument, and the result will be used as the documentation text.
545 Insert the string specified by @code{:tag} here, or the @code{princ}
546 representation of the value if there is no tag.
549 Insert a literal @samp{%}.
552 @vindex button-face@r{ keyword}
554 Face used to highlight text inside %[ %] in the format.
556 @vindex button-prefix@r{ keyword}
557 @vindex button-suffix@r{ keyword}
559 @itemx :button-suffix
560 Text around %[ %] in the format.
568 The string is inserted literally.
571 The value of the symbol is expanded according to this table.
574 @vindex doc@r{ keyword}
576 The string inserted by the @samp{%d} escape in the format
579 @vindex tag@r{ keyword}
581 The string inserted by the @samp{%t} escape in the format
584 @vindex tag-glyph@r{ keyword}
586 Name of image to use instead of the string specified by @code{:tag} on
587 Emacsen that supports it.
589 @vindex help-echo@r{ keyword}
591 Specifies how to display a message whenever you move to the widget with
592 either @code{widget-forward} or @code{widget-backward} or move the mouse
593 over it (using the standard @code{help-echo} mechanism). The argument
594 is either a string to display, a function of one argument, the widget,
595 which should return a string to display, or a form that evaluates to
598 @vindex follow-link@r{ keyword}
600 Specifies how to interpret a @key{mouse-1} click on the widget.
601 @xref{Links and Mouse-1,,, elisp, the Emacs Lisp Reference Manual}.
603 @vindex indent@r{ keyword}
605 An integer indicating the absolute number of spaces to indent children
608 @vindex offset@r{ keyword}
610 An integer indicating how many extra spaces to add to the widget's
611 grandchildren compared to this widget.
613 @vindex extra-offset@r{ keyword}
615 An integer indicating how many extra spaces to add to the widget's
616 children compared to this widget.
618 @vindex notify@r{ keyword}
620 A function called each time the widget or a nested widget is changed.
621 The function is called with two or three arguments. The first argument
622 is the widget itself, the second argument is the widget that was
623 changed, and the third argument is the event leading to the change, if
626 @vindex menu-tag@r{ keyword}
628 Tag used in the menu when the widget is used as an option in a
629 @code{menu-choice} widget.
631 @vindex menu-tag-get@r{ keyword}
633 Function used for finding the tag when the widget is used as an option
634 in a @code{menu-choice} widget. By default, the tag used will be either the
635 @code{:menu-tag} or @code{:tag} property if present, or the @code{princ}
636 representation of the @code{:value} property if not.
638 @vindex match@r{ keyword}
640 Should be a function called with two arguments, the widget and a value,
641 and returning non-@code{nil} if the widget can represent the specified value.
643 @vindex validate@r{ keyword}
645 A function which takes a widget as an argument, and returns @code{nil}
646 if the widget's current value is valid for the widget. Otherwise it
647 should return the widget containing the invalid data, and set that
648 widget's @code{:error} property to a string explaining the error.
650 The following predefined function can be used:
652 @defun widget-children-validate widget
653 All the @code{:children} of @var{widget} must be valid.
656 @vindex tab-order@r{ keyword}
658 Specify the order in which widgets are traversed with
659 @code{widget-forward} or @code{widget-backward}. This is only partially
664 Widgets with tabbing order @code{-1} are ignored.
667 (Unimplemented) When on a widget with tabbing order @var{n}, go to the
668 next widget in the buffer with tabbing order @var{n+1} or @code{nil},
669 whichever comes first.
672 When on a widget with no tabbing order specified, go to the next widget
673 in the buffer with a positive tabbing order, or @code{nil}
676 @vindex parent@r{ keyword}
678 The parent of a nested widget (e.g.@: a @code{menu-choice} item or an
679 element of a @code{editable-list} widget).
681 @vindex sibling-args@r{ keyword}
683 This keyword is only used for members of a @code{radio-button-choice} or
684 @code{checklist}. The value should be a list of extra keyword
685 arguments, which will be used when creating the @code{radio-button} or
686 @code{checkbox} associated with this item.
690 @deffn {User Option} widget-glyph-directory
691 Directory where glyphs are found.
692 Widget will look here for a file with the same name as specified for the
693 image, with either a @file{.xpm} (if supported) or @file{.xbm} extension.
696 @deffn{User Option} widget-glyph-enable
697 If non-@code{nil}, allow glyphs to appear on displays where they are supported.
709 * radio-button-choice::
719 @node link, url-link, Basic Types, Basic Types
720 @comment node-name, next, previous, up
721 @subsection The @code{link} Widget
722 @findex link@r{ widget}
727 @var{type} ::= (link [@var{keyword} @var{argument}]... [ @var{value} ])
730 The @var{value}, if present, is used to initialize the @code{:value}
731 property. The value should be a string, which will be inserted in the
734 By default the link will be shown in brackets.
736 @defopt widget-link-prefix
737 String to prefix links.
740 @defopt widget-link-suffix
741 String to suffix links.
744 @node url-link, info-link, link, Basic Types
745 @comment node-name, next, previous, up
746 @subsection The @code{url-link} Widget
747 @findex url-link@r{ widget}
752 @var{type} ::= (url-link [@var{keyword} @var{argument}]... @var{url})
755 @findex browse-url-browser-function@r{, and @code{url-link} widget}
756 When this link is invoked, the @acronym{WWW} browser specified by
757 @code{browse-url-browser-function} will be called with @var{url}.
759 @node info-link, push-button, url-link, Basic Types
760 @comment node-name, next, previous, up
761 @subsection The @code{info-link} Widget
762 @findex info-link@r{ widget}
767 @var{type} ::= (info-link [@var{keyword} @var{argument}]... @var{address})
770 When this link is invoked, the built-in Info reader is started on
773 @node push-button, editable-field, info-link, Basic Types
774 @comment node-name, next, previous, up
775 @subsection The @code{push-button} Widget
776 @findex push-button@r{ widget}
781 @var{type} ::= (push-button [@var{keyword} @var{argument}]... [ @var{value} ])
784 The @var{value}, if present, is used to initialize the @code{:value}
785 property. The value should be a string, which will be inserted in the
788 By default the tag will be shown in brackets.
790 @defopt widget-push-button-prefix
791 String to prefix push buttons.
794 @defopt widget-push-button-suffix
795 String to suffix push buttons.
798 @node editable-field, text, push-button, Basic Types
799 @comment node-name, next, previous, up
800 @subsection The @code{editable-field} Widget
801 @findex editable-field@r{ widget}
806 @var{type} ::= (editable-field [@var{keyword} @var{argument}]... [ @var{value} ])
809 The @var{value}, if present, is used to initialize the @code{:value}
810 property. The value should be a string, which will be inserted in the
811 field. This widget will match all string values.
813 The following extra properties are recognized:
816 @vindex size@r{ keyword}
818 The width of the editable field.@*
819 By default the field will reach to the end of the line.
821 @vindex value-face@r{ keyword}
823 Face used for highlighting the editable field. Default is
824 @code{widget-field-face}, see @ref{User Interface}.
826 @vindex secret@r{ keyword}
828 Character used to display the value. You can set this to e.g.@: @code{?*}
829 if the field contains a password or other secret information. By
830 default, this is @code{nil}, and the value is not secret.
832 @vindex valid-regexp@r{ keyword}
834 By default the @code{:validate} function will match the content of the
835 field with the value of this attribute. The default value is @code{""}
836 which matches everything.
838 @vindex keymap@r{ keyword}
839 @vindex widget-field-keymap
841 Keymap used in the editable field. The default value is
842 @code{widget-field-keymap}, which allows you to use all the normal
843 editing commands, even if the buffer's major mode suppresses some of
844 them. Pressing @key{RET} invokes the function specified by
848 @node text, menu-choice, editable-field, Basic Types
849 @comment node-name, next, previous, up
850 @subsection The @code{text} Widget
851 @findex text@r{ widget}
853 @vindex widget-text-keymap
854 This is just like @code{editable-field}, but intended for multiline text
855 fields. The default @code{:keymap} is @code{widget-text-keymap}, which
856 does not rebind the @key{RET} key.
858 @node menu-choice, radio-button-choice, text, Basic Types
859 @comment node-name, next, previous, up
860 @subsection The @code{menu-choice} Widget
861 @findex menu-choice@r{ widget}
866 @var{type} ::= (menu-choice [@var{keyword} @var{argument}]... @var{type} ... )
869 The @var{type} argument represents each possible choice. The widget's
870 value will be that of the chosen @var{type} argument. This widget will
871 match any value matching at least one of the specified @var{type}
875 @vindex void@r{ keyword}
877 Widget type used as a fallback when the value does not match any of the
878 specified @var{type} arguments.
880 @vindex case-fold@r{ keyword}
882 Set this to @code{nil} if you don't want to ignore case when prompting for a
883 choice through the minibuffer.
885 @vindex children@r{ keyword}
887 A list whose @sc{car} is the widget representing the currently chosen
890 @vindex choice@r{ keyword}
892 The current chosen type.
894 @vindex args@r{ keyword}
899 @node radio-button-choice, item, menu-choice, Basic Types
900 @comment node-name, next, previous, up
901 @subsection The @code{radio-button-choice} Widget
902 @findex radio-button-choice@r{ widget}
907 @var{type} ::= (radio-button-choice [@var{keyword} @var{argument}]... @var{type} ... )
910 The component types specify the choices, with one radio button for
911 each. The widget's value will be that of the chosen @var{type}
912 argument. This widget matches any value that matches at least one of
913 the specified @var{type} arguments.
915 The following extra properties are recognized.
918 @vindex entry-format@r{ keyword}
920 This string will be inserted for each entry in the list.
921 The following @samp{%} escapes are available:
924 Replace with the buffer representation of the @var{type} widget.
926 Replace with the radio button.
928 Insert a literal @samp{%}.
931 @vindex button-args@r{ keyword}
933 A list of keywords to pass to the radio buttons. Useful for setting
934 e.g.@: the @samp{:help-echo} for each button.
936 @vindex buttons@r{ keyword}
938 The widgets representing the radio buttons.
940 @vindex children@r{ keyword}
942 The widgets representing each type.
944 @vindex choice@r{ keyword}
946 The current chosen type
948 @vindex args@r{ keyword}
953 You can add extra radio button items to a @code{radio-button-choice}
954 widget after it has been created with the function
955 @code{widget-radio-add-item}.
957 @defun widget-radio-add-item widget type
958 Add to @code{radio-button-choice} widget @var{widget} a new radio button
959 item of type @var{type}.
962 Please note that such items added after the @code{radio-button-choice}
963 widget has been created will @strong{not} be properly destructed when
964 you call @code{widget-delete}.
966 @node item, choice-item, radio-button-choice, Basic Types
967 @comment node-name, next, previous, up
968 @subsection The @code{item} Widget
969 @findex item@r{ widget}
974 @var{item} ::= (item [@var{keyword} @var{argument}]... @var{value})
977 The @var{value}, if present, is used to initialize the @code{:value}
978 property. The value should be a string, which will be inserted in the
979 buffer. This widget will only match the specified value.
981 @node choice-item, toggle, item, Basic Types
982 @comment node-name, next, previous, up
983 @subsection The @code{choice-item} Widget
984 @findex choice-item@r{ widget}
989 @var{item} ::= (choice-item [@var{keyword} @var{argument}]... @var{value})
992 The @var{value}, if present, is used to initialize the @code{:value}
993 property. The value should be a string, which will be inserted in the
994 buffer as a button. Activating the button of a @code{choice-item} is
995 equivalent to activating the parent widget. This widget will only match
998 @node toggle, checkbox, choice-item, Basic Types
999 @comment node-name, next, previous, up
1000 @subsection The @code{toggle} Widget
1001 @findex toggle@r{ widget}
1006 @var{type} ::= (toggle [@var{keyword} @var{argument}]...)
1009 The widget has two possible states, @samp{on} and @samp{off}, which
1010 correspond to a @code{t} or @code{nil} value, respectively.
1012 The following extra properties are recognized:
1016 A string representing the @samp{on} state. By default the string
1019 A string representing the @samp{off} state. By default the string
1021 @vindex on-glyph@r{ keyword}
1023 Name of a glyph to be used instead of the @samp{:on} text string, on
1024 emacsen that supports this.
1025 @vindex off-glyph@r{ keyword}
1027 Name of a glyph to be used instead of the @samp{:off} text string, on
1028 emacsen that supports this.
1031 @node checkbox, checklist, toggle, Basic Types
1032 @comment node-name, next, previous, up
1033 @subsection The @code{checkbox} Widget
1034 @findex checkbox@r{ widget}
1036 This widget has two possible states, @samp{selected} and
1037 @samp{unselected}, which corresponds to a @code{t} or @code{nil} value.
1042 @var{type} ::= (checkbox [@var{keyword} @var{argument}]...)
1045 @node checklist, editable-list, checkbox, Basic Types
1046 @comment node-name, next, previous, up
1047 @subsection The @code{checklist} Widget
1048 @findex checklist@r{ widget}
1053 @var{type} ::= (checklist [@var{keyword} @var{argument}]... @var{type} ... )
1056 The @var{type} arguments represent each checklist item. The widget's
1057 value will be a list containing the values of all checked @var{type}
1058 arguments. The checklist widget will match a list whose elements all
1059 match at least one of the specified @var{type} arguments.
1061 The following extra properties are recognized:
1064 @vindex entry-format@r{ keyword}
1066 This string will be inserted for each entry in the list.
1067 The following @samp{%} escapes are available:
1070 Replaced with the buffer representation of the @var{type} widget.
1072 Replace with the checkbox.
1074 Insert a literal @samp{%}.
1077 @vindex greedy@r{ keyword}
1079 Usually a checklist will only match if the items are in the exact
1080 sequence given in the specification. By setting @code{:greedy} to
1081 non-@code{nil}, it will allow the items to come in any sequence.
1082 However, if you extract the value they will be in the sequence given
1083 in the checklist, i.e.@: the original sequence is forgotten.
1085 @vindex button-args@r{ keyword}
1087 A list of keywords to pass to the checkboxes. Useful for setting
1088 e.g.@: the @samp{:help-echo} for each checkbox.
1090 @vindex buttons@r{ keyword}
1092 The widgets representing the checkboxes.
1094 @vindex children@r{ keyword}
1096 The widgets representing each type.
1098 @vindex args@r{ keyword}
1103 @node editable-list, group, checklist, Basic Types
1104 @comment node-name, next, previous, up
1105 @subsection The @code{editable-list} Widget
1106 @findex editable-list@r{ widget}
1111 @var{type} ::= (editable-list [@var{keyword} @var{argument}]... @var{type})
1114 The value is a list, where each member represents one widget of type
1117 The following extra properties are recognized:
1120 @vindex entry-format@r{ keyword}
1122 This string will be inserted for each entry in the list.
1123 The following @samp{%} escapes are available:
1126 This will be replaced with the buffer representation of the @var{type}
1129 Insert the @b{[INS]} button.
1131 Insert the @b{[DEL]} button.
1133 Insert a literal @samp{%}.
1136 @vindex insert-button-args@r{ keyword}
1137 @item :insert-button-args
1138 A list of keyword arguments to pass to the insert buttons.
1140 @vindex delete-button-args@r{ keyword}
1141 @item :delete-button-args
1142 A list of keyword arguments to pass to the delete buttons.
1144 @vindex append-button-args@r{ keyword}
1145 @item :append-button-args
1146 A list of keyword arguments to pass to the trailing insert button.
1148 @vindex buttons@r{ keyword}
1150 The widgets representing the insert and delete buttons.
1152 @vindex children@r{ keyword}
1154 The widgets representing the elements of the list.
1156 @vindex args@r{ keyword}
1158 List whose @sc{car} is the type of the list elements.
1161 @node group, , editable-list, Basic Types
1162 @comment node-name, next, previous, up
1163 @subsection The @code{group} Widget
1164 @findex group@r{ widget}
1166 This widget simply group other widgets together.
1171 @var{type} ::= (group [@var{keyword} @var{argument}]... @var{type}...)
1174 The value is a list, with one member for each @var{type}.
1176 @node Sexp Types, Widget Properties, Basic Types, Top
1181 A number of widgets for editing @dfn{s-expressions} (Lisp types), sexp
1182 for short, are also available. These basically fall in several
1183 categories described in this section.
1192 @node constants, generic, Sexp Types, Sexp Types
1193 @comment node-name, next, previous, up
1194 @subsection The Constant Widgets
1195 @cindex constant widgets
1197 The @code{const} widget can contain any Lisp expression, but the user is
1198 prohibited from editing it, which is mainly useful as a component of one
1199 of the composite widgets.
1201 The syntax for the @code{const} widget is:
1204 @var{type} ::= (const [@var{keyword} @var{argument}]... [ @var{value} ])
1207 The @var{value}, if present, is used to initialize the @code{:value}
1208 property and can be any s-expression.
1211 This will display any valid s-expression in an immutable part of the
1215 There are two variations of the @code{const} widget, namely
1216 @code{variable-item} and @code{function-item}. These should contain a
1217 symbol with a variable or function binding. The major difference from
1218 the @code{const} widget is that they will allow the user to see the
1219 variable or function documentation for the symbol.
1221 @deffn Widget variable-item
1222 An immutable symbol that is bound as a variable.
1225 @deffn Widget function-item
1226 An immutable symbol that is bound as a function.
1229 @node generic, atoms, constants, Sexp Types
1230 @comment node-name, next, previous, up
1231 @subsection Generic Sexp Widget
1232 @cindex generic sexp widget
1234 The @code{sexp} widget can contain any Lisp expression, and allows the
1235 user to edit it inline in the buffer.
1237 The syntax for the @code{sexp} widget is:
1240 @var{type} ::= (sexp [@var{keyword} @var{argument}]... [ @var{value} ])
1244 This will allow you to edit any valid s-expression in an editable buffer
1247 The @code{sexp} widget takes the same keyword arguments as the
1248 @code{editable-field} widget. @xref{editable-field}.
1251 @node atoms, composite, generic, Sexp Types
1252 @comment node-name, next, previous, up
1253 @subsection Atomic Sexp Widgets
1254 @cindex atomic sexp widget
1256 The atoms are s-expressions that do not consist of other s-expressions.
1257 For example, a string, a file name, or a symbol are atoms, while a list
1258 is a composite type. You can edit the value of an atom with the
1261 The syntax for all the atoms are:
1264 @var{type} ::= (@var{construct} [@var{keyword} @var{argument}]... [ @var{value} ])
1267 The @var{value}, if present, is used to initialize the @code{:value}
1268 property and must be an expression of the same type as the widget.
1269 That is, the string widget can only be initialized with a string.
1271 All the atom widgets take the same keyword arguments as the
1272 @code{editable-field} widget. @xref{editable-field}.
1274 @deffn Widget string
1275 Allows you to edit a string in an editable field.
1278 @deffn Widget regexp
1279 Allows you to edit a regular expression in an editable field.
1282 @deffn Widget character
1283 Allows you to enter a character in an editable field.
1287 Allows you to edit a file name in an editable field.
1291 @vindex must-match@r{ keyword}
1293 If this is set to non-@code{nil}, only existing file names will be
1294 allowed in the minibuffer.
1298 @deffn Widget directory
1299 Allows you to edit a directory name in an editable field.
1300 Similar to the @code{file} widget.
1303 @deffn Widget symbol
1304 Allows you to edit a Lisp symbol in an editable field.
1307 @deffn Widget function
1308 Allows you to edit a lambda expression, or a function name with completion.
1311 @deffn Widget variable
1312 Allows you to edit a variable name, with completion.
1315 @deffn Widget integer
1316 Allows you to edit an integer in an editable field.
1319 @deffn Widget number
1320 Allows you to edit a number in an editable field.
1323 @deffn Widget boolean
1324 Allows you to edit a boolean. In Lisp this means a variable which is
1325 either @code{nil} meaning false, or non-@code{nil} meaning true.
1329 @node composite, , atoms, Sexp Types
1330 @comment node-name, next, previous, up
1331 @subsection Composite Sexp Widgets
1332 @cindex composite sexp widgets
1334 The syntax for the composite widget construct is:
1337 @var{type} ::= (@var{construct} [@var{keyword} @var{argument}]... @var{component}...)
1341 where each @var{component} must be a widget type. Each component widget
1342 will be displayed in the buffer, and will be editable by the user.
1345 The value of a @code{cons} widget must be a cons-cell whose @sc{car}
1346 and @sc{cdr} have two specified types. It uses this syntax:
1349 @var{type} ::= (cons [@var{keyword} @var{argument}]... @var{car-type} @var{cdr-type})
1353 @deffn Widget choice
1354 The value matched by a @code{choice} widget must have one of a fixed
1355 set of types. The widget's syntax is as follows:
1358 @var{type} ::= (choice [@var{keyword} @var{argument}]... @var{type} ... )
1361 The value of a @code{choice} widget can be anything that matches any of the
1366 The value of a @code{list} widget must be a list whose element types
1367 match the specified component types:
1370 @var{type} ::= (list [@var{keyword} @var{argument}]... @var{component-type}...)
1373 Thus, @code{(list string number)} matches lists of two elements,
1374 the first being a string and the second being a number.
1377 @deffn Widget vector
1378 The @code{vector} widget is like the @code{list} widget but matches
1379 vectors instead of lists. Thus, @code{(vector string number)} matches
1380 vectors of two elements, the first being a string and the second being
1384 The above suffice for specifying fixed size lists and vectors. To get
1385 variable length lists and vectors, you can use a @code{choice},
1386 @code{set}, or @code{repeat} widget together with the @code{:inline}
1387 keyword. If any component of a composite widget has the
1388 @code{:inline} keyword set, its value must be a list which will then
1389 be spliced into the composite. For example, to specify a list whose
1390 first element must be a file name, and whose remaining elements should
1391 either be the symbol @code{t} or two strings (file names), you can use
1392 the following widget specification:
1398 :value ("foo" "bar")
1402 The value of a widget of this type will either have the form
1403 @code{(file t)} or @code{(file @var{string} @var{string})}.
1405 This concept of @code{:inline} may be hard to understand. It was
1406 certainly hard to implement, so instead of confusing you more by
1407 trying to explain it here, I'll just suggest you meditate over it for
1411 Specifies a type whose values are the lists whose elements all belong
1412 to a given set. The order of elements of the list is not significant.
1416 @var{type} ::= (set [@var{keyword} @var{argument}]... @var{permitted-element} ... )
1419 Use @code{const} to specify each permitted element, like this:
1420 @code{(set (const a) (const b))}.
1423 @deffn Widget repeat
1424 Specifies a list of any number of elements that fit a certain type.
1427 @var{type} ::= (repeat [@var{keyword} @var{argument}]... @var{type})
1431 @node Widget Properties, Defining New Widgets, Sexp Types, Top
1432 @comment node-name, next, previous, up
1434 @cindex properties of widgets
1435 @cindex widget properties
1437 You can examine or set the value of a widget by using the widget object
1438 that was returned by @code{widget-create}.
1440 @defun widget-value widget
1441 Return the current value contained in @var{widget}.
1442 It is an error to call this function on an uninitialized widget.
1445 @defun widget-value-set widget value
1446 Set the value contained in @var{widget} to @var{value}.
1447 It is an error to call this function with an invalid @var{value}.
1450 @strong{Important:} You @emph{must} call @code{widget-setup} after
1451 modifying the value of a widget before the user is allowed to edit the
1452 widget again. It is enough to call @code{widget-setup} once if you
1453 modify multiple widgets. This is currently only necessary if the widget
1454 contains an editing field, but may be necessary for other widgets in the
1457 If your application needs to associate some information with the widget
1458 objects, for example a reference to the item being edited, it can be
1459 done with @code{widget-put} and @code{widget-get}. The property names
1460 must begin with a @samp{:}.
1462 @defun widget-put widget property value
1463 In @var{widget} set @var{property} to @var{value}.
1464 @var{property} should be a symbol, while @var{value} can be anything.
1467 @defun widget-get widget property
1468 In @var{widget} return the value for @var{property}.
1469 @var{property} should be a symbol, the value is what was last set by
1470 @code{widget-put} for @var{property}.
1473 @defun widget-member widget property
1474 Non-@code{nil} if @var{widget} has a value (even @code{nil}) for
1475 property @var{property}.
1478 Occasionally it can be useful to know which kind of widget you have,
1479 i.e.@: the name of the widget type you gave when the widget was created.
1481 @defun widget-type widget
1482 Return the name of @var{widget}, a symbol.
1485 @cindex active widget
1486 @cindex inactive widget
1487 @cindex activate a widget
1488 @cindex deactivate a widget
1489 Widgets can be in two states: active, which means they are modifiable by
1490 the user, or inactive, which means they cannot be modified by the user.
1491 You can query or set the state with the following code:
1494 ;; Examine if @var{widget} is active or not.
1495 (if (widget-apply @var{widget} :active)
1496 (message "Widget is active.")
1497 (message "Widget is inactive.")
1499 ;; Make @var{widget} inactive.
1500 (widget-apply @var{widget} :deactivate)
1502 ;; Make @var{widget} active.
1503 (widget-apply @var{widget} :activate)
1506 A widget is inactive if it, or any of its ancestors (found by
1507 following the @code{:parent} link), have been deactivated. To make sure
1508 a widget is really active, you must therefore activate both it and
1513 (widget-apply widget :activate)
1514 (setq widget (widget-get widget :parent)))
1517 You can check if a widget has been made inactive by examining the value
1518 of the @code{:inactive} keyword. If this is non-@code{nil}, the widget itself
1519 has been deactivated. This is different from using the @code{:active}
1520 keyword, in that the latter tells you if the widget @strong{or} any of
1521 its ancestors have been deactivated. Do not attempt to set the
1522 @code{:inactive} keyword directly. Use the @code{:activate}
1523 @code{:deactivate} keywords instead.
1526 @node Defining New Widgets, Widget Browser, Widget Properties, Top
1527 @comment node-name, next, previous, up
1528 @section Defining New Widgets
1530 @cindex defining new widgets
1532 You can define specialized widgets with @code{define-widget}. It allows
1533 you to create a shorthand for more complex widgets, including specifying
1534 component widgets and new default values for the keyword
1537 @defun define-widget name class doc &rest args
1538 Define a new widget type named @var{name} from @code{class}.
1540 @var{name} and class should both be symbols, @code{class} should be one
1541 of the existing widget types.
1543 The third argument @var{doc} is a documentation string for the widget.
1545 After the new widget has been defined, the following two calls will
1546 create identical widgets:
1551 (widget-create @var{name})
1556 (apply widget-create @var{class} @var{args})
1562 Using @code{define-widget} just stores the definition of the widget type
1563 in the @code{widget-type} property of @var{name}, which is what
1564 @code{widget-create} uses.
1566 If you only want to specify defaults for keywords with no complex
1567 conversions, you can use @code{identity} as your conversion function.
1569 The following additional keyword arguments are useful when defining new
1572 @vindex convert-widget@r{ keyword}
1573 @item :convert-widget
1574 Function to convert a widget type before creating a widget of that
1575 type. It takes a widget type as an argument, and returns the converted
1576 widget type. When a widget is created, this function is called for the
1577 widget type and all the widget's parent types, most derived first.
1579 The following predefined functions can be used here:
1581 @defun widget-types-convert-widget widget
1582 Convert @code{:args} as widget types in @var{widget}.
1585 @defun widget-value-convert-widget widget
1586 Initialize @code{:value} from @code{:args} in @var{widget}.
1589 @vindex copy@r{ keyword}
1591 Function to deep copy a widget type. It takes a shallow copy of the
1592 widget type as an argument (made by @code{copy-sequence}), and returns a
1593 deep copy. The purpose of this is to avoid having different instances
1594 of combined widgets share nested attributes.
1596 The following predefined functions can be used here:
1598 @defun widget-types-copy widget
1599 Copy @code{:args} as widget types in @var{widget}.
1602 @vindex value-to-internal@r{ keyword}
1603 @item :value-to-internal
1604 Function to convert the value to the internal format. The function
1605 takes two arguments, a widget and an external value, and returns the
1606 internal value. The function is called on the present @code{:value}
1607 when the widget is created, and on any value set later with
1608 @code{widget-value-set}.
1610 @vindex value-to-external@r{ keyword}
1611 @item :value-to-external
1612 Function to convert the value to the external format. The function
1613 takes two arguments, a widget and an internal value, and returns the
1614 external value. The function is called on the present @code{:value}
1615 when the widget is created, and on any value set later with
1616 @code{widget-value-set}.
1618 @vindex create@r{ keyword}
1620 Function to create a widget from scratch. The function takes one
1621 argument, a widget type, and creates a widget of that type, inserts it
1622 in the buffer, and returns a widget object.
1624 @vindex delete@r{ keyword}
1626 Function to delete a widget. The function takes one argument, a widget,
1627 and should remove all traces of the widget from the buffer.
1629 The default value is:
1631 @defun widget-default-delete widget
1632 Remove @var{widget} from the buffer.
1633 Delete all @code{:children} and @code{:buttons} in @var{widget}.
1636 In most cases you should not change this value, but instead use
1637 @code{:value-delete} to make any additional cleanup.
1639 @vindex value-create@r{ keyword}
1641 Function to expand the @samp{%v} escape in the format string. It will
1642 be called with the widget as its argument and should insert a
1643 representation of the widget's value in the buffer.
1645 Nested widgets should be listed in @code{:children} or @code{:buttons}
1646 to make sure they are automatically deleted.
1648 @vindex value-delete@r{ keyword}
1650 Should remove the representation of the widget's value from the buffer.
1651 It will be called with the widget as its argument. It doesn't have to
1652 remove the text, but it should release markers and delete nested widgets
1653 if these are not listed in @code{:children} or @code{:buttons}.
1655 @vindex value-get@r{ keyword}
1657 Function to extract the value of a widget, as it is displayed in the
1660 The following predefined function can be used here:
1662 @defun widget-value-value-get widget
1663 Return the @code{:value} property of @var{widget}.
1666 @vindex format-handler@r{ keyword}
1667 @item :format-handler
1668 Function to handle unknown @samp{%} escapes in the format string. It
1669 will be called with the widget and the character that follows the
1670 @samp{%} as arguments. You can set this to allow your widget to handle
1671 non-standard escapes.
1673 @findex widget-default-format-handler
1674 You should end up calling @code{widget-default-format-handler} to handle
1675 unknown escape sequences, which will handle the @samp{%h} and any future
1676 escape sequences, as well as give an error for unknown escapes.
1678 @vindex action@r{ keyword}
1680 Function to handle user initiated events. By default, @code{:notify}
1683 The following predefined function can be used here:
1685 @defun widget-parent-action widget &optional event
1686 Tell @code{:parent} of @var{widget} to handle the @code{:action}.
1687 Optional @var{event} is the event that triggered the action.
1690 @vindex prompt-value@r{ keyword}
1692 Function to prompt for a value in the minibuffer. The function should
1693 take four arguments, @var{widget}, @var{prompt}, @var{value}, and
1694 @var{unbound} and should return a value for widget entered by the user.
1695 @var{prompt} is the prompt to use. @var{value} is the default value to
1696 use, unless @var{unbound} is non-@code{nil}, in which case there is no default
1697 value. The function should read the value using the method most natural
1698 for this widget, and does not have to check that it matches.
1701 If you want to define a new widget from scratch, use the @code{default}
1704 @deffn Widget default
1705 Widget used as a base for other widgets.
1707 It provides most of the functionality that is referred to as ``by
1708 default'' in this text.
1711 @node Widget Browser, Widget Minor Mode, Defining New Widgets, Top
1712 @comment node-name, next, previous, up
1713 @section Widget Browser
1714 @cindex widget browser
1716 There is a separate package to browse widgets. This is intended to help
1717 programmers who want to examine the content of a widget. The browser
1718 shows the value of each keyword, but uses links for certain keywords
1719 such as @samp{:parent}, which avoids printing cyclic structures.
1721 @deffn Command widget-browse @var{widget}
1722 Create a widget browser for @var{widget}.
1723 When called interactively, prompt for @var{widget}.
1726 @deffn Command widget-browse-other-window @var{widget}
1727 Create a widget browser for @var{widget} and show it in another window.
1728 When called interactively, prompt for @var{widget}.
1731 @deffn Command widget-browse-at @var{pos}
1732 Create a widget browser for the widget at @var{pos}.
1733 When called interactively, use the position of point.
1736 @node Widget Minor Mode, Utilities, Widget Browser, Top
1737 @comment node-name, next, previous, up
1738 @section Widget Minor Mode
1739 @cindex widget minor mode
1741 There is a minor mode for manipulating widgets in major modes that
1742 don't provide any support for widgets themselves. This is mostly
1743 intended to be useful for programmers doing experiments.
1745 @deffn Command widget-minor-mode
1746 Toggle minor mode for traversing widgets.
1747 With arg, turn widget mode on if and only if arg is positive.
1750 @defvar widget-minor-mode-keymap
1751 Keymap used in @code{widget-minor-mode}.
1754 @node Utilities, Widget Wishlist, Widget Minor Mode, Top
1755 @comment node-name, next, previous, up
1757 @cindex utility functions for widgets
1759 @defun widget-prompt-value widget prompt [ value unbound ]
1760 Prompt for a value matching @var{widget}, using @var{prompt}.
1761 The current value is assumed to be @var{value}, unless @var{unbound} is
1762 non-@code{nil}.@refill
1765 @defun widget-get-sibling widget
1766 Get the item which @var{widget} is assumed to toggle.
1767 This is only meaningful for radio buttons or checkboxes in a list.
1770 @node Widget Wishlist, Index, Utilities, Top
1771 @comment node-name, next, previous, up
1777 It should be possible to add or remove items from a list with @kbd{C-k}
1778 and @kbd{C-o} (suggested by @sc{rms}).
1781 The @samp{[INS]} and @samp{[DEL]} buttons should be replaced by a single
1782 dash (@samp{-}). The dash should be a button that, when invoked, asks
1783 whether you want to add or delete an item (@sc{rms} wanted to git rid of
1784 the ugly buttons, the dash is my idea).
1787 The @code{menu-choice} tag should be prettier, something like the abbreviated
1791 Finish @code{:tab-order}.
1794 Make indentation work with glyphs and proportional fonts.
1797 Add commands to show overview of object and class hierarchies to the
1801 Find a way to disable mouse highlight for inactive widgets.
1804 Find a way to make glyphs look inactive.
1807 Add @code{property-list} widget.
1810 Add @code{association-list} widget.
1813 Add @code{key-binding} widget.
1816 Add @code{widget} widget for editing widget specifications.
1819 Find clean way to implement variable length list.
1820 See @code{TeX-printer-list} for an explanation.
1823 @kbd{C-h} in @code{widget-prompt-value} should give type specific help.
1826 Add a @code{mailto} widget.
1829 @node Index, , Widget Wishlist, Top
1830 @comment node-name, next, previous, up
1833 This is an alphabetical listing of all concepts, functions, commands,
1834 variables, and widgets described in this manual.
1837 @setchapternewpage odd
1842 arch-tag: 2b427731-4c61-4e72-85de-5ccec9c623f0