-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
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'
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'
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.
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
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 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'
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'
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.
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\7f24230
-Node: item\7f25809
-Node: choice-item\7f26197
-Node: toggle\7f26695
-Node: checkbox\7f27420
-Node: checklist\7f27726
-Node: editable-list\7f29170
-Node: group\7f30352
-Node: Sexp Types\7f30639
-Node: constants\7f30952
-Node: generic\7f32031
-Node: atoms\7f32564
-Node: composite\7f34511
-Node: Widget Properties\7f36977
-Node: Defining New Widgets\7f40040
-Node: Widget Browser\7f45340
-Node: Widget Minor Mode\7f46198
-Node: Utilities\7f46755
-Node: Widget Wishlist\7f47236
+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