[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] Changes to widget.texi
|
From: |
Glenn Morris |
|
Subject: |
[Emacs-diffs] Changes to widget.texi |
|
Date: |
Thu, 06 Sep 2007 04:41:51 +0000 |
CVSROOT: /sources/emacs
Module name: emacs
Changes by: Glenn Morris <gm> 07/09/06 04:41:51
Index: widget.texi
===================================================================
RCS file: widget.texi
diff -N widget.texi
--- widget.texi 15 Apr 2007 20:57:15 -0000 1.44
+++ /dev/null 1 Jan 1970 00:00:00 -0000
@@ -1,1855 +0,0 @@
-\input texinfo.tex
-
address@hidden %**start of header
address@hidden ../info/widget
address@hidden The Emacs Widget Library
address@hidden fn cp
address@hidden vr cp
address@hidden ky cp
address@hidden
address@hidden %**end of header
-
address@hidden
-Copyright @copyright{} 2000, 2001, 2002, 2003, 2004, 2005,
-2006, 2007 Free Software Foundation, Inc.
-
address@hidden
-Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.2 or
-any later version published by the Free Software Foundation; with the
-Invariant Sections being ``The GNU Manifesto'', ``Distribution'' and
-``GNU GENERAL PUBLIC LICENSE'', with the Front-Cover texts being ``A GNU
-Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
-license is included in the section entitled ``GNU Free Documentation
-License'' in the Emacs manual.
-
-This document is part of a collection distributed under the GNU Free
-Documentation License. If you want to distribute this document
-separately from the collection, you can do so by adding a copy of the
-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.''
address@hidden quotation
address@hidden copying
-
address@hidden Emacs
address@hidden
-* Widget: (widget). The "widget" package used by the Emacs Customization
- facility.
address@hidden direntry
-
address@hidden Top, Introduction, (dir), (dir)
address@hidden node-name, next, previous, up
address@hidden The Emacs Widget Library
-
address@hidden
-* 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::
-* GNU Free Documentation License::
-* Index::
address@hidden menu
-
address@hidden Introduction, User Interface, Top, Top
address@hidden node-name, next, previous, up
address@hidden Introduction
-
-Most graphical user interface toolkits provide a number of standard
-user interface controls (sometimes known as `widgets' or `gadgets').
-Emacs doesn't really support anything like this, except for an
-incredibly powerful text ``widget.'' On the other hand, Emacs does
-provide the necessary primitives to implement many other widgets
-within a text buffer. The @code{widget} package simplifies this task.
-
address@hidden basic widgets
address@hidden widgets, basic types
-The basic widgets are:
-
address@hidden @code
address@hidden link
-Areas of text with an associated action. Intended for hypertext links
-embedded in text.
address@hidden push-button
-Like link, but intended for stand-alone buttons.
address@hidden editable-field
-An editable text field. It can be either variable or fixed length.
address@hidden menu-choice
-Allows the user to choose one of multiple options from a menu, each
-option is itself a widget. Only the selected option will be visible in
-the buffer.
address@hidden radio-button-choice
-Allows the user to choose one of multiple options by activating radio
-buttons. The options are implemented as widgets. All options will be
-visible in the buffer.
address@hidden item
-A simple constant widget intended to be used in the @code{menu-choice} and
address@hidden widgets.
address@hidden 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.
address@hidden toggle
-A simple @samp{on}/@samp{off} switch.
address@hidden checkbox
-A checkbox (@samp{[ ]}/@samp{[X]}).
address@hidden editable-list
-Create an editable list. The user can insert or delete items in the
-list. Each list item is itself a widget.
address@hidden table
-
-Now, 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 for
-implementing forms. A @dfn{form} in Emacs is a buffer where the user is
-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 @acronym{HTML} form support in the @file{w3} browser.
-
address@hidden widget library, why use it
-The advantages for a programmer of using the @code{widget} package to
-implement forms are:
-
address@hidden
address@hidden
-More complex fields than just editable text are supported.
address@hidden
-You can give the users immediate feedback if they enter invalid data in a
-text field, and sometimes prevent entering invalid data.
address@hidden
-You can have fixed sized fields, thus allowing multiple fields to be
-lined up in columns.
address@hidden
-It is simple to query or set the value of a field.
address@hidden
-Editing happens in the buffer, not in the mini-buffer.
address@hidden
-Packages using the library get a uniform look, making them easier for
-the user to learn.
address@hidden
-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.
address@hidden enumerate
-
-In order to minimize the code that is loaded by users who do not
-create any widgets, the code has been split in two files:
-
address@hidden widget library, files
address@hidden @file
address@hidden widget.el
-This will declare the user variables, define the function
address@hidden, and autoload the function @code{widget-create}.
address@hidden wid-edit.el
-Everything else is here, there is no reason to load it explicitly, as
-it will be autoloaded when needed.
address@hidden table
-
address@hidden User Interface, Programming Example, Introduction, Top
address@hidden node-name, next, previous, up
address@hidden User Interface
-
-A form consists of read only text for documentation and some fields,
-where each field contains two parts, a tag and a value. The tags are
-used to identify the fields, so the documentation can refer to the
address@hidden field}, meaning the field tagged with @samp{Foo}. Here is an
-example form:
-
address@hidden
-Here is some documentation.
-
-Name: @i{My Name} @strong{Choose}: This option
-Address: @i{Some Place
-In some City
-Some country.}
-
-See also @b{_other work_} for more information.
-
-Numbers: count to three below
address@hidden @b{[DEL]} @i{One}
address@hidden @b{[DEL]} @i{Eh, two?}
address@hidden @b{[DEL]} @i{Five!}
address@hidden
-
-Select multiple:
-
address@hidden This
address@hidden ]} That
address@hidden Thus
-
-Select one:
-
address@hidden(*)} One
address@hidden( )} Another One.
address@hidden( )} A Final One.
-
address@hidden Form]} @b{[Reset Form]}
address@hidden example
-
-The top level widgets in this example are tagged @samp{Name},
address@hidden, @samp{Address}, @samp{_other work_}, @samp{Numbers},
address@hidden multiple}, @samp{Select one}, @samp{[Apply Form]}, and
address@hidden Form]}. There are basically two things the user can do
-within a form, namely editing the editable text fields and activating
-the buttons.
-
address@hidden Editable Text Fields
-
-In the example, the value for the @samp{Name} is most likely displayed
-in an editable text field, and so are values for each of the members of
-the @samp{Numbers} list. All the normal Emacs editing operations are
-available for editing these fields. The only restriction is that each
-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.
-
-Editable text fields are created by the @code{editable-field} widget.
-
address@hidden:} In an @code{editable-field} widget, the editable
-field must not be adjacent to another widget---that won't work.
-You must put some text in between. Either make this text part of
-the @code{editable-field} widget itself, or insert it with
address@hidden
-
-The @code{:format} keyword is useful for generating the necessary
-text; for instance, if you give it a value of @code{"Name: %v "},
-the @samp{Name: } part will provide the necessary separating text
-before the field and the trailing space will provide the
-separating text after the field. If you don't include the
address@hidden:size} keyword, the field will extend to the end of the
-line, and the terminating newline will provide separation after.
-
address@hidden:} In an @code{editable-field} widget, the @samp{%v} escape
-must be preceded by some other text in the @code{:format} string
-(if specified).
-
-The editing text fields are highlighted with the
address@hidden face, making them easy to find.
-
address@hidden Face widget-field-face
-Face used for other editing fields.
address@hidden deffn
-
address@hidden Buttons
-
address@hidden widget buttons
address@hidden button widgets
-Some portions of the buffer have an associated @dfn{action}, which can
-be @dfn{invoked} by a standard key or mouse command. These portions
-are called @dfn{buttons}. The default commands for activating a button
-are:
-
address@hidden @kbd
address@hidden @key{RET}
address@hidden Command widget-button-press @var{pos} &optional @var{event}
-Invoke the button at @var{pos}, defaulting to point.
-If point is not located on a button, invoke the binding in
address@hidden (by default the global map).
address@hidden deffn
-
address@hidden Mouse-2 @r{(on button widgets})
address@hidden Mouse-2
address@hidden Command widget-button-click @var{event}
-Invoke the button at the location of the mouse pointer. If the mouse
-pointer is located in an editable text field, invoke the binding in
address@hidden (by default the global map).
address@hidden deffn
address@hidden table
-
-There are several different kind of buttons, all of which are present in
-the example:
-
address@hidden @emph
address@hidden option field tag
address@hidden The Option Field Tags
-When you invoke one of these buttons, you will be asked to choose
-between a number of different options. This is how you edit an option
-field. Option fields are created by the @code{menu-choice} widget. In
-the example, @address@hidden is an option field tag.
address@hidden The @address@hidden and @address@hidden buttons
-Activating these will insert or delete elements from an editable list.
-The list is created by the @code{editable-list} widget.
address@hidden embedded buttons
address@hidden Embedded Buttons
-The @address@hidden work_}} is an example of an embedded
-button. Embedded buttons are not associated with any fields, but can serve
-any purpose, such as implementing hypertext references. They are
-usually created by the @code{link} widget.
address@hidden The @address@hidden ]}} and @address@hidden buttons
-Activating one of these will convert it to the other. This is useful
-for implementing multiple-choice fields. You can create them with the
address@hidden widget.
address@hidden The @address@hidden( )}} and @address@hidden(*)}} buttons
-Only one radio button in a @code{radio-button-choice} widget can be
-selected at any time. When you invoke one of the unselected radio
-buttons, it will be selected and the previous selected radio button will
-become unselected.
address@hidden The @address@hidden Form]}} and @address@hidden Form]}} buttons
-These are explicit buttons made with the @code{push-button} widget. The
-main difference from the @code{link} widget is that the buttons will be
-displayed as GUI buttons when possible.
address@hidden table
-
-To make them easier to locate, buttons are emphasized in the buffer.
-
address@hidden Face widget-button-face
-Face used for buttons.
address@hidden deffn
-
address@hidden widget-mouse-face
-Face used for highlighting a button when the mouse pointer moves across
-it.
address@hidden defopt
-
address@hidden Navigation
-
-You can use all the normal Emacs commands to move around in a form
-buffer, plus you will have these additional commands:
-
address@hidden @kbd
address@hidden @key{TAB}
address@hidden Command widget-forward &optional count
-Move point @var{count} buttons or editing fields forward.
address@hidden deffn
address@hidden @address@hidden
address@hidden @address@hidden
address@hidden Command widget-backward &optional count
-Move point @var{count} buttons or editing fields backward.
address@hidden deffn
address@hidden table
-
address@hidden Programming Example, Setting Up the Buffer, User Interface, Top
address@hidden node-name, next, previous, up
address@hidden Programming Example
-
address@hidden widgets, programming example
address@hidden example of using widgets
-Here is the code to implement the user interface example (@pxref{User
-Interface}).
-
address@hidden
-(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))
- (remove-overlays)
- (widget-insert "Here is some documentation.\n\n")
- (widget-create 'editable-field
- :size 13
- :format "Name: %v " ; Text after the field!
- "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-create 'editable-field
- :format "Address: %v"
- "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 "Another 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))
address@hidden lisp
-
address@hidden Setting Up the Buffer, Basic Types, Programming Example, Top
address@hidden node-name, next, previous, up
address@hidden Setting Up the Buffer
-
-Widgets are created with @code{widget-create}, which returns a
address@hidden object. This object can be queried and manipulated by
-other widget functions, until it is deleted with @code{widget-delete}.
-After the widgets have been created, @code{widget-setup} must be called
-to enable them.
-
address@hidden widget-create type [ keyword argument address@hidden
-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 arguments
-that are part of @var{type}.
address@hidden defun
-
address@hidden widget-delete widget
-Delete @var{widget} and remove it from the buffer.
address@hidden defun
-
address@hidden 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.
address@hidden
address@hidden defun
-
-If you want to insert text outside the widgets in the form, the
-recommended way to do that is with @code{widget-insert}.
-
address@hidden widget-insert
-Insert the arguments, either strings or characters, at point.
-The inserted text will be read-only.
address@hidden defun
-
-There is a standard widget keymap which you might find useful.
-
address@hidden widget-button-press
address@hidden widget-button-click
address@hidden Const widget-keymap
-A keymap with the global keymap as its address@hidden
address@hidden and @address@hidden are bound to @code{widget-forward} and
address@hidden, respectively. @key{RET} and @kbd{Mouse-2}
-are bound to @code{widget-button-press} and
address@hidden@refill
address@hidden defvr
-
address@hidden widget-global-map
-Keymap used by @code{widget-button-press} and @code{widget-button-click}
-when not on a button. By default this is @code{global-map}.
address@hidden defvar
-
address@hidden Basic Types, Sexp Types, Setting Up the Buffer, Top
address@hidden node-name, next, previous, up
address@hidden Basic Types
-
-This is the general syntax of a type specification:
-
address@hidden
address@hidden ::= (@var{name} address@hidden @var{argument}]... @var{args})
- | @var{name}
address@hidden example
-
-Where, @var{name} is a widget name, @var{keyword} is the name of a
-property, @var{argument} is the value of the property, and @var{args}
-are interpreted in a widget specific way.
-
address@hidden keyword arguments
-The following keyword arguments apply to all widgets:
-
address@hidden @code
address@hidden address@hidden keyword}
address@hidden :value
-The initial value for widgets of this type.
-
address@hidden address@hidden keyword}
address@hidden :format
-This string will be inserted in the buffer when you create a widget.
-The following @samp{%} escapes are available:
-
address@hidden @samp
address@hidden %[
address@hidden %]
-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.
-
address@hidden widget-button-prefix
-String to prefix buttons.
address@hidden defopt
-
address@hidden widget-button-suffix
-String to suffix buttons.
address@hidden defopt
-
address@hidden address@hidden
address@hidden address@hidden
-The text inside will be displayed with the face specified by
address@hidden:sample-face}.
-
address@hidden %v
-This will be replaced with the buffer representation of the widget's
-value. What this is depends on the widget type.
-
address@hidden:} In an @code{editable-field} widget, the @samp{%v} escape
-must be preceded by some other text in the format string (if specified).
-
address@hidden %d
-Insert the string specified by @code{:doc} here.
-
address@hidden %h
-Like @samp{%d}, with the following modifications: If the documentation
-string is more than one line, it will add a button which will toggle
-between showing only the first line, and showing the full text.
-Furthermore, if there is no @code{:doc} property in the widget, it will
-instead examine the @code{:documentation-property} property. If it is a
-lambda expression, it will be called with the widget's value as an
-argument, and the result will be used as the documentation text.
-
address@hidden %t
-Insert the string specified by @code{:tag} here, or the @code{princ}
-representation of the value if there is no tag.
-
address@hidden %%
-Insert a literal @samp{%}.
address@hidden table
-
address@hidden address@hidden keyword}
address@hidden :button-face
-Face used to highlight text inside %[ %] in the format.
-
address@hidden address@hidden keyword}
address@hidden address@hidden keyword}
address@hidden :button-prefix
address@hidden :button-suffix
-Text around %[ %] in the format.
-
-These can be
address@hidden @emph
address@hidden nil
-No text is inserted.
-
address@hidden a string
-The string is inserted literally.
-
address@hidden a symbol
-The value of the symbol is expanded according to this table.
address@hidden table
-
address@hidden address@hidden keyword}
address@hidden :doc
-The string inserted by the @samp{%d} escape in the format
-string.
-
address@hidden address@hidden keyword}
address@hidden :tag
-The string inserted by the @samp{%t} escape in the format
-string.
-
address@hidden address@hidden keyword}
address@hidden :tag-glyph
-Name of image to use instead of the string specified by @code{:tag} on
-Emacsen that supports it.
-
address@hidden address@hidden keyword}
address@hidden :help-echo
-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, a function of one argument, the widget,
-which should return a string to display, or a form that evaluates to
-such a string.
-
address@hidden address@hidden keyword}
address@hidden :follow-link
-Specifies how to interpret a @key{mouse-1} click on the widget.
address@hidden and Mouse-1,,, elisp, the Emacs Lisp Reference Manual}.
-
address@hidden address@hidden keyword}
address@hidden :indent
-An integer indicating the absolute number of spaces to indent children
-of this widget.
-
address@hidden address@hidden keyword}
address@hidden :offset
-An integer indicating how many extra spaces to add to the widget's
-grandchildren compared to this widget.
-
address@hidden address@hidden keyword}
address@hidden :extra-offset
-An integer indicating how many extra spaces to add to the widget's
-children compared to this widget.
-
address@hidden address@hidden keyword}
address@hidden :notify
-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.
-
address@hidden address@hidden keyword}
address@hidden :menu-tag
-Tag used in the menu when the widget is used as an option in a
address@hidden widget.
-
address@hidden address@hidden keyword}
address@hidden :menu-tag-get
-Function used for finding the tag when the widget is used as an option
-in a @code{menu-choice} widget. By default, the tag used will be either the
address@hidden:menu-tag} or @code{:tag} property if present, or the @code{princ}
-representation of the @code{:value} property if not.
-
address@hidden address@hidden keyword}
address@hidden :match
-Should be a function called with two arguments, the widget and a value,
-and returning address@hidden if the widget can represent the specified value.
-
address@hidden address@hidden keyword}
address@hidden :validate
-A function which takes a widget as an argument, and returns @code{nil}
-if the widget's current value is valid for the widget. Otherwise it
-should return the widget containing the invalid data, and set that
-widget's @code{:error} property to a string explaining the error.
-
-The following predefined function can be used:
-
address@hidden widget-children-validate widget
-All the @code{:children} of @var{widget} must be valid.
address@hidden defun
-
address@hidden address@hidden keyword}
address@hidden :tab-order
-Specify the order in which widgets are traversed with
address@hidden or @code{widget-backward}. This is only partially
-implemented.
-
address@hidden a
address@hidden
-Widgets with tabbing order @code{-1} are ignored.
-
address@hidden
-(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.
-
address@hidden
-When on a widget with no tabbing order specified, go to the next widget
-in the buffer with a positive tabbing order, or @code{nil}
address@hidden enumerate
-
address@hidden address@hidden keyword}
address@hidden :parent
-The parent of a nested widget (e.g.@: a @code{menu-choice} item or an
-element of a @code{editable-list} widget).
-
address@hidden address@hidden keyword}
address@hidden :sibling-args
-This keyword is only used for members of a @code{radio-button-choice} or
address@hidden The value should be a list of extra keyword
-arguments, which will be used when creating the @code{radio-button} or
address@hidden associated with this item.
-
address@hidden table
-
address@hidden {User Option} widget-glyph-directory
-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.
address@hidden deffn
-
address@hidden Option} widget-glyph-enable
-If address@hidden, allow glyphs to appear on displays where they are supported.
address@hidden deffn
-
-
address@hidden
-* link::
-* url-link::
-* info-link::
-* push-button::
-* editable-field::
-* text::
-* menu-choice::
-* radio-button-choice::
-* item::
-* choice-item::
-* toggle::
-* checkbox::
-* checklist::
-* editable-list::
-* group::
address@hidden menu
-
address@hidden link, url-link, Basic Types, Basic Types
address@hidden node-name, next, previous, up
address@hidden The @code{link} Widget
address@hidden address@hidden widget}
-
-Syntax:
-
address@hidden
address@hidden ::= (link address@hidden @var{argument}]... [ @var{value} ])
address@hidden example
-
-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.
-
-By default the link will be shown in brackets.
-
address@hidden widget-link-prefix
-String to prefix links.
address@hidden defopt
-
address@hidden widget-link-suffix
-String to suffix links.
address@hidden defopt
-
address@hidden url-link, info-link, link, Basic Types
address@hidden node-name, next, previous, up
address@hidden The @code{url-link} Widget
address@hidden address@hidden widget}
-
-Syntax:
-
address@hidden
address@hidden ::= (url-link address@hidden @var{argument}]... @var{url})
address@hidden example
-
address@hidden address@hidden, and @code{url-link} widget}
-When this link is invoked, the @acronym{WWW} browser specified by
address@hidden will be called with @var{url}.
-
address@hidden info-link, push-button, url-link, Basic Types
address@hidden node-name, next, previous, up
address@hidden The @code{info-link} Widget
address@hidden address@hidden widget}
-
-Syntax:
-
address@hidden
address@hidden ::= (info-link address@hidden @var{argument}]... @var{address})
address@hidden example
-
-When this link is invoked, the built-in Info reader is started on
address@hidden
-
address@hidden push-button, editable-field, info-link, Basic Types
address@hidden node-name, next, previous, up
address@hidden The @code{push-button} Widget
address@hidden address@hidden widget}
-
-Syntax:
-
address@hidden
address@hidden ::= (push-button address@hidden @var{argument}]... [
@var{value} ])
address@hidden example
-
-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.
-
-By default the tag will be shown in brackets.
-
address@hidden widget-push-button-prefix
-String to prefix push buttons.
address@hidden defopt
-
address@hidden widget-push-button-suffix
-String to suffix push buttons.
address@hidden defopt
-
address@hidden editable-field, text, push-button, Basic Types
address@hidden node-name, next, previous, up
address@hidden The @code{editable-field} Widget
address@hidden address@hidden widget}
-
-Syntax:
-
address@hidden
address@hidden ::= (editable-field address@hidden @var{argument}]... [
@var{value} ])
address@hidden example
-
-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
-field. This widget will match all string values.
-
-The following extra properties are recognized:
-
address@hidden @code
address@hidden address@hidden keyword}
address@hidden :size
-The width of the editable address@hidden
-By default the field will reach to the end of the line.
-
address@hidden address@hidden keyword}
address@hidden :value-face
-Face used for highlighting the editable field. Default is
address@hidden, see @ref{User Interface}.
-
address@hidden address@hidden keyword}
address@hidden :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 @code{nil}, and the value is not secret.
-
address@hidden address@hidden keyword}
address@hidden :valid-regexp
-By default the @code{:validate} function will match the content of the
-field with the value of this attribute. The default value is @code{""}
-which matches everything.
-
address@hidden address@hidden keyword}
address@hidden widget-field-keymap
address@hidden :keymap
-Keymap used in the editable field. The default value is
address@hidden, which allows you to use all the normal
-editing commands, even if the buffer's major mode suppresses some of
-them. Pressing @key{RET} invokes the function specified by
address@hidden:action}.
address@hidden table
-
address@hidden text, menu-choice, editable-field, Basic Types
address@hidden node-name, next, previous, up
address@hidden The @code{text} Widget
address@hidden address@hidden widget}
-
address@hidden widget-text-keymap
-This is just like @code{editable-field}, but intended for multiline text
-fields. The default @code{:keymap} is @code{widget-text-keymap}, which
-does not rebind the @key{RET} key.
-
address@hidden menu-choice, radio-button-choice, text, Basic Types
address@hidden node-name, next, previous, up
address@hidden The @code{menu-choice} Widget
address@hidden address@hidden widget}
-
-Syntax:
-
address@hidden
address@hidden ::= (menu-choice address@hidden @var{argument}]... @var{type}
... )
address@hidden example
-
-The @var{type} argument represents each possible choice. The widget's
-value will be that of the chosen @var{type} argument. This widget will
-match any value matching at least one of the specified @var{type}
-arguments.
-
address@hidden @code
address@hidden address@hidden keyword}
address@hidden :void
-Widget type used as a fallback when the value does not match any of the
-specified @var{type} arguments.
-
address@hidden address@hidden keyword}
address@hidden :case-fold
-Set this to @code{nil} if you don't want to ignore case when prompting for a
-choice through the minibuffer.
-
address@hidden address@hidden keyword}
address@hidden :children
-A list whose @sc{car} is the widget representing the currently chosen
-type in the buffer.
-
address@hidden address@hidden keyword}
address@hidden :choice
-The current chosen type.
-
address@hidden address@hidden keyword}
address@hidden :args
-The list of types.
address@hidden table
-
address@hidden radio-button-choice, item, menu-choice, Basic Types
address@hidden node-name, next, previous, up
address@hidden The @code{radio-button-choice} Widget
address@hidden address@hidden widget}
-
-Syntax:
-
address@hidden
address@hidden ::= (radio-button-choice address@hidden @var{argument}]...
@var{type} ... )
address@hidden example
-
-The component types specify the choices, with one radio button for
-each. The widget's value will be that of the chosen @var{type}
-argument. This widget matches any value that matches at least one of
-the specified @var{type} arguments.
-
-The following extra properties are recognized.
-
address@hidden @code
address@hidden address@hidden keyword}
address@hidden :entry-format
-This string will be inserted for each entry in the list.
-The following @samp{%} escapes are available:
address@hidden @samp
address@hidden %v
-Replace with the buffer representation of the @var{type} widget.
address@hidden %b
-Replace with the radio button.
address@hidden %%
-Insert a literal @samp{%}.
address@hidden table
-
address@hidden address@hidden keyword}
address@hidden :button-args
-A list of keywords to pass to the radio buttons. Useful for setting
-e.g.@: the @samp{:help-echo} for each button.
-
address@hidden address@hidden keyword}
address@hidden :buttons
-The widgets representing the radio buttons.
-
address@hidden address@hidden keyword}
address@hidden :children
-The widgets representing each type.
-
address@hidden address@hidden keyword}
address@hidden :choice
-The current chosen type
-
address@hidden address@hidden keyword}
address@hidden :args
-The list of types.
address@hidden table
-
-You can add extra radio button items to a @code{radio-button-choice}
-widget after it has been created with the function
address@hidden
-
address@hidden widget-radio-add-item widget type
-Add to @code{radio-button-choice} widget @var{widget} a new radio button
-item of type @var{type}.
address@hidden defun
-
-Please note that such items added after the @code{radio-button-choice}
-widget has been created will @strong{not} be properly destructed when
-you call @code{widget-delete}.
-
address@hidden item, choice-item, radio-button-choice, Basic Types
address@hidden node-name, next, previous, up
address@hidden The @code{item} Widget
address@hidden address@hidden widget}
-
-Syntax:
-
address@hidden
address@hidden ::= (item address@hidden @var{argument}]... @var{value})
address@hidden example
-
-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. This widget will only match the specified value.
-
address@hidden choice-item, toggle, item, Basic Types
address@hidden node-name, next, previous, up
address@hidden The @code{choice-item} Widget
address@hidden address@hidden widget}
-
-Syntax:
-
address@hidden
address@hidden ::= (choice-item address@hidden @var{argument}]... @var{value})
address@hidden example
-
-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.
-
address@hidden toggle, checkbox, choice-item, Basic Types
address@hidden node-name, next, previous, up
address@hidden The @code{toggle} Widget
address@hidden address@hidden widget}
-
-Syntax:
-
address@hidden
address@hidden ::= (toggle address@hidden @var{argument}]...)
address@hidden example
-
-The widget has two possible states, @samp{on} and @samp{off}, which
-correspond to a @code{t} or @code{nil} value, respectively.
-
-The following extra properties are recognized:
-
address@hidden @code
address@hidden :on
-A string representing the @samp{on} state. By default the string
address@hidden
address@hidden :off
-A string representing the @samp{off} state. By default the string
address@hidden
address@hidden address@hidden keyword}
address@hidden :on-glyph
-Name of a glyph to be used instead of the @samp{:on} text string, on
-emacsen that supports this.
address@hidden address@hidden keyword}
address@hidden :off-glyph
-Name of a glyph to be used instead of the @samp{:off} text string, on
-emacsen that supports this.
address@hidden table
-
address@hidden checkbox, checklist, toggle, Basic Types
address@hidden node-name, next, previous, up
address@hidden The @code{checkbox} Widget
address@hidden address@hidden widget}
-
-This widget has two possible states, @samp{selected} and
address@hidden, which corresponds to a @code{t} or @code{nil} value.
-
-Syntax:
-
address@hidden
address@hidden ::= (checkbox address@hidden @var{argument}]...)
address@hidden example
-
address@hidden checklist, editable-list, checkbox, Basic Types
address@hidden node-name, next, previous, up
address@hidden The @code{checklist} Widget
address@hidden address@hidden widget}
-
-Syntax:
-
address@hidden
address@hidden ::= (checklist address@hidden @var{argument}]... @var{type} ...
)
address@hidden example
-
-The @var{type} arguments represent each checklist item. The widget's
-value will be a list containing the values of all checked @var{type}
-arguments. The checklist widget will match a list whose elements all
-match at least one of the specified @var{type} arguments.
-
-The following extra properties are recognized:
-
address@hidden @code
address@hidden address@hidden keyword}
address@hidden :entry-format
-This string will be inserted for each entry in the list.
-The following @samp{%} escapes are available:
address@hidden @samp
address@hidden %v
-Replaced with the buffer representation of the @var{type} widget.
address@hidden %b
-Replace with the checkbox.
address@hidden %%
-Insert a literal @samp{%}.
address@hidden table
-
address@hidden address@hidden keyword}
address@hidden :greedy
-Usually a checklist will only match if the items are in the exact
-sequence given in the specification. By setting @code{:greedy} to
address@hidden, 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.
-
address@hidden address@hidden keyword}
address@hidden :button-args
-A list of keywords to pass to the checkboxes. Useful for setting
-e.g.@: the @samp{:help-echo} for each checkbox.
-
address@hidden address@hidden keyword}
address@hidden :buttons
-The widgets representing the checkboxes.
-
address@hidden address@hidden keyword}
address@hidden :children
-The widgets representing each type.
-
address@hidden address@hidden keyword}
address@hidden :args
-The list of types.
address@hidden table
-
address@hidden editable-list, group, checklist, Basic Types
address@hidden node-name, next, previous, up
address@hidden The @code{editable-list} Widget
address@hidden address@hidden widget}
-
-Syntax:
-
address@hidden
address@hidden ::= (editable-list address@hidden @var{argument}]... @var{type})
address@hidden example
-
-The value is a list, where each member represents one widget of type
address@hidden
-
-The following extra properties are recognized:
-
address@hidden @code
address@hidden address@hidden keyword}
address@hidden :entry-format
-This string will be inserted for each entry in the list.
-The following @samp{%} escapes are available:
address@hidden @samp
address@hidden %v
-This will be replaced with the buffer representation of the @var{type}
-widget.
address@hidden %i
-Insert the @b{[INS]} button.
address@hidden %d
-Insert the @b{[DEL]} button.
address@hidden %%
-Insert a literal @samp{%}.
address@hidden table
-
address@hidden address@hidden keyword}
address@hidden :insert-button-args
-A list of keyword arguments to pass to the insert buttons.
-
address@hidden address@hidden keyword}
address@hidden :delete-button-args
-A list of keyword arguments to pass to the delete buttons.
-
address@hidden address@hidden keyword}
address@hidden :append-button-args
-A list of keyword arguments to pass to the trailing insert button.
-
address@hidden address@hidden keyword}
address@hidden :buttons
-The widgets representing the insert and delete buttons.
-
address@hidden address@hidden keyword}
address@hidden :children
-The widgets representing the elements of the list.
-
address@hidden address@hidden keyword}
address@hidden :args
-List whose @sc{car} is the type of the list elements.
address@hidden table
-
address@hidden group, , editable-list, Basic Types
address@hidden node-name, next, previous, up
address@hidden The @code{group} Widget
address@hidden address@hidden widget}
-
-This widget simply group other widgets together.
-
-Syntax:
-
address@hidden
address@hidden ::= (group address@hidden @var{argument}]... @var{type}...)
address@hidden example
-
-The value is a list, with one member for each @var{type}.
-
address@hidden Sexp Types, Widget Properties, Basic Types, Top
address@hidden
address@hidden Sexp Types
address@hidden sexp types
-
-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.
-
address@hidden
-* constants::
-* generic::
-* atoms::
-* composite::
address@hidden menu
-
address@hidden constants, generic, Sexp Types, Sexp Types
address@hidden node-name, next, previous, up
address@hidden The Constant Widgets
address@hidden constant widgets
-
-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.
-
-The syntax for the @code{const} widget is:
-
address@hidden
address@hidden ::= (const address@hidden @var{argument}]... [ @var{value} ])
address@hidden example
-
-The @var{value}, if present, is used to initialize the @code{:value}
-property and can be any s-expression.
-
address@hidden Widget const
-This will display any valid s-expression in an immutable part of the
-buffer.
address@hidden deffn
-
-There are two variations of the @code{const} widget, namely
address@hidden and @code{function-item}. These should contain a
-symbol with a variable or function binding. The major difference from
-the @code{const} widget is that they will allow the user to see the
-variable or function documentation for the symbol.
-
address@hidden Widget variable-item
-An immutable symbol that is bound as a variable.
address@hidden deffn
-
address@hidden Widget function-item
-An immutable symbol that is bound as a function.
address@hidden deffn
-
address@hidden generic, atoms, constants, Sexp Types
address@hidden node-name, next, previous, up
address@hidden Generic Sexp Widget
address@hidden generic sexp widget
-
-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:
-
address@hidden
address@hidden ::= (sexp address@hidden @var{argument}]... [ @var{value} ])
address@hidden example
-
address@hidden Widget sexp
-This will allow you to edit any valid s-expression in an editable buffer
-field.
-
-The @code{sexp} widget takes the same keyword arguments as the
address@hidden widget. @xref{editable-field}.
address@hidden deffn
-
address@hidden atoms, composite, generic, Sexp Types
address@hidden node-name, next, previous, up
address@hidden Atomic Sexp Widgets
address@hidden atomic sexp widget
-
-The atoms are s-expressions that do not consist of other s-expressions.
-For example, a string, a file name, or a symbol are atoms, 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:
-
address@hidden
address@hidden ::= (@var{construct} address@hidden @var{argument}]... [
@var{value} ])
address@hidden example
-
-The @var{value}, if present, is used to initialize the @code{:value}
-property and must be an expression of the same type as the widget.
-That is, the string widget can only be initialized with a string.
-
-All the atom widgets take the same keyword arguments as the
address@hidden widget. @xref{editable-field}.
-
address@hidden Widget string
-Allows you to edit a string in an editable field.
address@hidden deffn
-
address@hidden Widget regexp
-Allows you to edit a regular expression in an editable field.
address@hidden deffn
-
address@hidden Widget character
-Allows you to enter a character in an editable field.
address@hidden deffn
-
address@hidden Widget file
-Allows you to edit a file name in an editable field.
-
-Keywords:
address@hidden @code
address@hidden address@hidden keyword}
address@hidden :must-match
-If this is set to address@hidden, only existing file names will be
-allowed in the minibuffer.
address@hidden table
address@hidden deffn
-
address@hidden Widget directory
-Allows you to edit a directory name in an editable field.
-Similar to the @code{file} widget.
address@hidden deffn
-
address@hidden Widget symbol
-Allows you to edit a Lisp symbol in an editable field.
address@hidden deffn
-
address@hidden Widget function
-Allows you to edit a lambda expression, or a function name with completion.
address@hidden deffn
-
address@hidden Widget variable
-Allows you to edit a variable name, with completion.
address@hidden deffn
-
address@hidden Widget integer
-Allows you to edit an integer in an editable field.
address@hidden deffn
-
address@hidden Widget number
-Allows you to edit a number in an editable field.
address@hidden deffn
-
address@hidden Widget boolean
-Allows you to edit a boolean. In Lisp this means a variable which is
-either @code{nil} meaning false, or address@hidden meaning true.
address@hidden deffn
-
-
address@hidden composite, , atoms, Sexp Types
address@hidden node-name, next, previous, up
address@hidden Composite Sexp Widgets
address@hidden composite sexp widgets
-
-The syntax for the composite widget construct is:
-
address@hidden
address@hidden ::= (@var{construct} address@hidden @var{argument}]...
@var{component}...)
address@hidden example
-
address@hidden
-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.
-
address@hidden Widget cons
-The value of a @code{cons} widget must be a cons-cell whose @sc{car}
-and @sc{cdr} have two specified types. It uses this syntax:
-
address@hidden
address@hidden ::= (cons address@hidden @var{argument}]... @var{car-type}
@var{cdr-type})
address@hidden example
address@hidden deffn
-
address@hidden Widget choice
-The value matched by a @code{choice} widget must have one of a fixed
-set of types. The widget's syntax is as follows:
-
address@hidden
address@hidden ::= (choice address@hidden @var{argument}]... @var{type} ... )
address@hidden example
-
-The value of a @code{choice} widget can be anything that matches any of the
address@hidden
address@hidden deffn
-
address@hidden Widget list
-The value of a @code{list} widget must be a list whose element types
-match the specified component types:
-
address@hidden
address@hidden ::= (list address@hidden @var{argument}]...
@var{component-type}...)
address@hidden example
-
-Thus, @code{(list string number)} matches lists of two elements,
-the first being a string and the second being a number.
address@hidden deffn
-
address@hidden Widget vector
-The @code{vector} widget is like the @code{list} widget but matches
-vectors instead of lists. Thus, @code{(vector string number)} matches
-vectors of two elements, the first being a string and the second being
-a number.
address@hidden deffn
-
-The above suffice for specifying fixed size lists and vectors. To get
-variable length lists and vectors, you can use a @code{choice},
address@hidden, or @code{repeat} widget together with the @code{:inline}
-keyword. If any component of a composite widget has the
address@hidden:inline} keyword set, its value must be a list which will then
-be spliced into the composite. For example, to specify a list whose
-first element must be a file name, and whose remaining elements should
-either be the symbol @code{t} or two strings (file names), you can use
-the following widget specification:
-
address@hidden
-(list file
- (choice (const t)
- (list :inline t
- :value ("foo" "bar")
- string string)))
address@hidden example
-
-The value of a widget of this type will either have the form
address@hidden(file t)} or @code{(file @var{string} @var{string})}.
-
-This concept of @code{:inline} may be hard to understand. It was
-certainly hard to implement, so instead of confusing you more by
-trying to explain it here, I'll just suggest you meditate over it for
-a while.
-
address@hidden Widget set
-Specifies a type whose values are the lists whose elements all belong
-to a given set. The order of elements of the list is not significant.
-Here's the syntax:
-
address@hidden
address@hidden ::= (set address@hidden @var{argument}]...
@var{permitted-element} ... )
address@hidden example
-
-Use @code{const} to specify each permitted element, like this:
address@hidden(set (const a) (const b))}.
address@hidden deffn
-
address@hidden Widget repeat
-Specifies a list of any number of elements that fit a certain type.
-
address@hidden
address@hidden ::= (repeat address@hidden @var{argument}]... @var{type})
address@hidden example
address@hidden deffn
-
address@hidden Widget Properties, Defining New Widgets, Sexp Types, Top
address@hidden node-name, next, previous, up
address@hidden Properties
address@hidden properties of widgets
address@hidden widget properties
-
-You can examine or set the value of a widget by using the widget object
-that was returned by @code{widget-create}.
-
address@hidden widget-value widget
-Return the current value contained in @var{widget}.
-It is an error to call this function on an uninitialized widget.
address@hidden defun
-
address@hidden widget-value-set widget value
-Set the value contained in @var{widget} to @var{value}.
-It is an error to call this function with an invalid @var{value}.
address@hidden defun
-
address@hidden:} You @emph{must} call @code{widget-setup} after
-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.
-
-If your application needs to associate some information with the widget
-objects, for example a reference to the item being edited, it can be
-done with @code{widget-put} and @code{widget-get}. The property names
-must begin with a @samp{:}.
-
address@hidden widget-put widget property value
-In @var{widget} set @var{property} to @var{value}.
address@hidden should be a symbol, while @var{value} can be anything.
address@hidden defun
-
address@hidden widget-get widget property
-In @var{widget} return the value for @var{property}.
address@hidden should be a symbol, the value is what was last set by
address@hidden for @var{property}.
address@hidden defun
-
address@hidden widget-member widget property
address@hidden if @var{widget} has a value (even @code{nil}) for
-property @var{property}.
address@hidden 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.
-
address@hidden widget-type widget
-Return the name of @var{widget}, a symbol.
address@hidden defun
-
address@hidden active widget
address@hidden inactive widget
address@hidden activate a widget
address@hidden deactivate a widget
-Widgets can be in two states: active, which means they are modifiable by
-the user, or inactive, which means they cannot be modified by the user.
-You can query or set the state with the following code:
-
address@hidden
-;; 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)
address@hidden lisp
-
-A widget is inactive if it, or any of its ancestors (found by
-following the @code{:parent} link), have been deactivated. To make sure
-a widget is really active, you must therefore activate both it and
-all its ancestors.
-
address@hidden
-(while widget
- (widget-apply widget :activate)
- (setq widget (widget-get widget :parent)))
address@hidden lisp
-
-You can check if a widget has been made inactive by examining the value
-of the @code{:inactive} keyword. If this is address@hidden, 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
address@hidden:inactive} keyword directly. Use the @code{:activate}
address@hidden:deactivate} keywords instead.
-
-
address@hidden Defining New Widgets, Widget Browser, Widget Properties, Top
address@hidden node-name, next, previous, up
address@hidden Defining New Widgets
address@hidden new widgets
address@hidden defining new widgets
-
-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.
-
address@hidden define-widget name class doc &rest args
-Define a new widget type named @var{name} from @code{class}.
-
address@hidden and class should both be symbols, @code{class} should be one
-of 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 will
-create identical widgets:
-
address@hidden @bullet
address@hidden
address@hidden
-(widget-create @var{name})
address@hidden lisp
-
address@hidden
address@hidden
-(apply widget-create @var{class} @var{args})
address@hidden lisp
address@hidden itemize
-
address@hidden defun
-
-Using @code{define-widget} just stores the definition of the widget type
-in the @code{widget-type} property of @var{name}, which is what
address@hidden uses.
-
-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:
address@hidden @code
address@hidden address@hidden keyword}
address@hidden :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.
-
-The following predefined functions can be used here:
-
address@hidden widget-types-convert-widget widget
-Convert @code{:args} as widget types in @var{widget}.
address@hidden defun
-
address@hidden widget-value-convert-widget widget
-Initialize @code{:value} from @code{:args} in @var{widget}.
address@hidden defun
-
address@hidden address@hidden keyword}
address@hidden :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:
-
address@hidden widget-types-copy widget
-Copy @code{:args} as widget types in @var{widget}.
address@hidden defun
-
address@hidden address@hidden keyword}
address@hidden :value-to-internal
-Function to convert the value to the internal format. The function
-takes two arguments, a widget and an external value, and returns the
-internal value. The function is called on the present @code{:value}
-when the widget is created, and on any value set later with
address@hidden
-
address@hidden address@hidden keyword}
address@hidden :value-to-external
-Function to convert the value to the external format. The function
-takes two arguments, a widget and an internal value, and returns the
-external value. The function is called on the present @code{:value}
-when the widget is created, and on any value set later with
address@hidden
-
address@hidden address@hidden keyword}
address@hidden :create
-Function to create a widget from scratch. The function takes one
-argument, a widget type, and creates a widget of that type, inserts it
-in the buffer, and returns a widget object.
-
address@hidden address@hidden keyword}
address@hidden :delete
-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:
-
address@hidden widget-default-delete widget
-Remove @var{widget} from the buffer.
-Delete all @code{:children} and @code{:buttons} in @var{widget}.
address@hidden defun
-
-In most cases you should not change this value, but instead use
address@hidden:value-delete} to make any additional cleanup.
-
address@hidden address@hidden keyword}
address@hidden :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.
-
address@hidden address@hidden keyword}
address@hidden :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 these are not listed in @code{:children} or @code{:buttons}.
-
address@hidden address@hidden keyword}
address@hidden :value-get
-Function to extract the value of a widget, as it is displayed in the
-buffer.
-
-The following predefined function can be used here:
-
address@hidden widget-value-value-get widget
-Return the @code{:value} property of @var{widget}.
address@hidden defun
-
address@hidden address@hidden keyword}
address@hidden :format-handler
-Function to handle unknown @samp{%} escapes in the format string. It
-will be called with the widget and the character that follows the
address@hidden as arguments. You can set this to allow your widget to handle
-non-standard escapes.
-
address@hidden widget-default-format-handler
-You should end up calling @code{widget-default-format-handler} to handle
-unknown escape sequences, which will handle the @samp{%h} and any future
-escape sequences, as well as give an error for unknown escapes.
-
address@hidden address@hidden keyword}
address@hidden :action
-Function to handle user initiated events. By default, @code{:notify}
-the parent.
-
-The following predefined function can be used here:
-
address@hidden widget-parent-action widget &optional event
-Tell @code{:parent} of @var{widget} to handle the @code{:action}.
-Optional @var{event} is the event that triggered the action.
address@hidden defun
-
address@hidden address@hidden keyword}
address@hidden :prompt-value
-Function to prompt for a value in the minibuffer. The function should
-take four arguments, @var{widget}, @var{prompt}, @var{value}, and
address@hidden and should return a value for widget entered by the user.
address@hidden is the prompt to use. @var{value} is the default value to
-use, unless @var{unbound} is address@hidden, 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.
address@hidden table
-
-If you want to define a new widget from scratch, use the @code{default}
-widget as its base.
-
address@hidden 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.
address@hidden deffn
-
address@hidden Widget Browser, Widget Minor Mode, Defining New Widgets, Top
address@hidden node-name, next, previous, up
address@hidden Widget Browser
address@hidden widget browser
-
-There is a separate package to browse widgets. This is intended to help
-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.
-
address@hidden Command widget-browse @var{widget}
-Create a widget browser for @var{widget}.
-When called interactively, prompt for @var{widget}.
address@hidden deffn
-
address@hidden 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}.
address@hidden deffn
-
address@hidden Command widget-browse-at @var{pos}
-Create a widget browser for the widget at @var{pos}.
-When called interactively, use the position of point.
address@hidden deffn
-
address@hidden Widget Minor Mode, Utilities, Widget Browser, Top
address@hidden node-name, next, previous, up
address@hidden Widget Minor Mode
address@hidden widget minor mode
-
-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.
-
address@hidden Command widget-minor-mode
-Toggle minor mode for traversing widgets.
-With arg, turn widget mode on if and only if arg is positive.
address@hidden deffn
-
address@hidden widget-minor-mode-keymap
-Keymap used in @code{widget-minor-mode}.
address@hidden defvar
-
address@hidden Utilities, Widget Wishlist, Widget Minor Mode, Top
address@hidden node-name, next, previous, up
address@hidden Utilities.
address@hidden utility functions for widgets
-
address@hidden 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
address@hidden@refill
address@hidden defun
-
address@hidden widget-get-sibling widget
-Get the item which @var{widget} is assumed to toggle.
-This is only meaningful for radio buttons or checkboxes in a list.
address@hidden defun
-
address@hidden Widget Wishlist, GNU Free Documentation License, Utilities, Top
address@hidden node-name, next, previous, up
address@hidden Wishlist
address@hidden todo
-
address@hidden @bullet
address@hidden
-It should be possible to add or remove items from a list with @kbd{C-k}
-and @kbd{C-o} (suggested by @sc{rms}).
-
address@hidden
-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
-the ugly buttons, the dash is my idea).
-
address@hidden
-The @code{menu-choice} tag should be prettier, something like the abbreviated
-menus in Open Look.
-
address@hidden
-Finish @code{:tab-order}.
-
address@hidden
-Make indentation work with glyphs and proportional fonts.
-
address@hidden
-Add commands to show overview of object and class hierarchies to the
-browser.
-
address@hidden
-Find a way to disable mouse highlight for inactive widgets.
-
address@hidden
-Find a way to make glyphs look inactive.
-
address@hidden
-Add @code{property-list} widget.
-
address@hidden
-Add @code{association-list} widget.
-
address@hidden
-Add @code{key-binding} widget.
-
address@hidden
-Add @code{widget} widget for editing widget specifications.
-
address@hidden
-Find clean way to implement variable length list.
-See @code{TeX-printer-list} for an explanation.
-
address@hidden
address@hidden in @code{widget-prompt-value} should give type specific help.
-
address@hidden
-Add a @code{mailto} widget.
address@hidden itemize
-
address@hidden GNU Free Documentation License, Index, Widget Wishlist, Top
address@hidden GNU Free Documentation License
address@hidden doclicense.texi
-
address@hidden Index, , GNU Free Documentation License, Top
address@hidden node-name, next, previous, up
address@hidden Index
-
-This is an alphabetical listing of all concepts, functions, commands,
-variables, and widgets described in this manual.
address@hidden cp
-
address@hidden odd
address@hidden
address@hidden
-
address@hidden
- arch-tag: 2b427731-4c61-4e72-85de-5ccec9c623f0
address@hidden ignore
- [Emacs-diffs] Changes to widget.texi,
Glenn Morris <=