annotate man/widget.texi @ 28:1917ad0d78d7 r19-15b97

Import from CVS: tag r19-15b97
author cvs
date Mon, 13 Aug 2007 08:51:55 +0200
parents 441bb1e64a06
children ec9a17fef872
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
16
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1 \input texinfo.tex
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
2
28
1917ad0d78d7 Import from CVS: tag r19-15b97
cvs
parents: 26
diff changeset
3 @c $Id: widget.texi,v 1.6 1997/03/04 08:45:08 steve Exp $
16
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
4
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
5 @c %**start of header
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
6 @setfilename widget
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
7 @settitle The Emacs Widget Library
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
8 @iftex
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
9 @afourpaper
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
10 @headings double
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
11 @end iftex
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
12 @c %**end of header
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
13
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
14 @node Top, Introduction, (dir), (dir)
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
15 @comment node-name, next, previous, up
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
16 @top The Emacs Widget Library
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
17
28
1917ad0d78d7 Import from CVS: tag r19-15b97
cvs
parents: 26
diff changeset
18 Version: 1.50
16
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
19
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
20 @menu
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
21 * Introduction::
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
22 * User Interface::
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
23 * Programming Example::
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
24 * Setting Up the Buffer::
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
25 * Basic Types::
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
26 * Sexp Types::
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
27 * Widget Properties::
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
28 * Defining New Widgets::
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
29 * Widget Wishlist.::
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
30 @end menu
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
31
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
32 @node Introduction, User Interface, Top, Top
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
33 @comment node-name, next, previous, up
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
34 @section Introduction
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
35
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
36 Most graphical user interface toolkits, such as Motif and XView, provide
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
37 a number of standard user interface controls (sometimes known as
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
38 `widgets' or `gadgets'). Emacs doesn't really support anything like
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
39 this, except for an incredible powerful text ``widget''. On the other
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
40 hand, Emacs does provide the necessary primitives to implement many
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
41 other widgets within a text buffer. The @code{widget} package
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
42 simplifies this task.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
43
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
44 The basic widgets are:
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
45
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
46 @table @code
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
47 @item link
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
48 Areas of text with an associated action. Intended for hypertext links
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
49 embedded in text.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
50 @item push-button
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
51 Like link, but intended for stand-alone buttons.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
52 @item editable-field
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
53 An editable text field. It can be either variable or fixed length.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
54 @item menu-choice
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
55 Allows the user to choose one of multiple options from a menu, each
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
56 option is itself a widget. Only the selected option will be visible in
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
57 the buffer.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
58 @item radio-button-choice
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
59 Allows the user to choose one of multiple options by pushing radio
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
60 buttons. The options are implemented as widgets. All options will be
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
61 visible in the buffer.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
62 @item item
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
63 A simple constant widget intended to be used in the @code{menu-choice} and
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
64 @code{radio-button-choice} widgets.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
65 @item choice-item
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
66 An button item only intended for use in choices. When pushed, the user
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
67 will be asked to select another option from the choice widget.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
68 @item toggle
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
69 A simple @samp{on}/@samp{off} switch.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
70 @item checkbox
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
71 A checkbox (@samp{[ ]}/@samp{[X]}).
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
72 @item editable-list
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
73 Create an editable list. The user can insert or delete items in the
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
74 list. Each list item is itself a widget.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
75 @end table
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
76
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
77 Now of what possible use can support for widgets be in a text editor?
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
78 I'm glad you asked. The answer is that widgets are useful for
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
79 implementing forms. A @dfn{form} in emacs is a buffer where the user is
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
80 supposed to fill out a number of fields, each of which has a specific
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
81 meaning. The user is not supposed to change or delete any of the text
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
82 between the fields. Examples of forms in Emacs are the @file{forms}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
83 package (of course), the customize buffers, the mail and news compose
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
84 modes, and the @sc{html} form support in the @file{w3} browser.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
85
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
86 The advantages for a programmer of using the @code{widget} package to
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
87 implement forms are:
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
88
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
89 @enumerate
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
90 @item
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
91 More complex field than just editable text are supported.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
92 @item
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
93 You can give the user immediate feedback if he enters invalid data in a
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
94 text field, and sometimes prevent entering invalid data.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
95 @item
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
96 You can have fixed sized fields, thus allowing multiple field to be
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
97 lined up in columns.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
98 @item
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
99 It is simple to query or set the value of a field.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
100 @item
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
101 Editing happens in buffer, not in the mini-buffer.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
102 @item
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
103 Packages using the library get a uniform look, making them easier for
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
104 the user to learn.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
105 @item
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
106 As support for embedded graphics improve, the widget library will
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
107 extended to support it. This means that your code using the widget
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
108 library will also use the new graphic features by automatic.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
109 @end enumerate
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
110
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
111 In order to minimize the code that is loaded by users who does not
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
112 create any widgets, the code has been split in two files:
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
113
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
114 @table @file
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
115 @item widget.el
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
116 This will declare the user variables, define the function
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
117 @code{widget-define}, and autoload the function @code{widget-create}.
28
1917ad0d78d7 Import from CVS: tag r19-15b97
cvs
parents: 26
diff changeset
118 @item wid-edit.el
16
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
119 Everything else is here, there is no reason to load it explicitly, as
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
120 it will be autoloaded when needed.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
121 @end table
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
122
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
123 @node User Interface, Programming Example, Introduction, Top
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
124 @comment node-name, next, previous, up
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
125 @section User Interface
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
126
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
127 A form consist of read only text for documentation and some fields,
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
128 where each the fields contain two parts, as tag and a value. The tags
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
129 are used to identify the fields, so the documentation can refer to the
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
130 foo field, meaning the field tagged with @samp{Foo}. Here is an example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
131 form:
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
132
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
133 @example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
134 Here is some documentation.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
135
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
136 Name: @i{My Name} @strong{Choose}: This option
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
137 Address: @i{Some Place
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
138 In some City
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
139 Some country.}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
140
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
141 See also @b{_other work_} for more information.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
142
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
143 Numbers: count to three below
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
144 @b{[INS]} @b{[DEL]} @i{One}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
145 @b{[INS]} @b{[DEL]} @i{Eh, two?}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
146 @b{[INS]} @b{[DEL]} @i{Five!}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
147 @b{[INS]}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
148
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
149 Select multiple:
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
150
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
151 @b{[X]} This
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
152 @b{[ ]} That
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
153 @b{[X]} Thus
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
154
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
155 Select one:
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
156
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
157 @b{(*)} One
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
158 @b{( )} Another One.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
159 @b{( )} A Final One.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
160
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
161 @b{[Apply Form]} @b{[Reset Form]}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
162 @end example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
163
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
164 The top level widgets in is example are tagged @samp{Name},
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
165 @samp{Choose}, @samp{Address}, @samp{_other work_}, @samp{Numbers},
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
166 @samp{Select multiple}, @samp{Select one}, @samp{[Apply Form]}, and
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
167 @samp{[Reset Form]}. There are basically two thing the user can do within
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
168 a form, namely editing the editable text fields and activating the
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
169 buttons.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
170
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
171 @subsection Editable Text Fields
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
172
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
173 In the example, the value for the @samp{Name} is most likely displayed
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
174 in an editable text field, and so are values for each of the members of
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
175 the @samp{Numbers} list. All the normal Emacs editing operations are
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
176 available for editing these fields. The only restriction is that each
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
177 change you make must be contained within a single editable text field.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
178 For example, capitalizing all text from the middle of one field to the
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
179 middle of another field is prohibited.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
180
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
181 Editing text fields are created by the @code{editable-field} widget.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
182
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
183 The editing text fields are highlighted with the
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
184 @code{widget-field-face} face, making them easy to find.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
185
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
186 @deffn Face widget-field-face
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
187 Face used for other editing fields.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
188 @end deffn
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
189
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
190 @subsection Buttons
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
191
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
192 Some portions of the buffer have an associated @dfn{action}, which can
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
193 be @dfn{activated} by a standard key or mouse command. These portions
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
194 are called @dfn{buttons}. The default commands for activating a button
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
195 are:
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
196
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
197 @table @kbd
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
198 @item @key{RET}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
199 @deffn Command widget-button-press @var{pos} &optional @var{event}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
200 Activate the button at @var{pos}, defaulting to point.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
201 If point is not located on a button, activate the binding in
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
202 @code{widget-global-map} (by default the global map).
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
203 @end deffn
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
204
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
205 @item mouse-2
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
206 @deffn Command widget-button-click @var{event}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
207 Activate the button at the location of the mouse pointer. If the mouse
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
208 pointer is located in an editable text field, activate the binding in
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
209 @code{widget-global-map} (by default the global map).
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
210 @end deffn
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
211 @end table
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
212
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
213 There are several different kind of buttons, all of which are present in
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
214 the example:
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
215
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
216 @table @emph
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
217 @item The Option Field Tags.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
218 When you activate one of these buttons, you will be asked to choose
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
219 between a number of different options. This is how you edit an option
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
220 field. Option fields are created by the @code{menu-choice} widget. In
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
221 the example, @samp{@b{Choose}} is an option field tag.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
222 @item The @samp{@b{[INS]}} and @samp{@b{[DEL]}} buttons.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
223 Activating these will insert or delete elements from a editable list.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
224 The list is created by the @code{editable-list} widget.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
225 @item Embedded Buttons.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
226 The @samp{@b{_other work_}} is an example of an embedded
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
227 button. Embedded buttons are not associated with a fields, but can serve
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
228 any purpose, such as implementing hypertext references. They are
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
229 usually created by the @code{link} widget.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
230 @item The @samp{@b{[ ]}} and @samp{@b{[X]}} buttons.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
231 Activating one of these will convert it to the other. This is useful
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
232 for implementing multiple-choice fields. You can create it wit
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
233 @item The @samp{@b{( )}} and @samp{@b{(*)}} buttons.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
234 Only one radio button in a @code{radio-button-choice} widget can be selected at any
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
235 time. When you push one of the unselected radio buttons, it will be
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
236 selected and the previous selected radio button will become unselected.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
237 @item The @samp{@b{[Apply Form]}} @samp{@b{[Reset Form]}} buttons.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
238 These are explicit buttons made with the @code{push-button} widget. The main
22
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
239 difference from the @code{link} widget is that the buttons are will be
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
240 displayed as GUI buttons when possible.
16
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
241 enough.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
242 @end table
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
243
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
244 To make them easier to locate, buttons are emphasized in the buffer.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
245
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
246 @deffn Face widget-button-face
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
247 Face used for buttons.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
248 @end deffn
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
249
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
250 @defopt widget-mouse-face
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
251 Face used for buttons when the mouse pointer is above it.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
252 @end defopt
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
253
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
254 @subsection Navigation
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
255
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
256 You can use all the normal Emacs commands to move around in a form
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
257 buffer, plus you will have these additional commands:
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
258
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
259 @table @kbd
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
260 @item @key{TAB}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
261 @deffn Command widget-forward &optional count
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
262 Move point @var{count} buttons or editing fields forward.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
263 @end deffn
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
264 @item @key{M-TAB}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
265 @deffn Command widget-backward &optional count
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
266 Move point @var{count} buttons or editing fields backward.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
267 @end deffn
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
268 @end table
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
269
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
270 @node Programming Example, Setting Up the Buffer, User Interface, Top
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
271 @comment node-name, next, previous, up
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
272 @section Programming Example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
273
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
274 Here is the code to implement the user interface example (see @ref{User
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
275 Interface}).
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
276
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
277 @lisp
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
278 (require 'widget)
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
279
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
280 (eval-when-compile
28
1917ad0d78d7 Import from CVS: tag r19-15b97
cvs
parents: 26
diff changeset
281 (require 'wid-edit))
16
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
282
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
283 (defvar widget-example-repeat)
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
284
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
285 (defun widget-example ()
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
286 "Create the widgets from the Widget manual."
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
287 (interactive)
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
288 (switch-to-buffer "*Widget Example*")
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
289 (kill-all-local-variables)
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
290 (make-local-variable 'widget-example-repeat)
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
291 (let ((inhibit-read-only t))
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
292 (erase-buffer))
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
293 (widget-insert "Here is some documentation.\n\nName: ")
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
294 (widget-create 'editable-field
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
295 :size 13
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
296 "My Name")
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
297 (widget-create 'menu-choice
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
298 :tag "Choose"
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
299 :value "This"
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
300 :help-echo "Choose me, please!"
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
301 :notify (lambda (widget &rest ignore)
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
302 (message "%s is a good choice!"
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
303 (widget-value widget)))
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
304 '(item :tag "This option" :value "This")
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
305 '(choice-item "That option")
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
306 '(editable-field :menu-tag "No option" "Thus option"))
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
307 (widget-insert "Address: ")
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
308 (widget-create 'editable-field
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
309 "Some Place\nIn some City\nSome country.")
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
310 (widget-insert "\nSee also ")
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
311 (widget-create 'link
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
312 :notify (lambda (&rest ignore)
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
313 (widget-value-set widget-example-repeat
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
314 '("En" "To" "Tre"))
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
315 (widget-setup))
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
316 "other work")
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
317 (widget-insert " for more information.\n\nNumbers: count to three below\n")
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
318 (setq widget-example-repeat
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
319 (widget-create 'editable-list
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
320 :entry-format "%i %d %v"
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
321 :notify (lambda (widget &rest ignore)
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
322 (let ((old (widget-get widget
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
323 ':example-length))
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
324 (new (length (widget-value widget))))
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
325 (unless (eq old new)
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
326 (widget-put widget ':example-length new)
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
327 (message "You can count to %d." new))))
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
328 :value '("One" "Eh, two?" "Five!")
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
329 '(editable-field :value "three")))
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
330 (widget-insert "\n\nSelect multiple:\n\n")
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
331 (widget-create 'checkbox t)
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
332 (widget-insert " This\n")
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
333 (widget-create 'checkbox nil)
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
334 (widget-insert " That\n")
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
335 (widget-create 'checkbox
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
336 :notify (lambda (&rest ignore) (message "Tickle"))
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
337 t)
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
338 (widget-insert " Thus\n\nSelect one:\n\n")
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
339 (widget-create 'radio-button-choice
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
340 :value "One"
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
341 :notify (lambda (widget &rest ignore)
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
342 (message "You selected %s"
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
343 (widget-value widget)))
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
344 '(item "One") '(item "Anthor One.") '(item "A Final One."))
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
345 (widget-insert "\n")
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
346 (widget-create 'push-button
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
347 :notify (lambda (&rest ignore)
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
348 (if (= (length (widget-value widget-example-repeat))
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
349 3)
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
350 (message "Congratulation!")
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
351 (error "Three was the count!")))
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
352 "Apply Form")
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
353 (widget-insert " ")
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
354 (widget-create 'push-button
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
355 :notify (lambda (&rest ignore)
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
356 (widget-example))
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
357 "Reset Form")
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
358 (widget-insert "\n")
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
359 (use-local-map widget-keymap)
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
360 (widget-setup))
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
361 @end lisp
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
362
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
363 @node Setting Up the Buffer, Basic Types, Programming Example, Top
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
364 @comment node-name, next, previous, up
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
365 @section Setting Up the Buffer
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
366
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
367 Widgets are created with @code{widget-create}, which returns a
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
368 @dfn{widget} object. This object can be queried and manipulated by
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
369 other widget functions, until it is deleted with @code{widget-delete}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
370 After the widgets have been created, @code{widget-setup} must be called
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
371 to enable them.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
372
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
373 @defun widget-create type [ keyword argument ]@dots{}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
374 Create and return a widget of type @var{type}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
375 The syntax for the @var{type} argument is described in @ref{Basic Types}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
376
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
377 The keyword arguments can be used to overwrite the keyword arguments
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
378 that are part of @var{type}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
379 @end defun
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
380
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
381 @defun widget-delete widget
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
382 Delete @var{widget} and remove it from the buffer.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
383 @end defun
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
384
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
385 @defun widget-setup
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
386 Setup a buffer to support widgets.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
387
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
388 This should be called after creating all the widgets and before allowing
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
389 the user to edit them.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
390 @refill
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
391 @end defun
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
392
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
393 If you want to insert text outside the widgets in the form, the
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
394 recommended way to do that is with @code{widget-insert}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
395
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
396 @defun widget-insert
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
397 Insert the arguments, either strings or characters, at point.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
398 The inserted text will be read only.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
399 @end defun
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
400
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
401 There is a standard widget keymap which you might find useful.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
402
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
403 @defvr Const widget-keymap
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
404 A keymap with the global keymap as its parent.@br
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
405 @key{TAB} and @kbd{C-@key{TAB}} are bound to @code{widget-forward} and
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
406 @code{widget-backward}, respectively. @kbd{@key{RET}} and @kbd{mouse-2}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
407 are bound to @code{widget-button-press} and
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
408 @code{widget-button-}.@refill
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
409 @end defvr
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
410
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
411 @defvar widget-global-map
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
412 Keymap used by @code{widget-button-press} and @code{widget-button-click}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
413 when not on a button. By default this is @code{global-map}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
414 @end defvar
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
415
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
416 @node Basic Types, Sexp Types, Setting Up the Buffer, Top
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
417 @comment node-name, next, previous, up
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
418 @section Basic Types
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
419
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
420 The syntax of a type specification is given below:
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
421
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
422 @example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
423 NAME ::= (NAME [KEYWORD ARGUMENT]... ARGS)
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
424 | NAME
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
425 @end example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
426
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
427 Where, @var{name} is a widget name, @var{keyword} is the name of a
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
428 property, @var{argument} is the value of the property, and @var{args}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
429 are interpreted in a widget specific way.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
430
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
431 There following keyword arguments that apply to all widgets:
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
432
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
433 @table @code
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
434 @item :value
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
435 The initial value for widgets of this type.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
436
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
437 @item :format
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
438 This string will be inserted in the buffer when you create a widget.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
439 The following @samp{%} escapes are available:
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
440
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
441 @table @samp
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
442 @item %[
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
443 @itemx %]
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
444 The text inside will be marked as a button.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
445
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
446 @item %@{
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
447 @itemx %@}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
448 The text inside will be displayed with the face specified by
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
449 @code{:sample-face}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
450
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
451 @item %v
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
452 This will be replaces with the buffer representation of the widgets
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
453 value. What this is depends on the widget type.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
454
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
455 @item %d
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
456 Insert the string specified by @code{:doc} here.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
457
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
458 @item %h
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
459 Like @samp{%d}, with the following modifications: If the documentation
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
460 string is more than one line, it will add a button which will toggle
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
461 between showing only the first line, and showing the full text.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
462 Furthermore, if there is no @code{:doc} property in the widget, it will
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
463 instead examine the @code{:documentation-property} property. If it is a
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
464 lambda expression, it will be called with the widget's value as an
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
465 argument, and the result will be used as the documentation text.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
466
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
467 @item %t
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
468 Insert the string specified by @code{:tag} here, or the @code{princ}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
469 representation of the value if there is no tag.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
470
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
471 @item %%
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
472 Insert a literal @samp{%}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
473 @end table
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
474
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
475 @item :button-face
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
476 Face used to highlight text inside %[ %] in the format.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
477
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
478 @item :doc
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
479 The string inserted by the @samp{%d} escape in the format
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
480 string.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
481
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
482 @item :tag
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
483 The string inserted by the @samp{%t} escape in the format
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
484 string.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
485
22
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
486 @item :tag-glyph
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
487 Name of image to use instead of the string specified by `:tag' on
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
488 Emacsen that supports it.
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
489
16
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
490 @item :help-echo
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
491 Message displayed whenever you move to the widget with either
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
492 @code{widget-forward} or @code{widget-backward}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
493
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
494 @item :indent
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
495 An integer indicating the absolute number of spaces to indent children
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
496 of this widget.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
497
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
498 @item :offset
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
499 An integer indicating how many extra spaces to add to the widget's
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
500 grandchildren compared to this widget.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
501
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
502 @item :extra-offset
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
503 An integer indicating how many extra spaces to add to the widget's
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
504 children compared to this widget.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
505
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
506 @item :notify
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
507 A function called each time the widget or a nested widget is changed.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
508 The function is called with two or three arguments. The first argument
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
509 is the widget itself, the second argument is the widget that was
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
510 changed, and the third argument is the event leading to the change, if
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
511 any.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
512
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
513 @item :menu-tag
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
514 Tag used in the menu when the widget is used as an option in a
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
515 @code{menu-choice} widget.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
516
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
517 @item :menu-tag-get
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
518 Function used for finding the tag when the widget is used as an option
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
519 in a @code{menu-choice} widget. By default, the tag used will be either the
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
520 @code{:menu-tag} or @code{:tag} property if present, or the @code{princ}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
521 representation of the @code{:value} property if not.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
522
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
523 @item :match
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
524 Should be a function called with two arguments, the widget and a value,
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
525 and returning non-nil if the widget can represent the specified value.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
526
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
527 @item :validate
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
528 A function which takes a widget as an argument, and return nil if the
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
529 widgets current value is valid for the widget. Otherwise, it should
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
530 return the widget containing the invalid data, and set that widgets
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
531 @code{:error} property to a string explaining the error.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
532
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
533 @item :parent
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
534 The parent of a nested widget (e.g. a @code{menu-choice} item or an element of a
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
535 @code{editable-list} widget).
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
536 @end table
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
537
22
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
538 @deffn {User Option} widget-glyph-directory
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
539 Directory where glyphs are found.
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
540 Widget will look here for a file with the same name as specified for the
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
541 image, with either a @samp{.xpm} (if supported) or @samp{.xbm} extension.
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
542 @end deffn
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
543
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
544 @deffn{User Option} widget-glyph-enable
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
545 If non-nil, allow glyphs to appear on displayes where they are supported.
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
546 @end deffn
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
547
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
548
16
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
549 @menu
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
550 * link::
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
551 * url-link::
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
552 * info-link::
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
553 * push-button::
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
554 * editable-field::
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
555 * text::
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
556 * menu-choice::
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
557 * radio-button-choice::
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
558 * item::
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
559 * choice-item::
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
560 * toggle::
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
561 * checkbox::
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
562 * checklist::
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
563 * editable-list::
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
564 @end menu
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
565
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
566 @node link, url-link, Basic Types, Basic Types
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
567 @comment node-name, next, previous, up
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
568 @subsection The @code{link} Widget
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
569
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
570 Syntax:
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
571
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
572 @example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
573 TYPE ::= (link [KEYWORD ARGUMENT]... [ VALUE ])
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
574 @end example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
575
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
576 The @var{value}, if present, is used to initialize the @code{:value}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
577 property. The value should be a string, which will be inserted in the
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
578 buffer.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
579
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
580 @node url-link, info-link, link, Basic Types
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
581 @comment node-name, next, previous, up
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
582 @subsection The @code{url-link} Widget
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
583
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
584 Syntax:
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
585
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
586 @example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
587 TYPE ::= (url-link [KEYWORD ARGUMENT]... URL)
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
588 @end example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
589
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
590 When this link is activated, the @sc{www} browser specified by
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
591 @code{browse-url-browser-function} will be called with @var{url}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
592
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
593 @node info-link, push-button, url-link, Basic Types
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
594 @comment node-name, next, previous, up
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
595 @subsection The @code{info-link} Widget
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
596
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
597 Syntax:
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
598
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
599 @example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
600 TYPE ::= (info-link [KEYWORD ARGUMENT]... ADDRESS)
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
601 @end example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
602
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
603 When this link is activated, the build-in info browser is started on
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
604 @var{address}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
605
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
606 @node push-button, editable-field, info-link, Basic Types
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
607 @comment node-name, next, previous, up
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
608 @subsection The @code{push-button} Widget
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
609
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
610 Syntax:
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
611
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
612 @example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
613 TYPE ::= (push-button [KEYWORD ARGUMENT]... [ VALUE ])
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
614 @end example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
615
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
616 The @var{value}, if present, is used to initialize the @code{:value}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
617 property. The value should be a string, which will be inserted in the
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
618 buffer.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
619
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
620 @node editable-field, text, push-button, Basic Types
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
621 @comment node-name, next, previous, up
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
622 @subsection The @code{editable-field} Widget
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
623
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
624 Syntax:
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
625
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
626 @example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
627 TYPE ::= (editable-field [KEYWORD ARGUMENT]... [ VALUE ])
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
628 @end example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
629
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
630 The @var{value}, if present, is used to initialize the @code{:value}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
631 property. The value should be a string, which will be inserted in
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
632 field. This widget will match all string values.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
633
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
634 The following extra properties are recognized.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
635
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
636 @table @code
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
637 @item :size
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
638 The width of the editable field.@br
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
639 By default the field will reach to the end of the line.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
640
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
641 @item :value-face
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
642 Face used for highlighting the editable field. Default is
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
643 @code{widget-field-face}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
644
20
859a2309aef8 Import from CVS: tag r19-15b93
cvs
parents: 16
diff changeset
645 @item :secret
859a2309aef8 Import from CVS: tag r19-15b93
cvs
parents: 16
diff changeset
646 Character used to display the value. You can set this to e.g. @code{?*}
859a2309aef8 Import from CVS: tag r19-15b93
cvs
parents: 16
diff changeset
647 if the field contains a password or other secret information. By
859a2309aef8 Import from CVS: tag r19-15b93
cvs
parents: 16
diff changeset
648 default, the value is not secret.
859a2309aef8 Import from CVS: tag r19-15b93
cvs
parents: 16
diff changeset
649
859a2309aef8 Import from CVS: tag r19-15b93
cvs
parents: 16
diff changeset
650 @item :valid-regexp
859a2309aef8 Import from CVS: tag r19-15b93
cvs
parents: 16
diff changeset
651 By default the @code{:validate} function will match the content of the
859a2309aef8 Import from CVS: tag r19-15b93
cvs
parents: 16
diff changeset
652 field with the value of this attribute. The default value is @code{""}
859a2309aef8 Import from CVS: tag r19-15b93
cvs
parents: 16
diff changeset
653 which matches everything.
859a2309aef8 Import from CVS: tag r19-15b93
cvs
parents: 16
diff changeset
654
16
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
655 @item :keymap
20
859a2309aef8 Import from CVS: tag r19-15b93
cvs
parents: 16
diff changeset
656 Keymap used in the editable field. The default value is
859a2309aef8 Import from CVS: tag r19-15b93
cvs
parents: 16
diff changeset
657 @code{widget-field-keymap}, which allows you to use all the normal
859a2309aef8 Import from CVS: tag r19-15b93
cvs
parents: 16
diff changeset
658 editing commands, even if the buffers major mode supress some of them.
859a2309aef8 Import from CVS: tag r19-15b93
cvs
parents: 16
diff changeset
659 Pressing return activates the function specified by @code{:activate}.
16
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
660
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
661 @item :hide-front-space
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
662 @itemx :hide-rear-space
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
663 In order to keep track of the editable field, emacs places an invisible
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
664 space character in front of the field, and for fixed sized fields also
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
665 in the rear end of the field. For fields that extent to the end of the
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
666 line, the terminating linefeed serves that purpose instead.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
667
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
668 Emacs will try to make the spaces intangible when it is safe to do so.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
669 Intangible means that the cursor motion commands will skip over the
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
670 character as if it didn't exist. This is safe to do when the text
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
671 preceding or following the widget cannot possible change during the
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
672 lifetime of the @code{editable-field} widget. The preferred way to tell
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
673 Emacs this, is to add text to the @code{:format} property around the
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
674 value. For example @code{:format "Tag: %v "}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
675
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
676 You can overwrite the internal safety check by setting the
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
677 @code{:hide-front-space} or @code{:hide-rear-space} properties to
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
678 non-nil. This is not recommended. For example, @emph{all} text that
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
679 belongs to a widget (i.e. is created from its @code{:format} string) will
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
680 change whenever the widget changes its value.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
681
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
682 @end table
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
683
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
684 @node text, menu-choice, editable-field, Basic Types
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
685 @comment node-name, next, previous, up
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
686 @subsection The @code{text} Widget
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
687
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
688 This is just like @code{editable-field}, but intended for multiline text
20
859a2309aef8 Import from CVS: tag r19-15b93
cvs
parents: 16
diff changeset
689 fields. The default @code{:keymap} is @code{widget-text-keymap}, which
859a2309aef8 Import from CVS: tag r19-15b93
cvs
parents: 16
diff changeset
690 does not rebind the return key.
16
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
691
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
692 @node menu-choice, radio-button-choice, text, Basic Types
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
693 @comment node-name, next, previous, up
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
694 @subsection The @code{menu-choice} Widget
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
695
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
696 Syntax:
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
697
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
698 @example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
699 TYPE ::= (menu-choice [KEYWORD ARGUMENT]... TYPE ... )
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
700 @end example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
701
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
702 The @var{type} arguments represents each possible choice. The widgets
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
703 value of will be the value of the chosen @var{type} argument. This
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
704 widget will match any value that matches at least one of the specified
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
705 @var{type} arguments.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
706
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
707 @table @code
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
708 @item :void
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
709 Widget type used as a fallback when the value does not match any of the
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
710 specified @var{type} arguments.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
711
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
712 @item :case-fold
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
713 Set this to nil if you don't want to ignore case when prompting for a
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
714 choice through the minibuffer.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
715
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
716 @item :children
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
717 A list whose car is the widget representing the currently chosen type in
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
718 the buffer.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
719
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
720 @item :choice
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
721 The current chosen type
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
722
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
723 @item :args
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
724 The list of types.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
725 @end table
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
726
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
727 @node radio-button-choice, item, menu-choice, Basic Types
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
728 @comment node-name, next, previous, up
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
729 @subsection The @code{radio-button-choice} Widget
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
730
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
731 Syntax:
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
732
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
733 @example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
734 TYPE ::= (radio-button-choice [KEYWORD ARGUMENT]... TYPE ... )
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
735 @end example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
736
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
737 The @var{type} arguments represents each possible choice. The widgets
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
738 value of will be the value of the chosen @var{type} argument. This
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
739 widget will match any value that matches at least one of the specified
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
740 @var{type} arguments.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
741
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
742 The following extra properties are recognized.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
743
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
744 @table @code
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
745 @item :entry-format
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
746 This string will be inserted for each entry in the list.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
747 The following @samp{%} escapes are available:
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
748 @table @samp
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
749 @item %v
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
750 Replaced with the buffer representation of the @var{type} widget.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
751 @item %b
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
752 Replace with the radio button.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
753 @item %%
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
754 Insert a literal @samp{%}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
755 @end table
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
756
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
757 @item :buttons
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
758 The widgets representing the radio buttons.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
759
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
760 @item :children
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
761 The widgets representing each type.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
762
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
763 @item :choice
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
764 The current chosen type
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
765
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
766 @item :args
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
767 The list of types.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
768 @end table
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
769
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
770 You can add extra radio button items to a @code{radio-button-choice}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
771 widget after it has been created with the function
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
772 @code{widget-radio-add-item}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
773
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
774 @defun widget-radio-add-item widget type
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
775 Add to @code{radio-button-choice} widget @var{widget} a new radio button item of type
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
776 @var{type}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
777 @end defun
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
778
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
779 Please note that such items added after the @code{radio-button-choice}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
780 widget has been created will @strong{not} be properly destructed when
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
781 you call @code{widget-delete}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
782
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
783 @node item, choice-item, radio-button-choice, Basic Types
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
784 @comment node-name, next, previous, up
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
785 @subsection The @code{item} Widget
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
786
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
787 Syntax:
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
788
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
789 @example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
790 ITEM ::= (item [KEYWORD ARGUMENT]... VALUE)
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
791 @end example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
792
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
793 The @var{value}, if present, is used to initialize the @code{:value}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
794 property. The value should be a string, which will be inserted in the
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
795 buffer. This widget will only match the specified value.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
796
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
797 @node choice-item, toggle, item, Basic Types
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
798 @comment node-name, next, previous, up
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
799 @subsection The @code{choice-item} Widget
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
800
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
801 Syntax:
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
802
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
803 @example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
804 ITEM ::= (choice-item [KEYWORD ARGUMENT]... VALUE)
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
805 @end example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
806
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
807 The @var{value}, if present, is used to initialize the @code{:value}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
808 property. The value should be a string, which will be inserted in the
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
809 buffer as a button. Activating the button of a @code{choice-item} is
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
810 equivalent to activating the parent widget. This widget will only match
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
811 the specified value.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
812
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
813 @node toggle, checkbox, choice-item, Basic Types
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
814 @comment node-name, next, previous, up
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
815 @subsection The @code{toggle} Widget
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
816
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
817 Syntax:
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
818
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
819 @example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
820 TYPE ::= (toggle [KEYWORD ARGUMENT]...)
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
821 @end example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
822
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
823 The widget has two possible states, `on' and `off', which corresponds to
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
824 a @code{t} or @code{nil} value.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
825
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
826 The following extra properties are recognized.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
827
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
828 @table @code
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
829 @item :on
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
830 String representing the `on' state. By default the string @samp{on}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
831 @item :off
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
832 String representing the `off' state. By default the string @samp{off}.
22
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
833 @item :on-glyph
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
834 Name of a glyph to be used instead of the `:on' text string, on emacsen
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
835 that supports it.
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
836 @item :off-glyph
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
837 Name of a glyph to be used instead of the `:off' text string, on emacsen
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
838 that supports it.
16
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
839 @end table
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
840
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
841 @node checkbox, checklist, toggle, Basic Types
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
842 @comment node-name, next, previous, up
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
843 @subsection The @code{checkbox} Widget
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
844
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
845 The widget has two possible states, `selected' and `unselected', which
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
846 corresponds to a @code{t} or @code{nil} value.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
847
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
848 Syntax:
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
849
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
850 @example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
851 TYPE ::= (checkbox [KEYWORD ARGUMENT]...)
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
852 @end example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
853
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
854 @node checklist, editable-list, checkbox, Basic Types
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
855 @comment node-name, next, previous, up
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
856 @subsection The @code{checklist} Widget
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
857
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
858 Syntax:
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
859
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
860 @example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
861 TYPE ::= (checklist [KEYWORD ARGUMENT]... TYPE ... )
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
862 @end example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
863
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
864 The @var{type} arguments represents each checklist item. The widgets
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
865 value of will be a list containing the value of each ticked @var{type}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
866 argument. The checklist widget will match a list whose elements all
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
867 matches at least one of the specified @var{type} arguments.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
868
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
869 The following extra properties are recognized.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
870
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
871 @table @code
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
872 @item :entry-format
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
873 This string will be inserted for each entry in the list.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
874 The following @samp{%} escapes are available:
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
875 @table @samp
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
876 @item %v
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
877 Replaced with the buffer representation of the @var{type} widget.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
878 @item %b
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
879 Replace with the checkbox.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
880 @item %%
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
881 Insert a literal @samp{%}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
882 @end table
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
883
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
884 @item :buttons
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
885 The widgets representing the checkboxes.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
886
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
887 @item :children
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
888 The widgets representing each type.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
889
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
890 @item :args
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
891 The list of types.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
892 @end table
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
893
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
894 @node editable-list, , checklist, Basic Types
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
895 @comment node-name, next, previous, up
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
896 @subsection The @code{editable-list} Widget
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
897
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
898 Syntax:
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
899
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
900 @example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
901 TYPE ::= (editable-list [KEYWORD ARGUMENT]... TYPE)
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
902 @end example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
903
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
904 The value is a list, where each member represent one widget of type
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
905 @var{type}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
906
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
907 The following extra properties are recognized.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
908
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
909 @table @code
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
910 @item :entry-format
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
911 This string will be inserted for each entry in the list.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
912 The following @samp{%} escapes are available:
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
913 @table @samp
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
914 @item %v
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
915 This will be replaced with the buffer representation of the @var{type}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
916 widget.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
917 @item %i
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
918 Insert the @b{[INS]} button.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
919 @item %d
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
920 Insert the @b{[DEL]} button.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
921 @item %%
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
922 Insert a literal @samp{%}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
923 @end table
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
924
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
925 @item :buttons
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
926 The widgets representing the insert and delete buttons.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
927
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
928 @item :children
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
929 The widgets representing the elements of the list.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
930
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
931 @item :args
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
932 List whose car is the type of the list elements.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
933
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
934 @end table
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
935
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
936 @node Sexp Types, Widget Properties, Basic Types, Top
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
937 @comment
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
938 @section Sexp Types
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
939
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
940 A number of widgets for editing s-expressions (lisp types) are also
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
941 available. These basically fall in three categories: @dfn{atoms},
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
942 @dfn{composite types}, and @dfn{generic}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
943
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
944 @menu
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
945 * generic::
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
946 * atoms::
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
947 * composite::
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
948 @end menu
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
949
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
950 @node generic, atoms, Sexp Types, Sexp Types
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
951 @comment node-name, next, previous, up
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
952 @subsection The Generic Widget.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
953
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
954 The @code{const} and @code{sexp} widgets can contain any lisp
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
955 expression. In the case of the @code{const} widget the user is
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
956 prohibited from editing edit it, which is mainly useful as a component
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
957 of one of the composite widgets.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
958
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
959 The syntax for the generic widgets is
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
960
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
961 @example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
962 TYPE ::= (const [KEYWORD ARGUMENT]... [ VALUE ])
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
963 @end example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
964
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
965 The @var{value}, if present, is used to initialize the @code{:value}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
966 property and can be any s-expression.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
967
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
968 @deffn Widget const
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
969 This will display any valid s-expression in an immutable part of the
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
970 buffer.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
971 @end deffn
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
972
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
973 @deffn Widget sexp
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
974 This will allow you to edit any valid s-expression in an editable buffer
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
975 field.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
976
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
977 The @code{sexp} widget takes the same keyword arguments as the
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
978 @code{editable-field} widget.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
979 @end deffn
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
980
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
981 @node atoms, composite, generic, Sexp Types
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
982 @comment node-name, next, previous, up
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
983 @subsection Atomic Sexp Widgets.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
984
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
985 The atoms are s-expressions that does not consist of other
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
986 s-expressions. A string is an atom, while a list is a composite type.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
987 You can edit the value of an atom with the following widgets.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
988
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
989 The syntax for all the atoms are
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
990
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
991 @example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
992 TYPE ::= (NAME [KEYWORD ARGUMENT]... [ VALUE ])
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
993 @end example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
994
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
995 The @var{value}, if present, is used to initialize the @code{:value}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
996 property and must be an expression of the same type as the widget.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
997 I.e. the string widget can only be initialized with a string.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
998
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
999 All the atom widgets take the same keyword arguments as the @code{editable-field}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1000 widget.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1001
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1002 @deffn Widget string
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1003 Allows you to edit a string in an editable field.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1004 @end deffn
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1005
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1006 @deffn Widget file
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1007 Allows you to edit a file name in an editable field. You you activate
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1008 the tag button, you can edit the file name in the mini-buffer with
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1009 completion.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1010
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1011 Keywords:
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1012 @table @code
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1013 @item :must-match
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1014 If this is set to non-nil, only existing file names will be allowed in
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1015 the minibuffer.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1016 @end table
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1017 @end deffn
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1018
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1019 @deffn Widget directory
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1020 Allows you to edit a directory name in an editable field.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1021 Similar to the @code{file} widget.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1022 @end deffn
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1023
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1024 @deffn Widget symbol
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1025 Allows you to edit a lisp symbol in an editable field.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1026 @end deffn
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1027
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1028 @deffn Widget integer
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1029 Allows you to edit an integer in an editable field.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1030 @end deffn
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1031
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1032 @deffn Widget number
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1033 Allows you to edit a number in an editable field.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1034 @end deffn
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1035
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1036 @deffn Widget boolean
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1037 Allows you to edit a boolean. In lisp this means a variable which is
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1038 either nil meaning false, or non-nil meaning true.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1039 @end deffn
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1040
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1041
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1042 @node composite, , atoms, Sexp Types
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1043 @comment node-name, next, previous, up
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1044 @subsection Composite Sexp Widgets.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1045
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1046 The syntax for the composite are
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1047
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1048 @example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1049 TYPE ::= (NAME [KEYWORD ARGUMENT]... COMPONENT...)
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1050 @end example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1051
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1052 Where each @var{component} must be a widget type. Each component widget
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1053 will be displayed in the buffer, and be editable to the user.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1054
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1055 @deffn Widget cons
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1056 The value of a @code{cons} widget is a cons-cell where the car is the
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1057 value of the first component and the cdr is the value of the second
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1058 component. There must be exactly two components.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1059 @end deffn
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1060
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1061 @deffn Widget lisp
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1062 The value of a @code{lisp} widget is a list containing the value of
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1063 each of its component.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1064 @end deffn
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1065
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1066 @deffn Widget vector
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1067 The value of a @code{vector} widget is a vector containing the value of
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1068 each of its component.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1069 @end deffn
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1070
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1071 The above suffice for specifying fixed size lists and vectors. To get
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1072 variable length lists and vectors, you can use a @code{choice},
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1073 @code{set} or @code{repeat} widgets together with the @code{:inline}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1074 keywords. If any component of a composite widget has the @code{:inline}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1075 keyword set, its value must be a list which will then be spliced into
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1076 the composite. For example, to specify a list whose first element must
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1077 be a file name, and whose remaining arguments should either by the
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1078 symbol @code{t} or two files, you can use the following widget
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1079 specification:
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1080
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1081 @example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1082 (list file
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1083 (choice (const t)
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1084 (list :inline t
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1085 :value ("foo" "bar")
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1086 string string)))
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1087 @end example
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1088
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1089 The value of a widget of this type will either have the form
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1090 @samp{(file t)} or @code{(file string string)}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1091
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1092 This concept of inline is probably hard to understand. It was certainly
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1093 hard to implement so instead of confuse you more by trying to explain it
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1094 here, I'll just suggest you meditate over it for a while.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1095
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1096 @deffn Widget choice
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1097 Allows you to edit a sexp which may have one of fixed set of types. It
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1098 is currently implemented with the @code{choice-menu} basic widget, and
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1099 has a similar syntax.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1100 @end deffn
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1101
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1102 @deffn Widget set
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1103 Allows you to specify a type which must be a list whose elements all
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1104 belong to given set. The elements of the list is not significant. This
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1105 is implemented on top of the @code{checklist} basic widget, and has a
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1106 similar syntax.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1107 @end deffn
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1108
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1109 @deffn Widget repeat
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1110 Allows you to specify a variable length list whose members are all of
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1111 the same type. Implemented on top of the `editable-list' basic widget,
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1112 and has a similar syntax.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1113 @end deffn
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1114
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1115 @node Widget Properties, Defining New Widgets, Sexp Types, Top
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1116 @comment node-name, next, previous, up
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1117 @section Properties
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1118
20
859a2309aef8 Import from CVS: tag r19-15b93
cvs
parents: 16
diff changeset
1119 You can examine or set the value of a widget by using the widget object
859a2309aef8 Import from CVS: tag r19-15b93
cvs
parents: 16
diff changeset
1120 that was returned by @code{widget-create}.
16
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1121
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1122 @defun widget-value widget
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1123 Return the current value contained in @var{widget}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1124 It is an error to call this function on an uninitialized widget.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1125 @end defun
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1126
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1127 @defun widget-value-set widget value
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1128 Set the value contained in @var{widget} to @var{value}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1129 It is an error to call this function with an invalid @var{value}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1130 @end defun
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1131
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1132 @strong{Important:} You @emph{must} call @code{widget-setup} after
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1133 modifying the value of a widget before the user is allowed to edit the
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1134 widget again. It is enough to call @code{widget-setup} once if you
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1135 modify multiple widgets. This is currently only necessary if the widget
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1136 contains an editing field, but may be necessary for other widgets in the
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1137 future.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1138
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1139 If your application needs to associate some information with the widget
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1140 objects, for example a reference to the item being edited, it can be
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1141 done with @code{widget-put} and @code{widget-get}. The property names
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1142 must begin with a @samp{:}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1143
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1144 @defun widget-put widget property value
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1145 In @var{widget} set @var{property} to @var{value}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1146 @var{property} should be a symbol, while @var{value} can be anything.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1147 @end defun
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1148
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1149 @defun widget-get widget property
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1150 In @var{widget} return the value for @var{property}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1151 @var{property} should be a symbol, the value is what was last set by
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1152 @code{widget-put} for @var{property}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1153 @end defun
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1154
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1155 @defun widget-member widget property
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1156 Non-nil if @var{widget} has a value (even nil) for property @var{property}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1157 @end defun
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1158
20
859a2309aef8 Import from CVS: tag r19-15b93
cvs
parents: 16
diff changeset
1159 Occasionally it can be useful to know which kind of widget you have,
859a2309aef8 Import from CVS: tag r19-15b93
cvs
parents: 16
diff changeset
1160 i.e. the name of the widget type you gave when the widget was created.
859a2309aef8 Import from CVS: tag r19-15b93
cvs
parents: 16
diff changeset
1161
22
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
1162 @defun widget-type widget
20
859a2309aef8 Import from CVS: tag r19-15b93
cvs
parents: 16
diff changeset
1163 Return the name of @var{widget}, a symbol.
859a2309aef8 Import from CVS: tag r19-15b93
cvs
parents: 16
diff changeset
1164 @end defun
859a2309aef8 Import from CVS: tag r19-15b93
cvs
parents: 16
diff changeset
1165
16
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1166 @node Defining New Widgets, Widget Wishlist., Widget Properties, Top
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1167 @comment node-name, next, previous, up
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1168 @section Defining New Widgets
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1169
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1170 You can define specialized widgets with @code{define-widget}. It allows
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1171 you to create a shorthand for more complex widgets, including specifying
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1172 component widgets and default new default values for the keyword
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1173 arguments.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1174
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1175 @defun widget-define name class doc &rest args
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1176 Define a new widget type named @var{name} from @code{class}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1177
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1178 @var{name} and class should both be symbols, @code{class} should be one
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1179 of the existing widget types.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1180
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1181 The third argument @var{DOC} is a documentation string for the widget.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1182
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1183 After the new widget has been defined, the following two calls will
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1184 create identical widgets:
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1185
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1186 @itemize @bullet
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1187 @item
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1188 @lisp
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1189 (widget-create @var{name})
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1190 @end lisp
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1191
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1192 @item
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1193 @lisp
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1194 (apply widget-create @var{class} @var{args})
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1195 @end lisp
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1196 @end itemize
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1197
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1198 @end defun
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1199
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1200 Using @code{widget-define} does just store the definition of the widget
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1201 type in the @code{widget-type} property of @var{name}, which is what
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1202 @code{widget-create} uses.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1203
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1204 If you just want to specify defaults for keywords with no complex
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1205 conversions, you can use @code{identity} as your conversion function.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1206
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1207 The following additional keyword arguments are useful when defining new
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1208 widgets:
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1209 @table @code
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1210 @item :convert-widget
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1211 Function to convert a widget type before creating a widget of that
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1212 type. It takes a widget type as an argument, and returns the converted
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1213 widget type. When a widget is created, this function is called for the
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1214 widget type and all the widgets parent types, most derived first.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1215
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1216 @item :value-to-internal
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1217 Function to convert the value to the internal format. The function
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1218 takes two arguments, a widget and an external value, and returns the
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1219 internal value. The function is called on the present @code{:value}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1220 when the widget is created, and on any value set later with
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1221 @code{widget-value-set}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1222
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1223 @item :value-to-external
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1224 Function to convert the value to the external format. The function
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1225 takes two arguments, a widget and an internal value, and returns the
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1226 internal value. The function is called on the present @code{:value}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1227 when the widget is created, and on any value set later with
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1228 @code{widget-value-set}.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1229
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1230 @item :create
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1231 Function to create a widget from scratch. The function takes one
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1232 argument, a widget type, and create a widget of that type, insert it in
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1233 the buffer, and return a widget object.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1234
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1235 @item :delete
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1236 Function to delete a widget. The function takes one argument, a widget,
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1237 and should remove all traces of the widget from the buffer.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1238
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1239 @item :value-create
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1240 Function to expand the @samp{%v} escape in the format string. It will
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1241 be called with the widget as its argument. Should
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1242 insert a representation of the widgets value in the buffer.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1243
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1244 @item :value-delete
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1245 Should remove the representation of the widgets value from the buffer.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1246 It will be called with the widget as its argument. It doesn't have to
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1247 remove the text, but it should release markers and delete nested widgets
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1248 if such has been used.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1249
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1250 @item :format-handler
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1251 Function to handle unknown @samp{%} escapes in the format string. It
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1252 will be called with the widget and the escape character as arguments.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1253 You can set this to allow your widget to handle non-standard escapes.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1254
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1255 You should end up calling @code{widget-default-format-handler} to handle
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1256 unknown escape sequences, which will handle the @samp{%h} and any future
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1257 escape sequences, as well as give an error for unknown escapes.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1258 @end table
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1259
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1260 If you want to define a new widget from scratch, use the @code{default}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1261 widget as its base.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1262
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1263 @deffn Widget default [ keyword argument ]
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1264 Widget used as a base for other widgets.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1265
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1266 It provides most of the functionality that is referred to as ``by
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1267 default'' in this text.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1268 @end deffn
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1269
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1270 @node Widget Wishlist., , Defining New Widgets, Top
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1271 @comment node-name, next, previous, up
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1272 @section Wishlist.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1273
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1274 @itemize @bullet
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1275 @item
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1276 It should be possible to add or remove items from a list with @kbd{C-k}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1277 and @kbd{C-o} (suggested by @sc{rms}).
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1278
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1279 @item
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1280 The @samp{[INS]} and @samp{[DEL]} buttons should be replaced by a single
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1281 dash (@samp{-}). The dash should be a button that, when activated, ask
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1282 whether you want to add or delete an item (@sc{rms} wanted to git rid of
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1283 the ugly buttons, the dash is my idea).
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1284
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1285 @item
20
859a2309aef8 Import from CVS: tag r19-15b93
cvs
parents: 16
diff changeset
1286 Widgets such as @code{file} and @code{symbol} should prompt with completion.
16
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1287
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1288 @item
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1289 The @code{menu-choice} tag should be prettier, something like the abbreviated
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1290 menus in Open Look.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1291
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1292 @item
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1293 The functions used in many widgets, like
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1294 @code{widget-item-convert-widget}, should not have names that are
20
859a2309aef8 Import from CVS: tag r19-15b93
cvs
parents: 16
diff changeset
1295 specific to the first widget where I happended to use them.
16
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1296
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1297 @item
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1298 Unchecked items in a @code{radio-button-choice} or @code{checklist}
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1299 should be grayed out, and the subwidgets should somehow become inactive.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1300 This could perhaps be implemented by binding @code{widget-inactive} to t
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1301 when inserting the grayed out subwidget, and let the widget-specify
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1302 functions check that variable.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1303
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1304 @item
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1305 Flag to make @code{widget-move} skip a specified button.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1306
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1307 @item
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1308 Document `helper' functions for defining new widgets.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1309
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1310 @item
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1311 Activate the item this is below the mouse when the button is
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1312 released, not the item this is below the mouse when the button is
22
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
1313 pressed. Dired and grep gets this right. Give feedback if possible.
16
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1314
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1315 @item
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1316 Use @samp{@@deffn Widget} to document widgets.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1317
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1318 @item
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1319 Document global keywords in one place.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1320
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1321 Document keywords particular to a specific widget in the widget
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1322 definition.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1323
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1324 Document the `default' widget first.
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1325
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1326 Split, when needed, keywords into those useful for normal
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1327 customization, those primarily useful when deriving, and those who
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1328 represent runtime information.
22
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
1329
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
1330 @item
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
1331 Figure out terminology and @sc{api} for the class/type/object/super
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
1332 stuff.
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
1333
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
1334 Perhaps the correct model is delegation?
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
1335
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
1336 @item
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
1337 Document @code{widget-browse}.
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
1338
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
1339 @item
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
1340 Make indentation work with glyphs and propertional fonts.
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
1341
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
1342 @item
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
1343 Add object and class hierarchies to the browser.
8fc7fe29b841 Import from CVS: tag r19-15b94
cvs
parents: 20
diff changeset
1344
16
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1345 @end itemize
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1346
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1347 @contents
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents:
diff changeset
1348 @bye