\input texinfo.tex@c $Id: widget.texi,v 1.99 1997/04/06 20:34:01 abraham Exp $@c %**start of header@setfilename widget@settitle The Emacs Widget Library@iftex@afourpaper@headings double@end iftex@c %**end of header@node Top, Introduction, (dir), (dir)@comment node-name, next, previous, up@top The Emacs Widget LibraryVersion: 1.71@menu* Introduction:: * User Interface:: * Programming Example:: * Setting Up the Buffer:: * Basic Types:: * Sexp Types:: * Widget Properties:: * Defining New Widgets:: * Widget Wishlist.:: @end menu@node Introduction, User Interface, Top, Top@comment node-name, next, previous, up@section IntroductionMost graphical user interface toolkits, such as Motif and XView, providea number of standard user interface controls (sometimes known as`widgets' or `gadgets'). Emacs doesn't really support anything likethis, except for an incredible powerful text ``widget''. On the otherhand, Emacs does provide the necessary primitives to implement manyother widgets within a text buffer. The @code{widget} packagesimplifies this task.The basic widgets are:@table @code@item linkAreas of text with an associated action. Intended for hypertext linksembedded in text.@item push-button Like link, but intended for stand-alone buttons.@item editable-fieldAn editable text field. It can be either variable or fixed length.@item menu-choiceAllows the user to choose one of multiple options from a menu, eachoption is itself a widget. Only the selected option will be visible inthe buffer.@item radio-button-choiceAllows the user to choose one of multiple options by pushing radiobuttons. The options are implemented as widgets. All options will bevisible in the buffer.@item itemA simple constant widget intended to be used in the @code{menu-choice} and@code{radio-button-choice} widgets. @item choice-itemAn button item only intended for use in choices. When pushed, the userwill be asked to select another option from the choice widget.@item toggleA simple @samp{on}/@samp{off} switch.@item checkboxA checkbox (@samp{[ ]}/@samp{[X]}). @item editable-listCreate an editable list. The user can insert or delete items in thelist. Each list item is itself a widget.@end tableNow of what possible use can support for widgets be in a text editor?I'm glad you asked. The answer is that widgets are useful forimplementing forms. A @dfn{form} in emacs is a buffer where the user issupposed to fill out a number of fields, each of which has a specificmeaning. The user is not supposed to change or delete any of the textbetween the fields. Examples of forms in Emacs are the @file{forms}package (of course), the customize buffers, the mail and news composemodes, and the @sc{html} form support in the @file{w3} browser. The advantages for a programmer of using the @code{widget} package toimplement forms are:@enumerate@itemMore complex field than just editable text are supported. @itemYou can give the user immediate feedback if he enters invalid data in atext field, and sometimes prevent entering invalid data.@item You can have fixed sized fields, thus allowing multiple field to belined up in columns.@itemIt is simple to query or set the value of a field. @item Editing happens in buffer, not in the mini-buffer.@item Packages using the library get a uniform look, making them easier forthe user to learn.@item As support for embedded graphics improve, the widget library willextended to support it. This means that your code using the widgetlibrary will also use the new graphic features by automatic.@end enumerateIn order to minimize the code that is loaded by users who does notcreate any widgets, the code has been split in two files:@table @file@item widget.elThis will declare the user variables, define the function@code{widget-define}, and autoload the function @code{widget-create}. @item wid-edit.elEverything else is here, there is no reason to load it explicitly, asit will be autoloaded when needed.@end table@node User Interface, Programming Example, Introduction, Top@comment node-name, next, previous, up@section User InterfaceA form consist of read only text for documentation and some fields,where each the fields contain two parts, as tag and a value. The tagsare used to identify the fields, so the documentation can refer to thefoo field, meaning the field tagged with @samp{Foo}. Here is an exampleform:@exampleHere is some documentation.Name: @i{My Name} @strong{Choose}: This optionAddress: @i{Some PlaceIn some CitySome country.}See also @b{_other work_} for more information.Numbers: count to three below@b{[INS]} @b{[DEL]} @i{One}@b{[INS]} @b{[DEL]} @i{Eh, two?}@b{[INS]} @b{[DEL]} @i{Five!}@b{[INS]} Select multiple:@b{[X]} This@b{[ ]} That@b{[X]} ThusSelect one:@b{(*)} One@b{( )} Another One.@b{( )} A Final One.@b{[Apply Form]} @b{[Reset Form]}@end exampleThe top level widgets in is example are tagged @samp{Name},@samp{Choose}, @samp{Address}, @samp{_other work_}, @samp{Numbers},@samp{Select multiple}, @samp{Select one}, @samp{[Apply Form]}, and@samp{[Reset Form]}. There are basically two thing the user can do withina form, namely editing the editable text fields and activating thebuttons.@subsection Editable Text FieldsIn the example, the value for the @samp{Name} is most likely displayedin an editable text field, and so are values for each of the members ofthe @samp{Numbers} list. All the normal Emacs editing operations areavailable for editing these fields. The only restriction is that eachchange you make must be contained within a single editable text field.For example, capitalizing all text from the middle of one field to themiddle of another field is prohibited.Editing text fields are created by the @code{editable-field} widget.The editing text fields are highlighted with the@code{widget-field-face} face, making them easy to find.@deffn Face widget-field-faceFace used for other editing fields.@end deffn@subsection ButtonsSome portions of the buffer have an associated @dfn{action}, which canbe @dfn{activated} by a standard key or mouse command. These portionsare called @dfn{buttons}. The default commands for activating a buttonare:@table @kbd@item @key{RET}@deffn Command widget-button-press @var{pos} &optional @var{event}Activate the button at @var{pos}, defaulting to point.If point is not located on a button, activate the binding in@code{widget-global-map} (by default the global map).@end deffn@item mouse-2@deffn Command widget-button-click @var{event}Activate the button at the location of the mouse pointer. If the mousepointer is located in an editable text field, activate the binding in@code{widget-global-map} (by default the global map).@end deffn@end tableThere are several different kind of buttons, all of which are present inthe example:@table @emph@item The Option Field Tags.When you activate one of these buttons, you will be asked to choosebetween a number of different options. This is how you edit an optionfield. Option fields are created by the @code{menu-choice} widget. Inthe example, @samp{@b{Choose}} is an option field tag.@item The @samp{@b{[INS]}} and @samp{@b{[DEL]}} buttons.Activating these will insert or delete elements from a editable list.The list is created by the @code{editable-list} widget. @item Embedded Buttons.The @samp{@b{_other work_}} is an example of an embeddedbutton. Embedded buttons are not associated with a fields, but can serveany purpose, such as implementing hypertext references. They areusually created by the @code{link} widget.@item The @samp{@b{[ ]}} and @samp{@b{[X]}} buttons.Activating one of these will convert it to the other. This is usefulfor implementing multiple-choice fields. You can create it wit@item The @samp{@b{( )}} and @samp{@b{(*)}} buttons.Only one radio button in a @code{radio-button-choice} widget can be selected at anytime. When you push one of the unselected radio buttons, it will beselected and the previous selected radio button will become unselected. @item The @samp{@b{[Apply Form]}} @samp{@b{[Reset Form]}} buttons.These are explicit buttons made with the @code{push-button} widget. The maindifference from the @code{link} widget is that the buttons are will bedisplayed as GUI buttons when possible.enough. @end tableTo make them easier to locate, buttons are emphasized in the buffer. @deffn Face widget-button-faceFace used for buttons.@end deffn@defopt widget-mouse-faceFace used for buttons when the mouse pointer is above it.@end defopt@subsection NavigationYou can use all the normal Emacs commands to move around in a formbuffer, plus you will have these additional commands:@table @kbd@item @key{TAB}@deffn Command widget-forward &optional countMove point @var{count} buttons or editing fields forward.@end deffn@item @key{M-TAB}@deffn Command widget-backward &optional countMove point @var{count} buttons or editing fields backward.@end deffn@end table@node Programming Example, Setting Up the Buffer, User Interface, Top@comment node-name, next, previous, up@section Programming ExampleHere is the code to implement the user interface example (see @ref{UserInterface}).@lisp(require 'widget)(eval-when-compile (require 'wid-edit))(defvar widget-example-repeat)(defun widget-example () "Create the widgets from the Widget manual." (interactive) (switch-to-buffer "*Widget Example*") (kill-all-local-variables) (make-local-variable 'widget-example-repeat) (let ((inhibit-read-only t)) (erase-buffer)) (widget-insert "Here is some documentation.\n\nName: ") (widget-create 'editable-field :size 13 "My Name") (widget-create 'menu-choice :tag "Choose" :value "This" :help-echo "Choose me, please!" :notify (lambda (widget &rest ignore) (message "%s is a good choice!" (widget-value widget))) '(item :tag "This option" :value "This") '(choice-item "That option") '(editable-field :menu-tag "No option" "Thus option")) (widget-insert "Address: ") (widget-create 'editable-field "Some Place\nIn some City\nSome country.") (widget-insert "\nSee also ") (widget-create 'link :notify (lambda (&rest ignore) (widget-value-set widget-example-repeat '("En" "To" "Tre")) (widget-setup)) "other work") (widget-insert " for more information.\n\nNumbers: count to three below\n") (setq widget-example-repeat (widget-create 'editable-list :entry-format "%i %d %v" :notify (lambda (widget &rest ignore) (let ((old (widget-get widget ':example-length)) (new (length (widget-value widget)))) (unless (eq old new) (widget-put widget ':example-length new) (message "You can count to %d." new)))) :value '("One" "Eh, two?" "Five!") '(editable-field :value "three"))) (widget-insert "\n\nSelect multiple:\n\n") (widget-create 'checkbox t) (widget-insert " This\n") (widget-create 'checkbox nil) (widget-insert " That\n") (widget-create 'checkbox :notify (lambda (&rest ignore) (message "Tickle")) t) (widget-insert " Thus\n\nSelect one:\n\n") (widget-create 'radio-button-choice :value "One" :notify (lambda (widget &rest ignore) (message "You selected %s" (widget-value widget))) '(item "One") '(item "Anthor One.") '(item "A Final One.")) (widget-insert "\n") (widget-create 'push-button :notify (lambda (&rest ignore) (if (= (length (widget-value widget-example-repeat)) 3) (message "Congratulation!") (error "Three was the count!"))) "Apply Form") (widget-insert " ") (widget-create 'push-button :notify (lambda (&rest ignore) (widget-example)) "Reset Form") (widget-insert "\n") (use-local-map widget-keymap) (widget-setup))@end lisp@node Setting Up the Buffer, Basic Types, Programming Example, Top@comment node-name, next, previous, up@section Setting Up the BufferWidgets are created with @code{widget-create}, which returns a@dfn{widget} object. This object can be queried and manipulated byother widget functions, until it is deleted with @code{widget-delete}.After the widgets have been created, @code{widget-setup} must be calledto enable them.@defun widget-create type [ keyword argument ]@dots{}Create and return a widget of type @var{type}.The syntax for the @var{type} argument is described in @ref{Basic Types}.The keyword arguments can be used to overwrite the keyword argumentsthat are part of @var{type}.@end defun@defun widget-delete widgetDelete @var{widget} and remove it from the buffer.@end defun@defun widget-setup Setup a buffer to support widgets. This should be called after creating all the widgets and before allowingthe user to edit them.@refill@end defunIf you want to insert text outside the widgets in the form, therecommended way to do that is with @code{widget-insert}.@defun widget-insert Insert the arguments, either strings or characters, at point.The inserted text will be read only.@end defunThere is a standard widget keymap which you might find useful.@defvr Const widget-keymapA keymap with the global keymap as its parent.@*@key{TAB} and @kbd{C-@key{TAB}} are bound to @code{widget-forward} and@code{widget-backward}, respectively. @kbd{@key{RET}} and @kbd{mouse-2}are bound to @code{widget-button-press} and@code{widget-button-}.@refill@end defvr@defvar widget-global-mapKeymap used by @code{widget-button-press} and @code{widget-button-click}when not on a button. By default this is @code{global-map}.@end defvar@node Basic Types, Sexp Types, Setting Up the Buffer, Top@comment node-name, next, previous, up@section Basic TypesThe syntax of a type specification is given below:@exampleNAME ::= (NAME [KEYWORD ARGUMENT]... ARGS) | NAME@end exampleWhere, @var{name} is a widget name, @var{keyword} is the name of aproperty, @var{argument} is the value of the property, and @var{args}are interpreted in a widget specific way.There following keyword arguments that apply to all widgets:@table @code@item :valueThe initial value for widgets of this type.@item :formatThis string will be inserted in the buffer when you create a widget.The following @samp{%} escapes are available:@table @samp@item %[@itemx %]The text inside will be marked as a button.@item %@{@itemx %@}The text inside will be displayed with the face specified by@code{:sample-face}. @item %vThis will be replaces with the buffer representation of the widgetsvalue. What this is depends on the widget type.@item %dInsert the string specified by @code{:doc} here.@item %hLike @samp{%d}, with the following modifications: If the documentationstring is more than one line, it will add a button which will togglebetween showing only the first line, and showing the full text.Furthermore, if there is no @code{:doc} property in the widget, it willinstead examine the @code{:documentation-property} property. If it is alambda expression, it will be called with the widget's value as anargument, and the result will be used as the documentation text.@item %tInsert the string specified by @code{:tag} here, or the @code{princ}representation of the value if there is no tag.@item %%Insert a literal @samp{%}. @end table@item :button-faceFace used to highlight text inside %[ %] in the format.@item :docThe string inserted by the @samp{%d} escape in the formatstring. @item :tagThe string inserted by the @samp{%t} escape in the formatstring. @item :tag-glyphName of image to use instead of the string specified by `:tag' onEmacsen that supports it.@item :help-echoMessage displayed whenever you move to the widget with either@code{widget-forward} or @code{widget-backward}.@item :indentAn integer indicating the absolute number of spaces to indent childrenof this widget.@item :offsetAn integer indicating how many extra spaces to add to the widget'sgrandchildren compared to this widget.@item :extra-offsetAn integer indicating how many extra spaces to add to the widget'schildren compared to this widget.@item :notifyA function called each time the widget or a nested widget is changed.The function is called with two or three arguments. The first argumentis the widget itself, the second argument is the widget that waschanged, and the third argument is the event leading to the change, ifany. @item :menu-tagTag used in the menu when the widget is used as an option in a@code{menu-choice} widget.@item :menu-tag-getFunction used for finding the tag when the widget is used as an optionin a @code{menu-choice} widget. By default, the tag used will be either the@code{:menu-tag} or @code{:tag} property if present, or the @code{princ}representation of the @code{:value} property if not.@item :matchShould be a function called with two arguments, the widget and a value,and returning non-nil if the widget can represent the specified value.@item :validateA function which takes a widget as an argument, and return nil if thewidgets current value is valid for the widget. Otherwise, it shouldreturn the widget containing the invalid data, and set that widgets@code{:error} property to a string explaining the error.@item :tab-orderSpecify the order in which widgets are traversed with@code{widget-forward} or @code{widget-backward}. This is only partiallyimplemented.@enumerate a@itemWidgets with tabbing order @code{-1} are ignored.@item (Unimplemented) When on a widget with tabbing order @var{n}, go to thenext widget in the buffer with tabbing order @var{n+1} or @code{nil},whichever comes first.@itemWhen on a widget with no tabbing order specified, go to the next widgetin the buffer with a positive tabbing order, or @code{nil}@end enumerate@item :parentThe parent of a nested widget (e.g. a @code{menu-choice} item or anelement of a @code{editable-list} widget).@item :sibling-argsThis keyword is only used for members of a @code{radio-button-choice} or@code{checklist}. The value should be a list of extra keywordarguments, which will be used when creating the @code{radio-button} or@code{checkbox} associated with this item.@end table@deffn {User Option} widget-glyph-directoryDirectory where glyphs are found. Widget will look here for a file with the same name as specified for theimage, with either a @samp{.xpm} (if supported) or @samp{.xbm} extension.@end deffn@deffn{User Option} widget-glyph-enableIf non-nil, allow glyphs to appear on displayes where they are supported.@end deffn@menu* link:: * url-link:: * info-link:: * push-button:: * editable-field:: * text:: * menu-choice:: * radio-button-choice:: * item:: * choice-item:: * toggle:: * checkbox:: * checklist:: * editable-list:: @end menu@node link, url-link, Basic Types, Basic Types@comment node-name, next, previous, up@subsection The @code{link} WidgetSyntax:@exampleTYPE ::= (link [KEYWORD ARGUMENT]... [ VALUE ])@end exampleThe @var{value}, if present, is used to initialize the @code{:value}property. The value should be a string, which will be inserted in thebuffer. @node url-link, info-link, link, Basic Types@comment node-name, next, previous, up@subsection The @code{url-link} WidgetSyntax:@exampleTYPE ::= (url-link [KEYWORD ARGUMENT]... URL)@end exampleWhen this link is activated, the @sc{www} browser specified by@code{browse-url-browser-function} will be called with @var{url}. @node info-link, push-button, url-link, Basic Types@comment node-name, next, previous, up@subsection The @code{info-link} WidgetSyntax:@exampleTYPE ::= (info-link [KEYWORD ARGUMENT]... ADDRESS)@end exampleWhen this link is activated, the build-in info browser is started on@var{address}. @node push-button, editable-field, info-link, Basic Types@comment node-name, next, previous, up@subsection The @code{push-button} WidgetSyntax:@exampleTYPE ::= (push-button [KEYWORD ARGUMENT]... [ VALUE ])@end exampleThe @var{value}, if present, is used to initialize the @code{:value}property. The value should be a string, which will be inserted in thebuffer. @node editable-field, text, push-button, Basic Types@comment node-name, next, previous, up@subsection The @code{editable-field} WidgetSyntax:@exampleTYPE ::= (editable-field [KEYWORD ARGUMENT]... [ VALUE ])@end exampleThe @var{value}, if present, is used to initialize the @code{:value}property. The value should be a string, which will be inserted infield. This widget will match all string values.The following extra properties are recognized.@table @code@item :sizeThe width of the editable field.@*By default the field will reach to the end of the line.@item :value-faceFace used for highlighting the editable field. Default is@code{widget-field-face}. @item :secretCharacter used to display the value. You can set this to e.g. @code{?*}if the field contains a password or other secret information. Bydefault, the value is not secret.@item :valid-regexpBy default the @code{:validate} function will match the content of thefield with the value of this attribute. The default value is @code{""}which matches everything.@item :keymapKeymap used in the editable field. The default value is@code{widget-field-keymap}, which allows you to use all the normalediting commands, even if the buffers major mode supress some of them.Pressing return activates the function specified by @code{:activate}. @item :hide-front-space@itemx :hide-rear-spaceIn order to keep track of the editable field, emacs places an invisiblespace character in front of the field, and for fixed sized fields alsoin the rear end of the field. For fields that extent to the end of theline, the terminating linefeed serves that purpose instead. Emacs will try to make the spaces intangible when it is safe to do so.Intangible means that the cursor motion commands will skip over thecharacter as if it didn't exist. This is safe to do when the textpreceding or following the widget cannot possible change during thelifetime of the @code{editable-field} widget. The preferred way to tellEmacs this, is to add text to the @code{:format} property around thevalue. For example @code{:format "Tag: %v "}. You can overwrite the internal safety check by setting the@code{:hide-front-space} or @code{:hide-rear-space} properties tonon-nil. This is not recommended. For example, @emph{all} text thatbelongs to a widget (i.e. is created from its @code{:format} string) willchange whenever the widget changes its value.@end table@node text, menu-choice, editable-field, Basic Types@comment node-name, next, previous, up@subsection The @code{text} WidgetThis is just like @code{editable-field}, but intended for multiline textfields. The default @code{:keymap} is @code{widget-text-keymap}, whichdoes not rebind the return key.@node menu-choice, radio-button-choice, text, Basic Types@comment node-name, next, previous, up@subsection The @code{menu-choice} WidgetSyntax:@exampleTYPE ::= (menu-choice [KEYWORD ARGUMENT]... TYPE ... )@end exampleThe @var{type} arguments represents each possible choice. The widgetsvalue of will be the value of the chosen @var{type} argument. Thiswidget will match any value that matches at least one of the specified@var{type} arguments.@table @code@item :void Widget type used as a fallback when the value does not match any of thespecified @var{type} arguments.@item :case-foldSet this to nil if you don't want to ignore case when prompting for achoice through the minibuffer.@item :childrenA list whose car is the widget representing the currently chosen type inthe buffer. @item :choiceThe current chosen type@item :args The list of types. @end table@node radio-button-choice, item, menu-choice, Basic Types@comment node-name, next, previous, up@subsection The @code{radio-button-choice} WidgetSyntax:@exampleTYPE ::= (radio-button-choice [KEYWORD ARGUMENT]... TYPE ... )@end exampleThe @var{type} arguments represents each possible choice. The widgetsvalue of will be the value of the chosen @var{type} argument. Thiswidget will match any value that matches at least one of the specified@var{type} arguments.The following extra properties are recognized.@table @code@item :entry-formatThis string will be inserted for each entry in the list.The following @samp{%} escapes are available:@table @samp@item %vReplaced with the buffer representation of the @var{type} widget.@item %bReplace with the radio button.@item %%Insert a literal @samp{%}. @end table@item button-argsA list of keywords to pass to the radio buttons. Useful for settinge.g. the @samp{:help-echo} for each button.@item :buttonsThe widgets representing the radio buttons.@item :childrenThe widgets representing each type.@item :choiceThe current chosen type@item :args The list of types. @end tableYou can add extra radio button items to a @code{radio-button-choice}widget after it has been created with the function@code{widget-radio-add-item}. @defun widget-radio-add-item widget typeAdd to @code{radio-button-choice} widget @var{widget} a new radio button item of type@var{type}. @end defunPlease note that such items added after the @code{radio-button-choice}widget has been created will @strong{not} be properly destructed whenyou call @code{widget-delete}.@node item, choice-item, radio-button-choice, Basic Types@comment node-name, next, previous, up@subsection The @code{item} WidgetSyntax:@exampleITEM ::= (item [KEYWORD ARGUMENT]... VALUE)@end exampleThe @var{value}, if present, is used to initialize the @code{:value}property. The value should be a string, which will be inserted in thebuffer. This widget will only match the specified value.@node choice-item, toggle, item, Basic Types@comment node-name, next, previous, up@subsection The @code{choice-item} WidgetSyntax:@exampleITEM ::= (choice-item [KEYWORD ARGUMENT]... VALUE)@end exampleThe @var{value}, if present, is used to initialize the @code{:value}property. The value should be a string, which will be inserted in thebuffer as a button. Activating the button of a @code{choice-item} isequivalent to activating the parent widget. This widget will only matchthe specified value. @node toggle, checkbox, choice-item, Basic Types@comment node-name, next, previous, up@subsection The @code{toggle} WidgetSyntax:@exampleTYPE ::= (toggle [KEYWORD ARGUMENT]...)@end exampleThe widget has two possible states, `on' and `off', which corresponds toa @code{t} or @code{nil} value.The following extra properties are recognized.@table @code@item :onString representing the `on' state. By default the string @samp{on}.@item :off String representing the `off' state. By default the string @samp{off}.@item :on-glyphName of a glyph to be used instead of the `:on' text string, on emacsenthat supports it.@item :off-glyphName of a glyph to be used instead of the `:off' text string, on emacsenthat supports it.@end table@node checkbox, checklist, toggle, Basic Types@comment node-name, next, previous, up@subsection The @code{checkbox} WidgetThe widget has two possible states, `selected' and `unselected', whichcorresponds to a @code{t} or @code{nil} value.Syntax:@exampleTYPE ::= (checkbox [KEYWORD ARGUMENT]...)@end example@node checklist, editable-list, checkbox, Basic Types@comment node-name, next, previous, up@subsection The @code{checklist} WidgetSyntax:@exampleTYPE ::= (checklist [KEYWORD ARGUMENT]... TYPE ... )@end exampleThe @var{type} arguments represents each checklist item. The widgetsvalue of will be a list containing the value of each ticked @var{type}argument. The checklist widget will match a list whose elements allmatches at least one of the specified @var{type} arguments.The following extra properties are recognized.@table @code@item :entry-formatThis string will be inserted for each entry in the list.The following @samp{%} escapes are available:@table @samp@item %vReplaced with the buffer representation of the @var{type} widget.@item %bReplace with the checkbox.@item %%Insert a literal @samp{%}. @end table@item button-argsA list of keywords to pass to the checkboxes. Useful for settinge.g. the @samp{:help-echo} for each checkbox.@item :buttonsThe widgets representing the checkboxes.@item :childrenThe widgets representing each type.@item :args The list of types. @end table@node editable-list, , checklist, Basic Types@comment node-name, next, previous, up@subsection The @code{editable-list} WidgetSyntax:@exampleTYPE ::= (editable-list [KEYWORD ARGUMENT]... TYPE)@end exampleThe value is a list, where each member represent one widget of type@var{type}. The following extra properties are recognized.@table @code@item :entry-formatThis string will be inserted for each entry in the list.The following @samp{%} escapes are available:@table @samp@item %vThis will be replaced with the buffer representation of the @var{type}widget.@item %iInsert the @b{[INS]} button.@item %dInsert the @b{[DEL]} button.@item %%Insert a literal @samp{%}. @end table@item :insert-button-argsA list of keyword arguments to pass to the insert buttons.@item :delete-button-argsA list of keyword arguments to pass to the delete buttons.@item :append-button-argsA list of keyword arguments to pass to the trailing insert button.@item :buttonsThe widgets representing the insert and delete buttons.@item :childrenThe widgets representing the elements of the list.@item :argsList whose car is the type of the list elements.@end table@node Sexp Types, Widget Properties, Basic Types, Top@comment@section Sexp TypesA number of widgets for editing s-expressions (lisp types) are alsoavailable. These basically fall in three categories: @dfn{atoms},@dfn{composite types}, and @dfn{generic}.@menu* generic:: * atoms:: * composite:: @end menu@node generic, atoms, Sexp Types, Sexp Types@comment node-name, next, previous, up@subsection The Generic Widget.The @code{const} and @code{sexp} widgets can contain any lispexpression. In the case of the @code{const} widget the user isprohibited from editing edit it, which is mainly useful as a componentof one of the composite widgets.The syntax for the generic widgets is@exampleTYPE ::= (const [KEYWORD ARGUMENT]... [ VALUE ])@end exampleThe @var{value}, if present, is used to initialize the @code{:value}property and can be any s-expression.@deffn Widget constThis will display any valid s-expression in an immutable part of thebuffer. @end deffn@deffn Widget sexpThis will allow you to edit any valid s-expression in an editable bufferfield. The @code{sexp} widget takes the same keyword arguments as the@code{editable-field} widget.@end deffn@node atoms, composite, generic, Sexp Types@comment node-name, next, previous, up@subsection Atomic Sexp Widgets.The atoms are s-expressions that does not consist of others-expressions. A string is an atom, while a list is a composite type.You can edit the value of an atom with the following widgets. The syntax for all the atoms are@exampleTYPE ::= (NAME [KEYWORD ARGUMENT]... [ VALUE ])@end exampleThe @var{value}, if present, is used to initialize the @code{:value}property and must be an expression of the same type as the widget.I.e. the string widget can only be initialized with a string.All the atom widgets take the same keyword arguments as the @code{editable-field}widget.@deffn Widget stringAllows you to edit a string in an editable field.@end deffn@deffn Widget fileAllows you to edit a file name in an editable field. You you activatethe tag button, you can edit the file name in the mini-buffer withcompletion. Keywords:@table @code@item :must-matchIf this is set to non-nil, only existing file names will be allowed inthe minibuffer.@end table@end deffn@deffn Widget directoryAllows you to edit a directory name in an editable field.Similar to the @code{file} widget.@end deffn@deffn Widget symbolAllows you to edit a lisp symbol in an editable field.@end deffn@deffn Widget integerAllows you to edit an integer in an editable field.@end deffn@deffn Widget numberAllows you to edit a number in an editable field.@end deffn@deffn Widget booleanAllows you to edit a boolean. In lisp this means a variable which iseither nil meaning false, or non-nil meaning true.@end deffn@node composite, , atoms, Sexp Types@comment node-name, next, previous, up@subsection Composite Sexp Widgets.The syntax for the composite are@exampleTYPE ::= (NAME [KEYWORD ARGUMENT]... COMPONENT...)@end exampleWhere each @var{component} must be a widget type. Each component widgetwill be displayed in the buffer, and be editable to the user.@deffn Widget consThe value of a @code{cons} widget is a cons-cell where the car is thevalue of the first component and the cdr is the value of the secondcomponent. There must be exactly two components. @end deffn@deffn Widget lispThe value of a @code{lisp} widget is a list containing the value ofeach of its component.@end deffn@deffn Widget vectorThe value of a @code{vector} widget is a vector containing the value ofeach of its component.@end deffnThe above suffice for specifying fixed size lists and vectors. To getvariable length lists and vectors, you can use a @code{choice},@code{set} or @code{repeat} widgets together with the @code{:inline}keywords. If any component of a composite widget has the @code{:inline}keyword set, its value must be a list which will then be spliced intothe composite. For example, to specify a list whose first element mustbe a file name, and whose remaining arguments should either by thesymbol @code{t} or two files, you can use the following widgetspecification:@example(list file (choice (const t) (list :inline t :value ("foo" "bar") string string)))@end exampleThe value of a widget of this type will either have the form @samp{(file t)} or @code{(file string string)}.This concept of inline is probably hard to understand. It was certainlyhard to implement so instead of confuse you more by trying to explain ithere, I'll just suggest you meditate over it for a while.@deffn Widget choiceAllows you to edit a sexp which may have one of fixed set of types. Itis currently implemented with the @code{choice-menu} basic widget, andhas a similar syntax.@end deffn@deffn Widget setAllows you to specify a type which must be a list whose elements allbelong to given set. The elements of the list is not significant. Thisis implemented on top of the @code{checklist} basic widget, and has asimilar syntax. @end deffn@deffn Widget repeatAllows you to specify a variable length list whose members are all ofthe same type. Implemented on top of the `editable-list' basic widget,and has a similar syntax.@end deffn@node Widget Properties, Defining New Widgets, Sexp Types, Top@comment node-name, next, previous, up@section PropertiesYou can examine or set the value of a widget by using the widget objectthat was returned by @code{widget-create}.@defun widget-value widgetReturn the current value contained in @var{widget}.It is an error to call this function on an uninitialized widget.@end defun@defun widget-value-set widget valueSet the value contained in @var{widget} to @var{value}.It is an error to call this function with an invalid @var{value}.@end defun@strong{Important:} You @emph{must} call @code{widget-setup} aftermodifying the value of a widget before the user is allowed to edit thewidget again. It is enough to call @code{widget-setup} once if youmodify multiple widgets. This is currently only necessary if the widgetcontains an editing field, but may be necessary for other widgets in thefuture. If your application needs to associate some information with the widgetobjects, for example a reference to the item being edited, it can bedone with @code{widget-put} and @code{widget-get}. The property namesmust begin with a @samp{:}.@defun widget-put widget property valueIn @var{widget} set @var{property} to @var{value}.@var{property} should be a symbol, while @var{value} can be anything.@end defun@defun widget-get widget propertyIn @var{widget} return the value for @var{property}.@var{property} should be a symbol, the value is what was last set by@code{widget-put} for @var{property}.@end defun@defun widget-member widget propertyNon-nil if @var{widget} has a value (even nil) for property @var{property}.@end defunOccasionally it can be useful to know which kind of widget you have,i.e. the name of the widget type you gave when the widget was created. @defun widget-type widgetReturn the name of @var{widget}, a symbol.@end defunWidgets can be in two states: active, which means they are modifiable bythe user, or inactive, which means they cannot be modified by the user.You can query or set the state with the following code:@lisp;; Examine if @var{widget} is active or not.(if (widget-apply @var{widget} :active) (message "Widget is active.") (message "Widget is inactive.");; Make @var{widget} inactive.(widget-apply @var{widget} :deactivate);; Make @var{widget} active.(widget-apply @var{widget} :activate)@end lispA widget is inactive if itself, or any of its ancestors (found byfollowing the @code{:parent} link) have been deactivated. To make surea widget is really active, you must therefore activate both itself, andall its ancestors.@lisp(while widget (widget-apply widget :activate) (setq widget (widget-get widget :parent)))@end lispYou can check if a widget has been made inactive by examining the valueof @code{:inactive} keyword. If this is non-nil, the widget itself hasbeen deactivated. This is different from using the @code{:active}keyword, in that the later tell you if the widget @strong{or} any of itsancestors have been deactivated. Do not attempt to set the@code{:inactive} keyword directly. Use the @code{:activate}@code{:deactivated} keywords instead.@node Defining New Widgets, Widget Wishlist., Widget Properties, Top@comment node-name, next, previous, up@section Defining New WidgetsYou can define specialized widgets with @code{define-widget}. It allowsyou to create a shorthand for more complex widgets, including specifyingcomponent widgets and default new default values for the keywordarguments. @defun widget-define name class doc &rest argsDefine a new widget type named @var{name} from @code{class}.@var{name} and class should both be symbols, @code{class} should be oneof the existing widget types. The third argument @var{DOC} is a documentation string for the widget.After the new widget has been defined, the following two calls willcreate identical widgets:@itemize @bullet@item@lisp(widget-create @var{name})@end lisp@item@lisp(apply widget-create @var{class} @var{args})@end lisp@end itemize@end defunUsing @code{widget-define} does just store the definition of the widgettype in the @code{widget-type} property of @var{name}, which is what@code{widget-create} uses.If you just want to specify defaults for keywords with no complexconversions, you can use @code{identity} as your conversion function.The following additional keyword arguments are useful when defining newwidgets: @table @code@item :convert-widgetFunction to convert a widget type before creating a widget of thattype. It takes a widget type as an argument, and returns the convertedwidget type. When a widget is created, this function is called for thewidget type and all the widgets parent types, most derived first. @item :value-to-internalFunction to convert the value to the internal format. The functiontakes two arguments, a widget and an external value, and returns theinternal value. The function is called on the present @code{:value}when the widget is created, and on any value set later with@code{widget-value-set}.@item :value-to-externalFunction to convert the value to the external format. The functiontakes two arguments, a widget and an internal value, and returns theinternal value. The function is called on the present @code{:value}when the widget is created, and on any value set later with@code{widget-value-set}.@item :createFunction to create a widget from scratch. The function takes oneargument, a widget type, and create a widget of that type, insert it inthe buffer, and return a widget object.@item :deleteFunction to delete a widget. The function takes one argument, a widget,and should remove all traces of the widget from the buffer.@item :value-createFunction to expand the @samp{%v} escape in the format string. It willbe called with the widget as its argument. Shouldinsert a representation of the widgets value in the buffer.@item :value-deleteShould remove the representation of the widgets value from the buffer.It will be called with the widget as its argument. It doesn't have toremove the text, but it should release markers and delete nested widgetsif such has been used.@item :format-handlerFunction to handle unknown @samp{%} escapes in the format string. Itwill be called with the widget and the escape character as arguments.You can set this to allow your widget to handle non-standard escapes.You should end up calling @code{widget-default-format-handler} to handleunknown escape sequences, which will handle the @samp{%h} and any futureescape sequences, as well as give an error for unknown escapes.@end tableIf you want to define a new widget from scratch, use the @code{default}widget as its base.@deffn Widget default [ keyword argument ]Widget used as a base for other widgets. It provides most of the functionality that is referred to as ``bydefault'' in this text. @end deffn@node Widget Wishlist., , Defining New Widgets, Top@comment node-name, next, previous, up@section Wishlist.@itemize @bullet@item It should be possible to add or remove items from a list with @kbd{C-k}and @kbd{C-o} (suggested by @sc{rms}).@item The @samp{[INS]} and @samp{[DEL]} buttons should be replaced by a singledash (@samp{-}). The dash should be a button that, when activated, askwhether you want to add or delete an item (@sc{rms} wanted to git rid ofthe ugly buttons, the dash is my idea).@itemWidgets such as @code{file} and @code{symbol} should prompt with completion. @itemThe @code{menu-choice} tag should be prettier, something like the abbreviatedmenus in Open Look.@itemThe functions used in many widgets, like@code{widget-item-convert-widget}, should not have names that arespecific to the first widget where I happended to use them.@itemFlag to make @code{widget-move} skip a specified button.@itemDocument `helper' functions for defining new widgets.@itemActivate the item this is below the mouse when the button isreleased, not the item this is below the mouse when the button ispressed. Dired and grep gets this right. Give feedback if possible.@itemUse @samp{@@deffn Widget} to document widgets. @itemDocument global keywords in one place. Document keywords particular to a specific widget in the widgetdefinition.Document the `default' widget first. Split, when needed, keywords into those useful for normalcustomization, those primarily useful when deriving, and those whorepresent runtime information. @itemFigure out terminology and @sc{api} for the class/type/object/superstuff. Perhaps the correct model is delegation?@itemDocument @code{widget-browse}.@itemMake indentation work with glyphs and propertional fonts.@itemAdd object and class hierarchies to the browser.@end itemize@contents@bye