-This is ../info/widget.info, produced by makeinfo version 4.0 from
-widget.texi.
+This is Info file ../info/widget.info, produced by Makeinfo version
+1.68 from the input file widget.texi.
INFO-DIR-SECTION XEmacs Editor
START-INFO-DIR-ENTRY
There are several different kind of buttons, all of which are
present in the example:
-_The Option Field Tags._
+*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 `menu-choice'
widget. In the example, `Choose' is an option field tag.
-_The `[INS]' and `[DEL]' buttons._
+*The `[INS]' and `[DEL]' buttons.*
Activating these will insert or delete elements from a editable
list. The list is created by the `editable-list' widget.
-_Embedded Buttons._
+*Embedded Buttons.*
The `_other work_' is an example of an embedded button. Embedded
buttons are not associated with a fields, but can serve any
purpose, such as implementing hypertext references. They are
usually created by the `link' widget.
-_The `[ ]' and `[X]' buttons._
+*The `[ ]' and `[X]' buttons.*
Activating one of these will convert it to the other. This is
useful for implementing multiple-choice fields. You can create it
wit
-_The `( )' and `(*)' buttons._
+*The `( )' and `(*)' buttons.*
Only one radio button in a `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.
-_The `[Apply Form]' `[Reset Form]' buttons._
+*The `[Apply Form]' `[Reset Form]' buttons.*
These are explicit buttons made with the `push-button' widget.
The main difference from the `link' widget is that the buttons are
will be displayed as GUI buttons when possible. enough.
buffer, plus you will have these additional commands:
`<TAB>'
- - Command: widget-forward &optional count
+ - Command: widget-forward &optional COUNT
Move point COUNT buttons or editing fields forward.
`<M-TAB>'
- - Command: widget-backward &optional count
+ - Command: widget-backward &optional COUNT
Move point COUNT buttons or editing fields backward.
\1f
functions, until it is deleted with `widget-delete'. After the widgets
have been created, `widget-setup' must be called to enable them.
- - Function: widget-create type [ keyword argument ]...
+ - Function: widget-create TYPE [ KEYWORD ARGUMENT ]...
Create and return a widget of type TYPE. The syntax for the TYPE
argument is described in *Note Basic Types::.
The keyword arguments can be used to overwrite the keyword
arguments that are part of TYPE.
- - Function: widget-delete widget
+ - Function: widget-delete WIDGET
Delete WIDGET and remove it from the buffer.
- Function: widget-setup
`%{'
`%}'
- The text inside will be displayed in the face specified by
+ The text inside will be displayed with the face specified by
`:sample-face'.
`%v'
- This will be replaced with the buffer representation of the
- widget's value. What this is depends on the widget type.
+ This will be replaces with the buffer representation of the
+ widgets value. What this is depends on the widget type.
`%d'
Insert the string specified by `:doc' here.
Text around %[ %] in the format.
These can be
- _nil_
+ *nil*
No text is inserted.
- _a string_
+ *a string*
The string is inserted literally.
- _a symbol_
+ *a symbol*
The value of the symbol is expanded according to this table.
`:doc'
`:validate'
A function which takes a widget as an argument, and return nil if
- the widget's current value is valid for the widget. Otherwise it
+ the widgets current value is valid for the widget. Otherwise, it
should return the widget containing the invalid data, and set that
- widget's `:error' property to a string explaining the error.
+ widgets `:error' property to a string explaining the error.
The following predefined function can be used:
- - Function: widget-children-validate widget
+ - Function: widget-children-validate WIDGET
All the `:children' of WIDGET must be valid.
`:tab-order'
TYPE ::= (menu-choice [KEYWORD ARGUMENT]... TYPE ... )
- The TYPE argument represents each possible choice. The widget's
-value will be that of the chosen TYPE argument. This widget will match
-any value matching at least one of the specified TYPE arguments.
+ The TYPE arguments represents each possible choice. The widgets
+value of will be the value of the chosen TYPE argument. This widget
+will match any value that matches at least one of the specified TYPE
+arguments.
`:void'
Widget type used as a fallback when the value does not match any
TYPE ::= (radio-button-choice [KEYWORD ARGUMENT]... TYPE ... )
- The TYPE argument represents each possible choice. The widget's
-value will be that of the chosen TYPE argument. This widget will match
-any value matching at least one of the specified TYPE arguments.
+ The TYPE arguments represents each possible choice. The widgets
+value of will be the value of the chosen TYPE argument. This widget
+will match any value that matches at least one of the specified TYPE
+arguments.
The following extra properties are recognized.
widget after it has been created with the function
`widget-radio-add-item'.
- - Function: widget-radio-add-item widget type
+ - Function: widget-radio-add-item WIDGET TYPE
Add to `radio-button-choice' widget WIDGET a new radio button item
of type TYPE.
TYPE ::= (toggle [KEYWORD ARGUMENT]...)
- The widget has two possible states, `on' and `off', which correspond
-to a `t' or `nil' value respectively.
+ The widget has two possible states, `on' and `off', which
+corresponds to a `t' or `nil' value.
The following extra properties are recognized.
TYPE ::= (checklist [KEYWORD ARGUMENT]... TYPE ... )
- The TYPE arguments represents each checklist item. The widget's
-value will be a list containing the values of all ticked TYPE
-arguments. The checklist widget will match a list whose elements all
-match at least one of the specified TYPE arguments.
+ The TYPE arguments represents each checklist item. The widgets
+value of will be a list containing the value of each ticked TYPE
+argument. The checklist widget will match a list whose elements all
+matches at least one of the specified TYPE arguments.
The following extra properties are recognized.
Insert a literal `%'.
`:greedy'
- Usually a checklist will only match if the items are in the exact
+ Usually, a checklist will only match if the items are in the exact
sequence given in the specification. By setting `:greedy' to
- non-nil, it will allow the items to appear in any sequence.
- However, if you extract the values they will be in the sequence
- given in the checklist. I.e. the original sequence is forgotten.
+ 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.
`button-args'
A list of keywords to pass to the checkboxes. Useful for setting
t)' or `(file string string)'.
This concept of inline is probably 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.
+certainly hard to implement so instead of confuse you more by trying to
+explain it here, I'll just suggest you meditate over it for a while.
- Widget: choice
- Allows you to edit a sexp which may have one of a fixed set of
+ Allows you to edit a sexp which may have one of fixed set of
types. It is currently implemented with the `choice-menu' basic
widget, and has a similar syntax.
You can examine or set the value of a widget by using the widget
object that was returned by `widget-create'.
- - Function: widget-value widget
+ - Function: widget-value WIDGET
Return the current value contained in WIDGET. It is an error to
call this function on an uninitialized widget.
- - Function: widget-value-set widget value
+ - Function: widget-value-set WIDGET VALUE
Set the value contained in WIDGET to VALUE. It is an error to
call this function with an invalid VALUE.
- *Important:* You _must_ call `widget-setup' after modifying the
+ *Important:* You *must* call `widget-setup' after modifying the
value of a widget before the user is allowed to edit the widget again.
It is enough to call `widget-setup' once if you modify multiple
widgets. This is currently only necessary if the widget contains an
can be done with `widget-put' and `widget-get'. The property names
must begin with a `:'.
- - Function: widget-put widget property value
+ - Function: widget-put WIDGET PROPERTY VALUE
In WIDGET set PROPERTY to VALUE. PROPERTY should be a symbol,
while VALUE can be anything.
- - Function: widget-get widget property
+ - Function: widget-get WIDGET PROPERTY
In WIDGET return the value for PROPERTY. PROPERTY should be a
symbol, the value is what was last set by `widget-put' for
PROPERTY.
- - Function: widget-member widget property
+ - Function: widget-member WIDGET PROPERTY
Non-nil if WIDGET has a value (even nil) for property PROPERTY.
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.
- - Function: widget-type widget
+ - Function: widget-type WIDGET
Return the name of WIDGET, a symbol.
Widgets can be in two states: active, which means they are
;; Make WIDGET active.
(widget-apply WIDGET :activate)
- A widget is inactive if itself or any of its ancestors (found by
+ A widget is inactive if itself, or any of its ancestors (found by
following the `:parent' link) have been deactivated. To make sure a
-widget is really active, you must therefore activate both itself and
+widget is really active, you must therefore activate both itself, and
all its ancestors.
(while widget
(setq widget (widget-get widget :parent)))
You can check if a widget has been made inactive by examining the
-value of the `:inactive' keyword. If this is non-nil, the widget itself
-has been deactivated. This is different from using the `:active'
-keyword, in that the latter tells you if the widget *or* any of its
-ancestors have been deactivated. Do not attempt to set the `:inactive'
-keyword directly. Use the `:activate' `:deactivate' keywords instead.
+value of `:inactive' keyword. If this is non-nil, the widget itself has
+been deactivated. This is different from using the `:active' keyword,
+in that the later tell you if the widget *or* any of its ancestors have
+been deactivated. Do not attempt to set the `:inactive' keyword
+directly. Use the `:activate' `:deactivated' keywords instead.
\1f
File: widget.info, Node: Defining New Widgets, Next: Widget Browser, Prev: Widget Properties, Up: Top
====================
You can define specialized widgets with `define-widget'. It allows
-you to create a shorthand for more complex widgets. This includes
-specifying component widgets and new default values for the keyword
+you to create a shorthand for more complex widgets, including specifying
+component widgets and default new default values for the keyword
arguments.
- - Function: widget-define name class doc &rest args
+ - Function: widget-define NAME CLASS DOC &rest ARGS
Define a new widget type named NAME from `class'.
NAME and class should both be symbols, `class' should be one of
The third argument DOC is a documentation string for the widget.
- After the new widget has been defined the following two calls will
+ After the new widget has been defined, the following two calls will
create identical widgets:
* (widget-create NAME)
* (apply widget-create CLASS ARGS)
- Using `widget-define' just stores the definition of the widget type
-in the `widget-type' property of NAME, which is what `widget-create'
-uses.
+ Using `widget-define' does just store the definition of the widget
+type in the `widget-type' property of NAME, which is what
+`widget-create' uses.
If you just want to specify defaults for keywords with no complex
conversions, you can use `identity' as your conversion function.
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
+ called for the widget type and all the widgets parent types, most
derived first.
The following predefined functions can be used here:
- - Function: widget-types-convert-widget widget
+ - Function: widget-types-convert-widget WIDGET
Convert `:args' as widget types in WIDGET.
- - Function: widget-value-convert-widget widget
+ - Function: widget-value-convert-widget WIDGET
Initialize `:value' from `:args' in WIDGET.
`:value-to-internal'
Function to convert the value to the internal format. The function
- takes two arguments, a widget and an external value. It returns
+ takes two arguments, a widget and an external value, and returns
the internal value. The function is called on the present `:value'
when the widget is created, and on any value set later with
`widget-value-set'.
`: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.
+ argument, a widget type, and create a widget of that type, insert
+ it in the buffer, and return a widget object.
`:delete'
Function to delete a widget. The function takes one argument, a
`:value-create'
Function to expand the `%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.
+ be called with the widget as its argument. Should insert a
+ representation of the widgets value in the buffer.
`:value-delete'
- Should remove the representation of the widget's value from the
+ Should remove the representation of the widgets 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.
+ delete nested widgets if such has been used.
The following predefined function can be used here:
- - Function: widget-children-value-delete widget
+ - Function: widget-children-value-delete WIDGET
Delete all `:children' and `:buttons' in WIDGET.
`:value-get'
The following predefined function can be used here:
- - Function: widget-value-value-get widget
+ - Function: widget-value-value-get WIDGET
Return the `:value' property of WIDGET.
`:format-handler'
non-standard escapes.
You should end up calling `widget-default-format-handler' to handle
- unknown escape sequences. It will handle the `%h' and any future
- escape sequences as well as give an error for unknown escapes.
+ unknown escape sequences, which will handle the `%h' and any future
+ escape sequences, as well as give an error for unknown escapes.
`:action'
Function to handle user initiated events. By default, `:notify'
The following predefined function can be used here:
- - Function: widget-parent-action widget &optional event
+ - Function: widget-parent-action WIDGET &optional EVENT
Tell `:parent' of WIDGET to handle the `:action'.
Optional EVENT is the event that triggered the action.
should take four arguments, WIDGET, PROMPT, VALUE, and UNBOUND and
should return a value for widget entered by the user. PROMPT is
the prompt to use. VALUE is the default value to use, unless
- UNBOUND is non-nil. In this case there is no default value. The
+ UNBOUND is non-nil in which case there are no default value. The
function should read the value using the method most natural for
- this widget and does not have to check whether it matches.
+ this widget, and does not have to check that it matches.
If you want to define a new widget from scratch, use the `default'
widget as its base.
Utilities.
==========
- - Function: widget-prompt-value widget prompt [ value unbound ]
+ - Function: widget-prompt-value WIDGET PROMPT [ VALUE UNBOUND ]
Prompt for a value matching WIDGET, using PROMPT.
The current value is assumed to be VALUE, unless UNBOUND is
non-nil.
- - Function: widget-get-sibling widget
+ - Function: widget-get-sibling WIDGET
Get the item WIDGET is assumed to toggle.
This is only meaningful for radio buttons or checkboxes in a list.
symbol, it should pop up a menu.
-
\1f
Tag Table:
-Node: Top\7f201
-Node: Introduction\7f581
-Node: User Interface\7f4064
-Node: Programming Example\7f8959
-Node: Setting Up the Buffer\7f12276
-Node: Basic Types\7f13993
-Node: link\7f20038
-Node: url-link\7f20552
-Node: info-link\7f20864
-Node: push-button\7f21155
-Node: editable-field\7f21728
-Node: text\7f23067
-Node: menu-choice\7f23365
-Node: radio-button-choice\7f24218
-Node: item\7f25785
-Node: choice-item\7f26173
-Node: toggle\7f26671
-Node: checkbox\7f27408
-Node: checklist\7f27714
-Node: editable-list\7f29158
-Node: group\7f30340
-Node: Sexp Types\7f30627
-Node: constants\7f30940
-Node: generic\7f32019
-Node: atoms\7f32552
-Node: composite\7f34499
-Node: Widget Properties\7f36969
-Node: Defining New Widgets\7f40034
-Node: Widget Browser\7f45334
-Node: Widget Minor Mode\7f46192
-Node: Utilities\7f46749
-Node: Widget Wishlist\7f47230
+Node: Top\7f227
+Node: Introduction\7f607
+Node: User Interface\7f4090
+Node: Programming Example\7f8985
+Node: Setting Up the Buffer\7f12302
+Node: Basic Types\7f14019
+Node: link\7f20064
+Node: url-link\7f20578
+Node: info-link\7f20890
+Node: push-button\7f21181
+Node: editable-field\7f21754
+Node: text\7f23093
+Node: menu-choice\7f23391
+Node: radio-button-choice\7f24256
+Node: item\7f25835
+Node: choice-item\7f26223
+Node: toggle\7f26721
+Node: checkbox\7f27446
+Node: checklist\7f27752
+Node: editable-list\7f29196
+Node: group\7f30378
+Node: Sexp Types\7f30665
+Node: constants\7f30978
+Node: generic\7f32057
+Node: atoms\7f32590
+Node: composite\7f34537
+Node: Widget Properties\7f37003
+Node: Defining New Widgets\7f40066
+Node: Widget Browser\7f45366
+Node: Widget Minor Mode\7f46224
+Node: Utilities\7f46781
+Node: Widget Wishlist\7f47262
\1f
End Tag Table
projects / chise / xemacs-chise.git.1 / blobdiff