(x_icon_verify): New function.
[bpt/emacs.git] / man / widget.texi
index f5f366e..457af8a 100644 (file)
@@ -3,9 +3,16 @@
 @c %**start of header
 @setfilename ../info/widget
 @settitle The Emacs Widget Library
-@ifnottex
-Copyright @copyright{} 2000 Free Software Foundation, Inc.
+@syncodeindex fn cp
+@syncodeindex vr cp
+@syncodeindex ky cp
+@afourpaper
+@c %**end of header
+
+@copying
+Copyright @copyright{} 2000, 2002, 2003 Free Software Foundation, Inc.
 
+@quotation
 Permission is granted to copy, distribute and/or modify this document
 under the terms of the GNU Free Documentation License, Version 1.1 or
 any later version published by the Free Software Foundation; with the
@@ -23,22 +30,13 @@ license to the document, as described in section 6 of the license.
 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
 this GNU Manual, like GNU software.  Copies published by the Free
 Software Foundation raise funds for GNU development.''
-@end ifnottex
-
-@iftex
-@afourpaper
-@headings double
-@end iftex
-@c %**end of header
-
-@syncodeindex fn cp
-@syncodeindex vr cp
-@syncodeindex ky cp
+@end quotation
+@end copying
 
 @dircategory Emacs
 @direntry
-* Widget: (widget).      Documenting the "widget" package used by the
-                           Emacs Custom facility.
+* Widget: (widget).      The "widget" package used by the Emacs Customization
+                           facility.
 @end direntry
 
 @node Top, Introduction, (dir), (dir)
@@ -46,18 +44,18 @@ Software Foundation raise funds for GNU development.''
 @top The Emacs Widget Library
 
 @menu
-* Introduction::                
-* User Interface::              
-* Programming Example::         
-* Setting Up the Buffer::       
-* Basic Types::                 
-* Sexp Types::                  
-* Widget Properties::           
-* Defining New Widgets::        
-* Widget Browser::              
-* Widget Minor Mode::           
-* Utilities::                   
-* Widget Wishlist::             
+* Introduction::
+* User Interface::
+* Programming Example::
+* Setting Up the Buffer::
+* Basic Types::
+* Sexp Types::
+* Widget Properties::
+* Defining New Widgets::
+* Widget Browser::
+* Widget Minor Mode::
+* Utilities::
+* Widget Wishlist::
 * Index::
 @end menu
 
@@ -80,7 +78,7 @@ The basic widgets are:
 @item link
 Areas of text with an associated action.  Intended for hypertext links
 embedded in text.
-@item push-button 
+@item push-button
 Like link, but intended for stand-alone buttons.
 @item editable-field
 An editable text field.  It can be either variable or fixed length.
@@ -94,14 +92,14 @@ buttons.  The options are implemented as widgets.  All options will be
 visible in the buffer.
 @item item
 A simple constant widget intended to be used in the @code{menu-choice} and
-@code{radio-button-choice} widgets. 
+@code{radio-button-choice} widgets.
 @item choice-item
 A button item only intended for use in choices.  When invoked, the user
 will be asked to select another option from the choice widget.
 @item toggle
 A simple @samp{on}/@samp{off} switch.
 @item checkbox
-A checkbox (@samp{[ ]}/@samp{[X]}). 
+A checkbox (@samp{[ ]}/@samp{[X]}).
 @item editable-list
 Create an editable list.  The user can insert or delete items in the
 list.  Each list item is itself a widget.
@@ -114,7 +112,7 @@ supposed to fill out a number of fields, each of which has a specific
 meaning.  The user is not supposed to change or delete any of the text
 between the fields.  Examples of forms in Emacs are the @file{forms}
 package (of course), the customize buffers, the mail and news compose
-modes, and the @sc{html} form support in the @file{w3} browser.  
+modes, and the @acronym{HTML} form support in the @file{w3} browser.
 
 @cindex widget library, why use it
 The advantages for a programmer of using the @code{widget} package to
@@ -122,21 +120,21 @@ implement forms are:
 
 @enumerate
 @item
-More complex fields than just editable text are supported. 
+More complex fields than just editable text are supported.
 @item
 You can give the users immediate feedback if they enter invalid data in a
 text field, and sometimes prevent entering invalid data.
-@item 
+@item
 You can have fixed sized fields, thus allowing multiple fields to be
 lined up in columns.
 @item
-It is simple to query or set the value of a field. 
-@item 
+It is simple to query or set the value of a field.
+@item
 Editing happens in the buffer, not in the mini-buffer.
-@item 
+@item
 Packages using the library get a uniform look, making them easier for
 the user to learn.
-@item 
+@item
 As support for embedded graphics improve, the widget library will be
 extended to use the GUI features.  This means that your code using the
 widget library will also use the new graphic features automatically.
@@ -149,7 +147,7 @@ create any widgets, the code has been split in two files:
 @table @file
 @item widget.el
 This will declare the user variables, define the function
-@code{define-widget}, and autoload the function @code{widget-create}. 
+@code{define-widget}, and autoload the function @code{widget-create}.
 @item wid-edit.el
 Everything else is here, there is no reason to load it explicitly, as
 it will be autoloaded when needed.
@@ -179,7 +177,7 @@ 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]} 
+@b{[INS]}
 
 Select multiple:
 
@@ -213,7 +211,16 @@ change you make must be contained within a single editable text field.
 For example, capitalizing all text from the middle of one field to the
 middle of another field is prohibited.
 
-Editing text fields are created by the @code{editable-field} widget.
+Editable text fields are created by the @code{editable-field} widget.
+
+An editable field must be surrounded by static text on both sides, that
+is, text that does not change in the lifetime of the widget.  If the
+field extends to the end of the line, the terminating line-feed character
+will count as the necessary static text on that end, but you will have
+to provide the static text before the field yourself.  The
+@code{:format} keyword is useful for generating the static text; for
+instance, if you give it a value of @code{"Name: %v"}, the "Name: " part
+will count as the static text.
 
 The editing text fields are highlighted with the
 @code{widget-field-face} face, making them easy to find.
@@ -260,7 +267,7 @@ field.  Option fields are created by the @code{menu-choice} widget.  In
 the 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 an editable list.
-The list is created by the @code{editable-list} widget. 
+The list is created by the @code{editable-list} widget.
 @cindex embedded buttons
 @item Embedded Buttons
 The @samp{@b{_other work_}} is an example of an embedded
@@ -282,7 +289,7 @@ main difference from the @code{link} widget is that the buttons will be
 displayed as GUI buttons when possible.
 @end table
 
-To make them easier to locate, buttons are emphasized in the buffer.  
+To make them easier to locate, buttons are emphasized in the buffer.
 
 @deffn Face widget-button-face
 Face used for buttons.
@@ -334,6 +341,7 @@ Interface}).
   (make-local-variable 'widget-example-repeat)
   (let ((inhibit-read-only t))
     (erase-buffer))
+  (remove-overlays)
   (widget-insert "Here is some documentation.\n\nName: ")
   (widget-create 'editable-field
                 :size 13
@@ -354,11 +362,11 @@ Interface}).
   (widget-insert "\nSee also ")
   (widget-create 'link
                 :notify (lambda (&rest ignore)
-                          (widget-value-set widget-example-repeat 
+                          (widget-value-set widget-example-repeat
                                             '("En" "To" "Tre"))
                           (widget-setup))
                 "other work")
-  (widget-insert 
+  (widget-insert
     " for more information.\n\nNumbers: count to three below\n")
   (setq widget-example-repeat
        (widget-create 'editable-list
@@ -389,7 +397,7 @@ Interface}).
                 '(item "One") '(item "Another One.") '(item "A Final One."))
   (widget-insert "\n")
   (widget-create 'push-button
-                :notify (lambda (&rest ignore) 
+                :notify (lambda (&rest ignore)
                           (if (= (length (widget-value widget-example-repeat))
                                  3)
                               (message "Congratulation!")
@@ -427,8 +435,8 @@ that are part of @var{type}.
 Delete @var{widget} and remove it from the buffer.
 @end defun
 
-@defun widget-setup 
-Set up a buffer to support widgets. 
+@defun widget-setup
+Set up a buffer to support widgets.
 
 This should be called after creating all the widgets and before allowing
 the user to edit them.
@@ -438,7 +446,7 @@ the user to edit them.
 If you want to insert text outside the widgets in the form, the
 recommended way to do that is with @code{widget-insert}.
 
-@defun widget-insert 
+@defun widget-insert
 Insert the arguments, either strings or characters, at point.
 The inserted text will be read-only.
 @end defun
@@ -494,7 +502,7 @@ The following @samp{%} escapes are available:
 The text inside will be marked as a button.
 
 By default, the text will be shown in @code{widget-button-face}, and
-surrounded by brackets. 
+surrounded by brackets.
 
 @defopt widget-button-prefix
 String to prefix buttons.
@@ -507,7 +515,7 @@ String to suffix buttons.
 @item %@{
 @itemx %@}
 The text inside will be displayed with the face specified by
-@code{:sample-face}. 
+@code{:sample-face}.
 
 @item %v
 This will be replaced with the buffer representation of the widget's
@@ -530,7 +538,7 @@ Insert 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{%}. 
+Insert a literal @samp{%}.
 @end table
 
 @vindex button-face@r{ keyword}
@@ -558,12 +566,12 @@ The value of the symbol is expanded according to this table.
 @vindex doc@r{ keyword}
 @item :doc
 The string inserted by the @samp{%d} escape in the format
-string.  
+string.
 
 @vindex tag@r{ keyword}
 @item :tag
 The string inserted by the @samp{%t} escape in the format
-string.  
+string.
 
 @vindex tag-glyph@r{ keyword}
 @item :tag-glyph
@@ -575,8 +583,9 @@ Emacsen that supports it.
 Specifies how to display a message whenever you move to the widget with
 either @code{widget-forward} or @code{widget-backward} or move the mouse
 over it (using the standard @code{help-echo} mechanism).  The argument
-is either a string to display or a function of one argument, the widget,
-which should return a string to display.
+is either a string to display, a function of one argument, the widget,
+which should return a string to display, or a form that evaluates to
+such a string.
 
 @vindex indent@r{ keyword}
 @item :indent
@@ -599,7 +608,7 @@ A function called each time the widget or a nested widget is changed.
 The function is called with two or three arguments.  The first argument
 is the widget itself, the second argument is the widget that was
 changed, and the third argument is the event leading to the change, if
-any. 
+any.
 
 @vindex menu-tag@r{ keyword}
 @item :menu-tag
@@ -616,7 +625,7 @@ representation of the @code{:value} property if not.
 @vindex match@r{ keyword}
 @item :match
 Should be a function called with two arguments, the widget and a value,
-and returning non-nil if the widget can represent the specified value.
+and returning non-@code{nil} if the widget can represent the specified value.
 
 @vindex validate@r{ keyword}
 @item :validate
@@ -641,7 +650,7 @@ implemented.
 @item
 Widgets with tabbing order @code{-1} are ignored.
 
-@item 
+@item
 (Unimplemented) When on a widget with tabbing order @var{n}, go to the
 next widget in the buffer with tabbing order @var{n+1} or @code{nil},
 whichever comes first.
@@ -666,32 +675,32 @@ arguments, which will be used when creating the @code{radio-button} or
 @end table
 
 @deffn {User Option} widget-glyph-directory
-Directory where glyphs are found.  
+Directory where glyphs are found.
 Widget will look here for a file with the same name as specified for the
 image, with either a @file{.xpm} (if supported) or @file{.xbm} extension.
 @end deffn
 
 @deffn{User Option} widget-glyph-enable
-If non-nil, allow glyphs to appear on displays where they are supported.
+If non-@code{nil}, allow glyphs to appear on displays 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::               
-* group::                       
+* link::
+* url-link::
+* info-link::
+* push-button::
+* editable-field::
+* text::
+* menu-choice::
+* radio-button-choice::
+* item::
+* choice-item::
+* toggle::
+* checkbox::
+* checklist::
+* editable-list::
+* group::
 @end menu
 
 @node link, url-link, Basic Types, Basic Types
@@ -707,7 +716,7 @@ TYPE ::= (link [KEYWORD ARGUMENT]...  [ VALUE ])
 
 The @var{value}, if present, is used to initialize the @code{:value}
 property.  The value should be a string, which will be inserted in the
-buffer. 
+buffer.
 
 By default the link will be shown in brackets.
 
@@ -731,8 +740,8 @@ TYPE ::= (url-link [KEYWORD ARGUMENT]...  URL)
 @end example
 
 @findex browse-url-browser-function@r{, and @code{url-link} widget}
-When this link is invoked, the @sc{www} browser specified by
-@code{browse-url-browser-function} will be called with @var{url}. 
+When this link is invoked, the @acronym{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
@@ -746,7 +755,7 @@ TYPE ::= (info-link [KEYWORD ARGUMENT]...  ADDRESS)
 @end example
 
 When this link is invoked, the built-in Info reader is started on
-@var{address}. 
+@var{address}.
 
 @node  push-button, editable-field, info-link, Basic Types
 @comment  node-name,  next,  previous,  up
@@ -761,7 +770,7 @@ TYPE ::= (push-button [KEYWORD ARGUMENT]...  [ VALUE ])
 
 The @var{value}, if present, is used to initialize the @code{:value}
 property.  The value should be a string, which will be inserted in the
-buffer. 
+buffer.
 
 By default the tag will be shown in brackets.
 
@@ -799,13 +808,13 @@ By default the field will reach to the end of the line.
 @vindex value-face@r{ keyword}
 @item :value-face
 Face used for highlighting the editable field.  Default is
-@code{widget-field-face}, see @ref{User Interface}. 
+@code{widget-field-face}, see @ref{User Interface}.
 
 @vindex secret@r{ keyword}
 @item :secret
 Character used to display the value.  You can set this to e.g.@: @code{?*}
 if the field contains a password or other secret information.  By
-default, this is nil, and the value is not secret.
+default, this is @code{nil}, and the value is not secret.
 
 @vindex valid-regexp@r{ keyword}
 @item :valid-regexp
@@ -851,18 +860,18 @@ arguments.
 
 @table @code
 @vindex void@r{ keyword}
-@item :void 
+@item :void
 Widget type used as a fallback when the value does not match any of the
 specified @var{type} arguments.
 
 @vindex case-fold@r{ keyword}
 @item :case-fold
-Set this to nil if you don't want to ignore case when prompting for a
+Set this to @code{nil} if you don't want to ignore case when prompting for a
 choice through the minibuffer.
 
 @vindex children@r{ keyword}
 @item :children
-A list whose @code{car} is the widget representing the currently chosen
+A list whose @sc{car} is the widget representing the currently chosen
 type in the buffer.
 
 @vindex choice@r{ keyword}
@@ -870,8 +879,8 @@ type in the buffer.
 The current chosen type.
 
 @vindex args@r{ keyword}
-@item :args 
-The list of types. 
+@item :args
+The list of types.
 @end table
 
 @node radio-button-choice, item, menu-choice, Basic Types
@@ -903,7 +912,7 @@ Replace with the buffer representation of the @var{type} widget.
 @item %b
 Replace with the radio button.
 @item %%
-Insert a literal @samp{%}. 
+Insert a literal @samp{%}.
 @end table
 
 @vindex button-args@r{ keyword}
@@ -924,13 +933,13 @@ The widgets representing each type.
 The current chosen type
 
 @vindex args@r{ keyword}
-@item :args 
-The list of types. 
+@item :args
+The list of types.
 @end table
 
 You 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}. 
+@code{widget-radio-add-item}.
 
 @defun widget-radio-add-item widget type
 Add to @code{radio-button-choice} widget @var{widget} a new radio button
@@ -971,7 +980,7 @@ The @var{value}, if present, is used to initialize the @code{:value}
 property.  The value should be a string, which will be inserted in the
 buffer as a button.  Activating the button of a @code{choice-item} is
 equivalent to activating the parent widget.  This widget will only match
-the specified value. 
+the specified value.
 
 @node toggle, checkbox, choice-item, Basic Types
 @comment  node-name,  next,  previous,  up
@@ -993,7 +1002,7 @@ The following extra properties are recognized:
 @item :on
 A string representing the @samp{on} state.  By default the string
 @samp{on}.
-@item :off 
+@item :off
 A string representing the @samp{off} state.  By default the string
 @samp{off}.
 @vindex on-glyph@r{ keyword}
@@ -1049,16 +1058,16 @@ Replaced with the buffer representation of the @var{type} widget.
 @item %b
 Replace with the checkbox.
 @item %%
-Insert a literal @samp{%}. 
+Insert a literal @samp{%}.
 @end table
 
 @vindex greedy@r{ keyword}
 @item :greedy
 Usually a checklist will only match if the items are in the exact
 sequence given in the specification.  By setting @code{:greedy} to
-non-nil, it will allow the items to come in any sequence.  However, if
-you extract the value they will be in the sequence given in the
-checklist, i.e.@: the original sequence is forgotten.
+non-@code{nil}, it will allow the items to come in any sequence.
+However, if you extract the value they will be in the sequence given
+in the checklist, i.e.@: the original sequence is forgotten.
 
 @vindex button-args@r{ keyword}
 @item :button-args
@@ -1074,8 +1083,8 @@ The widgets representing the checkboxes.
 The widgets representing each type.
 
 @vindex args@r{ keyword}
-@item :args 
-The list of types. 
+@item :args
+The list of types.
 @end table
 
 @node editable-list, group, checklist, Basic Types
@@ -1090,7 +1099,7 @@ TYPE ::= (editable-list [KEYWORD ARGUMENT]... TYPE)
 @end example
 
 The value is a list, where each member represents one widget of type
-@var{type}. 
+@var{type}.
 
 The following extra properties are recognized:
 
@@ -1108,7 +1117,7 @@ Insert the @b{[INS]} button.
 @item %d
 Insert the @b{[DEL]} button.
 @item %%
-Insert a literal @samp{%}. 
+Insert a literal @samp{%}.
 @end table
 
 @vindex insert-button-args@r{ keyword}
@@ -1133,7 +1142,7 @@ The widgets representing the elements of the list.
 
 @vindex args@r{ keyword}
 @item :args
-List whose @code{car} is the type of the list elements.
+List whose @sc{car} is the type of the list elements.
 @end table
 
 @node group,  , editable-list, Basic Types
@@ -1149,22 +1158,22 @@ Syntax:
 TYPE ::= (group [KEYWORD ARGUMENT]... TYPE...)
 @end example
 
-The value is a list, with one member for each @var{type}.  
+The value is a list, with one member for each @var{type}.
 
 @node Sexp Types, Widget Properties, Basic Types, Top
 @comment
 @section Sexp Types
 @cindex sexp types
 
-A number of widgets for editing @dfn{s-expressions} (lisp types), sexp
+A number of widgets for editing @dfn{s-expressions} (Lisp types), sexp
 for short, are also available.  These basically fall in several
 categories described in this section.
 
 @menu
-* constants::                   
-* generic::                     
-* atoms::                       
-* composite::                   
+* constants::
+* generic::
+* atoms::
+* composite::
 @end menu
 
 @node constants, generic, Sexp Types, Sexp Types
@@ -1172,7 +1181,7 @@ categories described in this section.
 @subsection The Constant Widgets
 @cindex constant widgets
 
-The @code{const} widget can contain any lisp expression, but the user is
+The @code{const} widget can contain any Lisp expression, but the user is
 prohibited from editing it, which is mainly useful as a component of one
 of the composite widgets.
 
@@ -1187,7 +1196,7 @@ property and can be any s-expression.
 
 @deffn Widget const
 This will display any valid s-expression in an immutable part of the
-buffer. 
+buffer.
 @end deffn
 
 There are two variations of the @code{const} widget, namely
@@ -1209,7 +1218,7 @@ An immutable symbol that is bound as a function.
 @subsection Generic Sexp Widget
 @cindex generic sexp widget
 
-The @code{sexp} widget can contain any lisp expression, and allows the
+The @code{sexp} widget can contain any Lisp expression, and allows the
 user to edit it inline in the buffer.
 
 The syntax for the @code{sexp} widget is:
@@ -1220,7 +1229,7 @@ TYPE ::= (sexp [KEYWORD ARGUMENT]...  [ VALUE ])
 
 @deffn Widget sexp
 This will allow you to edit any valid s-expression in an editable buffer
-field. 
+field.
 
 The @code{sexp} widget takes the same keyword arguments as the
 @code{editable-field} widget.  @xref{editable-field}.
@@ -1264,14 +1273,14 @@ Allows you to enter a character in an editable field.
 @deffn Widget file
 Allows you to edit a file name in an editable field.  If you invoke
 the tag button, you can edit the file name in the mini-buffer with
-completion. 
+completion.
 
 Keywords:
 @table @code
 @vindex must-match@r{ keyword}
 @item :must-match
-If this is set to non-nil, only existing file names will be allowed in
-the minibuffer.
+If this is set to non-@code{nil}, only existing file names will be
+allowed in the minibuffer.
 @end table
 @end deffn
 
@@ -1281,7 +1290,7 @@ Similar to the @code{file} widget.
 @end deffn
 
 @deffn Widget symbol
-Allows you to edit a lisp symbol in an editable field.
+Allows you to edit a Lisp symbol in an editable field.
 @end deffn
 
 @deffn Widget function
@@ -1301,8 +1310,8 @@ Allows you to edit a number in an editable field.
 @end deffn
 
 @deffn Widget boolean
-Allows you to edit a boolean.  In lisp this means a variable which is
-either nil meaning false, or non-nil meaning true.
+Allows you to edit a boolean.  In Lisp this means a variable which is
+either @code{nil} meaning false, or non-@code{nil} meaning true.
 @end deffn
 
 
@@ -1322,8 +1331,8 @@ where each @var{component} must be a widget type.  Each component widget
 will be displayed in the buffer, and will be editable by the user.
 
 @deffn Widget cons
-The value of a @code{cons} widget is a cons-cell where the @code{car} is
-the value of the first component and the @code{cdr} is the value of the
+The value of a @code{cons} widget is a cons-cell where the @sc{car} is
+the value of the first component and the @sc{cdr} is the value of the
 second component.  There must be exactly two components.
 @end deffn
 
@@ -1355,7 +1364,7 @@ specification:
                     string string)))
 @end example
 
-The value of a widget of this type will either have the form 
+The value of a widget of this type will either have the form
 @code{(file t)} or @code{(file string string)}.
 
 This concept of inline is probably hard to understand.  It was certainly
@@ -1405,7 +1414,7 @@ modifying the value of a widget before the user is allowed to edit the
 widget again.  It is enough to call @code{widget-setup} once if you
 modify multiple widgets.  This is currently only necessary if the widget
 contains an editing field, but may be necessary for other widgets in the
-future. 
+future.
 
 If your application needs to associate some information with the widget
 objects, for example a reference to the item being edited, it can be
@@ -1424,11 +1433,12 @@ In @var{widget} return the value for @var{property}.
 @end defun
 
 @defun widget-member widget property
-Non-nil if @var{widget} has a value (even nil) for property @var{property}.
+Non-@code{nil} if @var{widget} has a value (even @code{nil}) for
+property @var{property}.
 @end defun
 
 Occasionally 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. 
+i.e.@: the name of the widget type you gave when the widget was created.
 
 @defun widget-type widget
 Return the name of @var{widget}, a symbol.
@@ -1461,13 +1471,13 @@ a widget is really active, you must therefore activate both it and
 all its ancestors.
 
 @lisp
-(while widget 
+(while widget
   (widget-apply widget :activate)
   (setq widget (widget-get widget :parent)))
 @end lisp
 
 You can check if a widget has been made inactive by examining the value
-of the @code{:inactive} keyword.  If this is non-nil, the widget itself
+of the @code{:inactive} keyword.  If this is non-@code{nil}, the widget itself
 has been deactivated.  This is different from using the @code{:active}
 keyword, in that the latter tells you if the widget @strong{or} any of
 its ancestors have been deactivated.  Do not attempt to set the
@@ -1484,15 +1494,15 @@ its ancestors have been deactivated.  Do not attempt to set the
 You can define specialized widgets with @code{define-widget}.  It allows
 you to create a shorthand for more complex widgets, including specifying
 component widgets and new default values for the keyword
-arguments. 
+arguments.
 
 @defun define-widget name class doc &rest args
 Define a new widget type named @var{name} from @code{class}.
 
 @var{name} and class should both be symbols, @code{class} should be one
-of the existing widget types. 
+of the existing widget types.
 
-The third argument @var{DOC} is a documentation string for the widget.
+The third argument @var{doc} is a documentation string for the widget.
 
 After the new widget has been defined, the following two calls will
 create identical widgets:
@@ -1519,14 +1529,14 @@ If you only want to specify defaults for keywords with no complex
 conversions, you can use @code{identity} as your conversion function.
 
 The following additional keyword arguments are useful when defining new
-widgets: 
+widgets:
 @table @code
 @vindex convert-widget@r{ keyword}
 @item :convert-widget
 Function to convert a widget type before creating a widget of that
 type.  It takes a widget type as an argument, and returns the converted
 widget type.  When a widget is created, this function is called for the
-widget type and all the widget's parent types, most derived first. 
+widget type and all the widget's parent types, most derived first.
 
 The following predefined functions can be used here:
 
@@ -1538,6 +1548,19 @@ Convert @code{:args} as widget types in @var{widget}.
 Initialize @code{:value} from @code{:args} in @var{widget}.
 @end defun
 
+@vindex copy@r{ keyword}
+@item :copy
+Function to deep copy a widget type.  It takes a shallow copy of the
+widget type as an argument (made by @code{copy-sequence}), and returns a
+deep copy.  The purpose of this is to avoid having different instances
+of combined widgets share nested attributes.
+
+The following predefined functions can be used here:
+
+@defun widget-types-copy widget
+Copy @code{:args} as widget types in @var{widget}.
+@end defun
+
 @vindex value-to-internal@r{ keyword}
 @item :value-to-internal
 Function to convert the value to the internal format.  The function
@@ -1565,29 +1588,36 @@ in the buffer, and returns a widget object.
 Function to delete a widget.  The function takes one argument, a widget,
 and should remove all traces of the widget from the buffer.
 
+The default value is:
+
+@defun widget-default-delete widget
+Remove @var{widget} from the buffer.
+Delete all @code{:children} and @code{:buttons} in @var{widget}.
+@end defun
+
+In most cases you should not change this value, but instead use
+@code{:value-delete} to make any additional cleanup.
+
 @vindex value-create@r{ keyword}
 @item :value-create
 Function to expand the @samp{%v} escape in the format string.  It will
 be called with the widget as its argument and should insert a
 representation of the widget's value in the buffer.
 
+Nested widgets should be listed in @code{:children} or @code{:buttons}
+to make sure they are automatically deleted.
+
 @vindex value-delete@r{ keyword}
 @item :value-delete
 Should remove the representation of the widget's value from the buffer.
 It will be called with the widget as its argument.  It doesn't have to
 remove the text, but it should release markers and delete nested widgets
-if such have been used.
-
-The following predefined function can be used here:
-
-@defun widget-children-value-delete widget
-Delete all @code{:children} and @code{:buttons} in @var{widget}.
-@end defun
+if these are not listed in @code{:children} or @code{:buttons}.
 
 @vindex value-get@r{ keyword}
-@item :value-get 
+@item :value-get
 Function to extract the value of a widget, as it is displayed in the
-buffer. 
+buffer.
 
 The following predefined function can be used here:
 
@@ -1610,7 +1640,7 @@ escape sequences, as well as give an error for unknown escapes.
 @vindex action@r{ keyword}
 @item :action
 Function to handle user initiated events.  By default, @code{:notify}
-the parent. 
+the parent.
 
 The following predefined function can be used here:
 
@@ -1625,7 +1655,7 @@ Function to prompt for a value in the minibuffer.  The function should
 take four arguments, @var{widget}, @var{prompt}, @var{value}, and
 @var{unbound} and should return a value for widget entered by the user.
 @var{prompt} is the prompt to use.  @var{value} is the default value to
-use, unless @var{unbound} is non-nil, in which case there is no default
+use, unless @var{unbound} is non-@code{nil}, in which case there is no default
 value.  The function should read the value using the method most natural
 for this widget, and does not have to check that it matches.
 @end table
@@ -1633,11 +1663,11 @@ for this widget, and does not have to check that it matches.
 If you want to define a new widget from scratch, use the @code{default}
 widget as its base.
 
-@deffn Widget default 
-Widget used as a base for other widgets. 
+@deffn Widget default
+Widget used as a base for other widgets.
 
 It provides most of the functionality that is referred to as ``by
-default'' in this text. 
+default'' in this text.
 @end deffn
 
 @node Widget Browser, Widget Minor Mode, Defining New Widgets, Top
@@ -1650,18 +1680,18 @@ programmers who want to examine the content of a widget.  The browser
 shows the value of each keyword, but uses links for certain keywords
 such as @samp{:parent}, which avoids printing cyclic structures.
 
-@deffn Command widget-browse WIDGET
-Create a widget browser for WIDGET.
-When called interactively, prompt for WIDGET.
+@deffn Command widget-browse @var{widget}
+Create a widget browser for @var{widget}.
+When called interactively, prompt for @var{widget}.
 @end deffn
 
-@deffn Command widget-browse-other-window WIDGET
-Create a widget browser for WIDGET and show it in another window.
-When called interactively, prompt for WIDGET.
+@deffn Command widget-browse-other-window @var{widget}
+Create a widget browser for @var{widget} and show it in another window.
+When called interactively, prompt for @var{widget}.
 @end deffn
 
-@deffn Command widget-browse-at POS
-Create a widget browser for the widget at POS.
+@deffn Command widget-browse-at @var{pos}
+Create a widget browser for the widget at @var{pos}.
 When called interactively, use the position of point.
 @end deffn
 
@@ -1672,7 +1702,7 @@ When called interactively, use the position of point.
 
 There is a minor mode for manipulating widgets in major modes that
 don't provide any support for widgets themselves.  This is mostly
-intended to be useful for programmers doing experiments. 
+intended to be useful for programmers doing experiments.
 
 @deffn Command widget-minor-mode
 Toggle minor mode for traversing widgets.
@@ -1691,7 +1721,7 @@ Keymap used in @code{widget-minor-mode}.
 @defun widget-prompt-value widget prompt [ value unbound ]
 Prompt for a value matching @var{widget}, using @var{prompt}.
 The current value is assumed to be @var{value}, unless @var{unbound} is
-non-nil.@refill
+non-@code{nil}.@refill
 @end defun
 
 @defun widget-get-sibling widget
@@ -1705,11 +1735,11 @@ This is only meaningful for radio buttons or checkboxes in a list.
 @cindex todo
 
 @itemize @bullet
-@item 
+@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 
+@item
 The @samp{[INS]} and @samp{[DEL]} buttons should be replaced by a single
 dash (@samp{-}).  The dash should be a button that, when invoked, asks
 whether you want to add or delete an item (@sc{rms} wanted to git rid of
@@ -1727,9 +1757,9 @@ Make indentation work with glyphs and proportional fonts.
 
 @item
 Add commands to show overview of object and class hierarchies to the
-browser. 
+browser.
 
-@item 
+@item
 Find a way to disable mouse highlight for inactive widgets.
 
 @item
@@ -1751,10 +1781,10 @@ Add @code{widget} widget for editing widget specifications.
 Find clean way to implement variable length list.
 See @code{TeX-printer-list} for an explanation.
 
-@item 
+@item
 @kbd{C-h} in @code{widget-prompt-value} should give type specific help.
 
-@item 
+@item
 Add a @code{mailto} widget.
 @end itemize
 
@@ -1769,3 +1799,7 @@ variables, and widgets described in this manual.
 @setchapternewpage odd
 @contents
 @bye
+
+@ignore
+   arch-tag: 2b427731-4c61-4e72-85de-5ccec9c623f0
+@end ignore