Mercurial > emacs
annotate man/widget.texi @ 31619:2e04fd5094c1
*** empty log message ***
author | Andrew Innes <andrewi@gnu.org> |
---|---|
date | Thu, 14 Sep 2000 21:19:58 +0000 |
parents | 33d2bde9a99a |
children | f4da0c6d4336 |
rev | line source |
---|---|
25829 | 1 \input texinfo.tex |
2 | |
3 @c %**start of header | |
4 @setfilename ../info/widget | |
5 @settitle The Emacs Widget Library | |
6 @iftex | |
7 @afourpaper | |
8 @headings double | |
9 @end iftex | |
10 @c %**end of header | |
11 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
12 @syncodeindex fn cp |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
13 @syncodeindex vr cp |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
14 @syncodeindex ky cp |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
15 |
30009 | 16 @dircategory Emacs |
25829 | 17 @direntry |
18 * Widget: (widget). Documenting the "widget" package used by the | |
19 Emacs Custom facility. | |
20 @end direntry | |
21 | |
22 @node Top, Introduction, (dir), (dir) | |
23 @comment node-name, next, previous, up | |
24 @top The Emacs Widget Library | |
25 | |
26 @menu | |
27 * Introduction:: | |
28 * User Interface:: | |
29 * Programming Example:: | |
30 * Setting Up the Buffer:: | |
31 * Basic Types:: | |
32 * Sexp Types:: | |
33 * Widget Properties:: | |
34 * Defining New Widgets:: | |
35 * Widget Browser:: | |
36 * Widget Minor Mode:: | |
37 * Utilities:: | |
38 * Widget Wishlist:: | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
39 * Index:: |
25829 | 40 @end menu |
41 | |
42 @node Introduction, User Interface, Top, Top | |
43 @comment node-name, next, previous, up | |
44 @section Introduction | |
45 | |
46 Most graphical user interface toolkits, such as Motif and XView, provide | |
47 a number of standard user interface controls (sometimes known as | |
48 `widgets' or `gadgets'). Emacs doesn't really support anything like | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
49 this, except for an incredibly powerful text ``widget''. On the other |
25829 | 50 hand, Emacs does provide the necessary primitives to implement many |
51 other widgets within a text buffer. The @code{widget} package | |
52 simplifies this task. | |
53 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
54 @cindex basic widgets |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
55 @cindex widgets, basic types |
25829 | 56 The basic widgets are: |
57 | |
58 @table @code | |
59 @item link | |
60 Areas of text with an associated action. Intended for hypertext links | |
61 embedded in text. | |
62 @item push-button | |
63 Like link, but intended for stand-alone buttons. | |
64 @item editable-field | |
65 An editable text field. It can be either variable or fixed length. | |
66 @item menu-choice | |
67 Allows the user to choose one of multiple options from a menu, each | |
68 option is itself a widget. Only the selected option will be visible in | |
69 the buffer. | |
70 @item radio-button-choice | |
71 Allows the user to choose one of multiple options by activating radio | |
72 buttons. The options are implemented as widgets. All options will be | |
73 visible in the buffer. | |
74 @item item | |
75 A simple constant widget intended to be used in the @code{menu-choice} and | |
76 @code{radio-button-choice} widgets. | |
77 @item choice-item | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
78 A button item only intended for use in choices. When invoked, the user |
25829 | 79 will be asked to select another option from the choice widget. |
80 @item toggle | |
81 A simple @samp{on}/@samp{off} switch. | |
82 @item checkbox | |
83 A checkbox (@samp{[ ]}/@samp{[X]}). | |
84 @item editable-list | |
85 Create an editable list. The user can insert or delete items in the | |
86 list. Each list item is itself a widget. | |
87 @end table | |
88 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
89 Now, of what possible use can support for widgets be in a text editor? |
25829 | 90 I'm glad you asked. The answer is that widgets are useful for |
91 implementing forms. A @dfn{form} in Emacs is a buffer where the user is | |
92 supposed to fill out a number of fields, each of which has a specific | |
93 meaning. The user is not supposed to change or delete any of the text | |
94 between the fields. Examples of forms in Emacs are the @file{forms} | |
95 package (of course), the customize buffers, the mail and news compose | |
96 modes, and the @sc{html} form support in the @file{w3} browser. | |
97 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
98 @cindex widget library, why use it |
25829 | 99 The advantages for a programmer of using the @code{widget} package to |
100 implement forms are: | |
101 | |
102 @enumerate | |
103 @item | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
104 More complex fields than just editable text are supported. |
25829 | 105 @item |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
106 You can give the users immediate feedback if they enter invalid data in a |
25829 | 107 text field, and sometimes prevent entering invalid data. |
108 @item | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
109 You can have fixed sized fields, thus allowing multiple fields to be |
25829 | 110 lined up in columns. |
111 @item | |
112 It is simple to query or set the value of a field. | |
113 @item | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
114 Editing happens in the buffer, not in the mini-buffer. |
25829 | 115 @item |
116 Packages using the library get a uniform look, making them easier for | |
117 the user to learn. | |
118 @item | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
119 As support for embedded graphics improve, the widget library will be |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
120 extended to use the GUI features. This means that your code using the |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
121 widget library will also use the new graphic features automatically. |
25829 | 122 @end enumerate |
123 | |
124 In order to minimize the code that is loaded by users who does not | |
125 create any widgets, the code has been split in two files: | |
126 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
127 @cindex widget library, files |
25829 | 128 @table @file |
129 @item widget.el | |
130 This will declare the user variables, define the function | |
131 @code{widget-define}, and autoload the function @code{widget-create}. | |
132 @item wid-edit.el | |
133 Everything else is here, there is no reason to load it explicitly, as | |
134 it will be autoloaded when needed. | |
135 @end table | |
136 | |
137 @node User Interface, Programming Example, Introduction, Top | |
138 @comment node-name, next, previous, up | |
139 @section User Interface | |
140 | |
141 A form consist of read only text for documentation and some fields, | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
142 where each field contains two parts, a tag and a value. The tags are |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
143 used to identify the fields, so the documentation can refer to the |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
144 @samp{foo field}, meaning the field tagged with @samp{Foo}. Here is an |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
145 example form: |
25829 | 146 |
147 @example | |
148 Here is some documentation. | |
149 | |
150 Name: @i{My Name} @strong{Choose}: This option | |
151 Address: @i{Some Place | |
152 In some City | |
153 Some country.} | |
154 | |
155 See also @b{_other work_} for more information. | |
156 | |
157 Numbers: count to three below | |
158 @b{[INS]} @b{[DEL]} @i{One} | |
159 @b{[INS]} @b{[DEL]} @i{Eh, two?} | |
160 @b{[INS]} @b{[DEL]} @i{Five!} | |
161 @b{[INS]} | |
162 | |
163 Select multiple: | |
164 | |
165 @b{[X]} This | |
166 @b{[ ]} That | |
167 @b{[X]} Thus | |
168 | |
169 Select one: | |
170 | |
171 @b{(*)} One | |
172 @b{( )} Another One. | |
173 @b{( )} A Final One. | |
174 | |
175 @b{[Apply Form]} @b{[Reset Form]} | |
176 @end example | |
177 | |
178 The top level widgets in is example are tagged @samp{Name}, | |
179 @samp{Choose}, @samp{Address}, @samp{_other work_}, @samp{Numbers}, | |
180 @samp{Select multiple}, @samp{Select one}, @samp{[Apply Form]}, and | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
181 @samp{[Reset Form]}. There are basically two things the user can do |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
182 within a form, namely editing the editable text fields and activating |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
183 the buttons. |
25829 | 184 |
185 @subsection Editable Text Fields | |
186 | |
187 In the example, the value for the @samp{Name} is most likely displayed | |
188 in an editable text field, and so are values for each of the members of | |
189 the @samp{Numbers} list. All the normal Emacs editing operations are | |
190 available for editing these fields. The only restriction is that each | |
191 change you make must be contained within a single editable text field. | |
192 For example, capitalizing all text from the middle of one field to the | |
193 middle of another field is prohibited. | |
194 | |
195 Editing text fields are created by the @code{editable-field} widget. | |
196 | |
197 The editing text fields are highlighted with the | |
198 @code{widget-field-face} face, making them easy to find. | |
199 | |
200 @deffn Face widget-field-face | |
201 Face used for other editing fields. | |
202 @end deffn | |
203 | |
204 @subsection Buttons | |
205 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
206 @cindex widget buttons |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
207 @cindex button widgets |
25829 | 208 Some portions of the buffer have an associated @dfn{action}, which can |
209 be @dfn{invoked} by a standard key or mouse command. These portions | |
210 are called @dfn{buttons}. The default commands for activating a button | |
211 are: | |
212 | |
213 @table @kbd | |
214 @item @key{RET} | |
215 @deffn Command widget-button-press @var{pos} &optional @var{event} | |
216 Invoke the button at @var{pos}, defaulting to point. | |
217 If point is not located on a button, invoke the binding in | |
218 @code{widget-global-map} (by default the global map). | |
219 @end deffn | |
220 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
221 @kindex mouse-2, on button widgets |
25829 | 222 @item mouse-2 |
223 @deffn Command widget-button-click @var{event} | |
224 Invoke the button at the location of the mouse pointer. If the mouse | |
225 pointer is located in an editable text field, invoke the binding in | |
226 @code{widget-global-map} (by default the global map). | |
227 @end deffn | |
228 @end table | |
229 | |
230 There are several different kind of buttons, all of which are present in | |
231 the example: | |
232 | |
233 @table @emph | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
234 @cindex option field tag |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
235 @item The Option Field Tags |
25829 | 236 When you invoke one of these buttons, you will be asked to choose |
237 between a number of different options. This is how you edit an option | |
238 field. Option fields are created by the @code{menu-choice} widget. In | |
239 the example, @samp{@b{Choose}} is an option field tag. | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
240 @item The @samp{@b{[INS]}} and @samp{@b{[DEL]}} buttons |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
241 Activating these will insert or delete elements from an editable list. |
25829 | 242 The list is created by the @code{editable-list} widget. |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
243 @cindex embedded buttons |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
244 @item Embedded Buttons |
25829 | 245 The @samp{@b{_other work_}} is an example of an embedded |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
246 button. Embedded buttons are not associated with a fields, but can serve |
25829 | 247 any purpose, such as implementing hypertext references. They are |
248 usually created by the @code{link} widget. | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
249 @item The @samp{@b{[ ]}} and @samp{@b{[X]}} buttons |
25829 | 250 Activating one of these will convert it to the other. This is useful |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
251 for implementing multiple-choice fields. You can create it with the |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
252 @code{checkbox} widget. |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
253 @item The @samp{@b{( )}} and @samp{@b{(*)}} buttons |
25829 | 254 Only one radio button in a @code{radio-button-choice} widget can be |
255 selected at any time. When you invoke one of the unselected radio | |
256 buttons, it will be selected and the previous selected radio button will | |
257 become unselected. | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
258 @item The @samp{@b{[Apply Form]}} @samp{@b{[Reset Form]}} buttons |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
259 These are explicit buttons made with the @code{push-button} widget. The |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
260 main difference from the @code{link} widget is that the buttons will be |
25829 | 261 displayed as GUI buttons when possible. |
262 @end table | |
263 | |
264 To make them easier to locate, buttons are emphasized in the buffer. | |
265 | |
266 @deffn Face widget-button-face | |
267 Face used for buttons. | |
268 @end deffn | |
269 | |
270 @defopt widget-mouse-face | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
271 Face used for highlighting a button when the mouse pointer moves across |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
272 it. |
25829 | 273 @end defopt |
274 | |
275 @subsection Navigation | |
276 | |
277 You can use all the normal Emacs commands to move around in a form | |
278 buffer, plus you will have these additional commands: | |
279 | |
280 @table @kbd | |
281 @item @key{TAB} | |
282 @deffn Command widget-forward &optional count | |
283 Move point @var{count} buttons or editing fields forward. | |
284 @end deffn | |
285 @item @key{M-TAB} | |
286 @deffn Command widget-backward &optional count | |
287 Move point @var{count} buttons or editing fields backward. | |
288 @end deffn | |
289 @end table | |
290 | |
291 @node Programming Example, Setting Up the Buffer, User Interface, Top | |
292 @comment node-name, next, previous, up | |
293 @section Programming Example | |
294 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
295 @cindex widgets, programming example |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
296 @cindex example of using widgets |
25829 | 297 Here is the code to implement the user interface example (@pxref{User |
298 Interface}). | |
299 | |
300 @lisp | |
301 (require 'widget) | |
302 | |
303 (eval-when-compile | |
304 (require 'wid-edit)) | |
305 | |
306 (defvar widget-example-repeat) | |
307 | |
308 (defun widget-example () | |
309 "Create the widgets from the Widget manual." | |
310 (interactive) | |
311 (switch-to-buffer "*Widget Example*") | |
312 (kill-all-local-variables) | |
313 (make-local-variable 'widget-example-repeat) | |
314 (let ((inhibit-read-only t)) | |
315 (erase-buffer)) | |
316 (widget-insert "Here is some documentation.\n\nName: ") | |
317 (widget-create 'editable-field | |
318 :size 13 | |
319 "My Name") | |
320 (widget-create 'menu-choice | |
321 :tag "Choose" | |
322 :value "This" | |
323 :help-echo "Choose me, please!" | |
324 :notify (lambda (widget &rest ignore) | |
325 (message "%s is a good choice!" | |
326 (widget-value widget))) | |
327 '(item :tag "This option" :value "This") | |
328 '(choice-item "That option") | |
329 '(editable-field :menu-tag "No option" "Thus option")) | |
330 (widget-insert "Address: ") | |
331 (widget-create 'editable-field | |
332 "Some Place\nIn some City\nSome country.") | |
333 (widget-insert "\nSee also ") | |
334 (widget-create 'link | |
335 :notify (lambda (&rest ignore) | |
336 (widget-value-set widget-example-repeat | |
337 '("En" "To" "Tre")) | |
338 (widget-setup)) | |
339 "other work") | |
340 (widget-insert " for more information.\n\nNumbers: count to three below\n") | |
341 (setq widget-example-repeat | |
342 (widget-create 'editable-list | |
343 :entry-format "%i %d %v" | |
344 :notify (lambda (widget &rest ignore) | |
345 (let ((old (widget-get widget | |
346 ':example-length)) | |
347 (new (length (widget-value widget)))) | |
348 (unless (eq old new) | |
349 (widget-put widget ':example-length new) | |
350 (message "You can count to %d." new)))) | |
351 :value '("One" "Eh, two?" "Five!") | |
352 '(editable-field :value "three"))) | |
353 (widget-insert "\n\nSelect multiple:\n\n") | |
354 (widget-create 'checkbox t) | |
355 (widget-insert " This\n") | |
356 (widget-create 'checkbox nil) | |
357 (widget-insert " That\n") | |
358 (widget-create 'checkbox | |
359 :notify (lambda (&rest ignore) (message "Tickle")) | |
360 t) | |
361 (widget-insert " Thus\n\nSelect one:\n\n") | |
362 (widget-create 'radio-button-choice | |
363 :value "One" | |
364 :notify (lambda (widget &rest ignore) | |
365 (message "You selected %s" | |
366 (widget-value widget))) | |
367 '(item "One") '(item "Another One.") '(item "A Final One.")) | |
368 (widget-insert "\n") | |
369 (widget-create 'push-button | |
370 :notify (lambda (&rest ignore) | |
371 (if (= (length (widget-value widget-example-repeat)) | |
372 3) | |
373 (message "Congratulation!") | |
374 (error "Three was the count!"))) | |
375 "Apply Form") | |
376 (widget-insert " ") | |
377 (widget-create 'push-button | |
378 :notify (lambda (&rest ignore) | |
379 (widget-example)) | |
380 "Reset Form") | |
381 (widget-insert "\n") | |
382 (use-local-map widget-keymap) | |
383 (widget-setup)) | |
384 @end lisp | |
385 | |
386 @node Setting Up the Buffer, Basic Types, Programming Example, Top | |
387 @comment node-name, next, previous, up | |
388 @section Setting Up the Buffer | |
389 | |
390 Widgets are created with @code{widget-create}, which returns a | |
391 @dfn{widget} object. This object can be queried and manipulated by | |
392 other widget functions, until it is deleted with @code{widget-delete}. | |
393 After the widgets have been created, @code{widget-setup} must be called | |
394 to enable them. | |
395 | |
396 @defun widget-create type [ keyword argument ]@dots{} | |
397 Create and return a widget of type @var{type}. | |
398 The syntax for the @var{type} argument is described in @ref{Basic Types}. | |
399 | |
400 The keyword arguments can be used to overwrite the keyword arguments | |
401 that are part of @var{type}. | |
402 @end defun | |
403 | |
404 @defun widget-delete widget | |
405 Delete @var{widget} and remove it from the buffer. | |
406 @end defun | |
407 | |
408 @defun widget-setup | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
409 Set up a buffer to support widgets. |
25829 | 410 |
411 This should be called after creating all the widgets and before allowing | |
412 the user to edit them. | |
413 @refill | |
414 @end defun | |
415 | |
416 If you want to insert text outside the widgets in the form, the | |
417 recommended way to do that is with @code{widget-insert}. | |
418 | |
419 @defun widget-insert | |
420 Insert the arguments, either strings or characters, at point. | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
421 The inserted text will be read-only. |
25829 | 422 @end defun |
423 | |
424 There is a standard widget keymap which you might find useful. | |
425 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
426 @findex widget-button-press |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
427 @findex widget-button-click |
25829 | 428 @defvr Const widget-keymap |
429 A keymap with the global keymap as its parent.@* | |
430 @key{TAB} and @kbd{C-@key{TAB}} are bound to @code{widget-forward} and | |
431 @code{widget-backward}, respectively. @kbd{@key{RET}} and @kbd{mouse-2} | |
432 are bound to @code{widget-button-press} and | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
433 @code{widget-button-click}.@refill |
25829 | 434 @end defvr |
435 | |
436 @defvar widget-global-map | |
437 Keymap used by @code{widget-button-press} and @code{widget-button-click} | |
438 when not on a button. By default this is @code{global-map}. | |
439 @end defvar | |
440 | |
441 @node Basic Types, Sexp Types, Setting Up the Buffer, Top | |
442 @comment node-name, next, previous, up | |
443 @section Basic Types | |
444 | |
445 The syntax of a type specification is given below: | |
446 | |
447 @example | |
448 NAME ::= (NAME [KEYWORD ARGUMENT]... ARGS) | |
449 | NAME | |
450 @end example | |
451 | |
452 Where, @var{name} is a widget name, @var{keyword} is the name of a | |
453 property, @var{argument} is the value of the property, and @var{args} | |
454 are interpreted in a widget specific way. | |
455 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
456 @cindex keyword arguments |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
457 The following keyword arguments that apply to all widgets: |
25829 | 458 |
459 @table @code | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
460 @vindex value@r{ keyword} |
25829 | 461 @item :value |
462 The initial value for widgets of this type. | |
463 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
464 @vindex format@r{ keyword} |
25829 | 465 @item :format |
466 This string will be inserted in the buffer when you create a widget. | |
467 The following @samp{%} escapes are available: | |
468 | |
469 @table @samp | |
470 @item %[ | |
471 @itemx %] | |
472 The text inside will be marked as a button. | |
473 | |
474 By default, the text will be shown in @code{widget-button-face}, and | |
475 surrounded by brackets. | |
476 | |
477 @defopt widget-button-prefix | |
478 String to prefix buttons. | |
479 @end defopt | |
480 | |
481 @defopt widget-button-suffix | |
482 String to suffix buttons. | |
483 @end defopt | |
484 | |
485 @item %@{ | |
486 @itemx %@} | |
487 The text inside will be displayed with the face specified by | |
488 @code{:sample-face}. | |
489 | |
490 @item %v | |
27214 | 491 This will be replaced with the buffer representation of the widget's |
25829 | 492 value. What this is depends on the widget type. |
493 | |
494 @item %d | |
495 Insert the string specified by @code{:doc} here. | |
496 | |
497 @item %h | |
498 Like @samp{%d}, with the following modifications: If the documentation | |
499 string is more than one line, it will add a button which will toggle | |
500 between showing only the first line, and showing the full text. | |
501 Furthermore, if there is no @code{:doc} property in the widget, it will | |
502 instead examine the @code{:documentation-property} property. If it is a | |
503 lambda expression, it will be called with the widget's value as an | |
504 argument, and the result will be used as the documentation text. | |
505 | |
506 @item %t | |
507 Insert the string specified by @code{:tag} here, or the @code{princ} | |
508 representation of the value if there is no tag. | |
509 | |
510 @item %% | |
511 Insert a literal @samp{%}. | |
512 @end table | |
513 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
514 @vindex button-face@r{ keyword} |
25829 | 515 @item :button-face |
516 Face used to highlight text inside %[ %] in the format. | |
517 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
518 @vindex button-prefix@r{ keyword} |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
519 @vindex button-suffix@r{ keyword} |
25829 | 520 @item :button-prefix |
521 @itemx :button-suffix | |
522 Text around %[ %] in the format. | |
523 | |
524 These can be | |
525 @table @emph | |
526 @item nil | |
527 No text is inserted. | |
528 | |
529 @item a string | |
530 The string is inserted literally. | |
531 | |
532 @item a symbol | |
533 The value of the symbol is expanded according to this table. | |
534 @end table | |
535 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
536 @vindex doc@r{ keyword} |
25829 | 537 @item :doc |
538 The string inserted by the @samp{%d} escape in the format | |
539 string. | |
540 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
541 @vindex tag@r{ keyword} |
25829 | 542 @item :tag |
543 The string inserted by the @samp{%t} escape in the format | |
544 string. | |
545 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
546 @vindex tag-glyph@r{ keyword} |
25829 | 547 @item :tag-glyph |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
548 Name of image to use instead of the string specified by @code{:tag} on |
25829 | 549 Emacsen that supports it. |
550 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
551 @vindex help-echo@r{ keyword} |
25829 | 552 @item :help-echo |
553 Message displayed whenever you move to the widget with either | |
554 @code{widget-forward} or @code{widget-backward}. | |
555 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
556 @vindex indent@r{ keyword} |
25829 | 557 @item :indent |
558 An integer indicating the absolute number of spaces to indent children | |
559 of this widget. | |
560 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
561 @vindex offset@r{ keyword} |
25829 | 562 @item :offset |
563 An integer indicating how many extra spaces to add to the widget's | |
564 grandchildren compared to this widget. | |
565 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
566 @vindex extra-offset@r{ keyword} |
25829 | 567 @item :extra-offset |
568 An integer indicating how many extra spaces to add to the widget's | |
569 children compared to this widget. | |
570 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
571 @vindex notify@r{ keyword} |
25829 | 572 @item :notify |
573 A function called each time the widget or a nested widget is changed. | |
574 The function is called with two or three arguments. The first argument | |
575 is the widget itself, the second argument is the widget that was | |
576 changed, and the third argument is the event leading to the change, if | |
577 any. | |
578 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
579 @vindex menu-tag@r{ keyword} |
25829 | 580 @item :menu-tag |
581 Tag used in the menu when the widget is used as an option in a | |
582 @code{menu-choice} widget. | |
583 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
584 @vindex menu-tag-get@r{ keyword} |
25829 | 585 @item :menu-tag-get |
586 Function used for finding the tag when the widget is used as an option | |
587 in a @code{menu-choice} widget. By default, the tag used will be either the | |
588 @code{:menu-tag} or @code{:tag} property if present, or the @code{princ} | |
589 representation of the @code{:value} property if not. | |
590 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
591 @vindex match@r{ keyword} |
25829 | 592 @item :match |
593 Should be a function called with two arguments, the widget and a value, | |
594 and returning non-nil if the widget can represent the specified value. | |
595 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
596 @vindex validate@r{ keyword} |
25829 | 597 @item :validate |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
598 A function which takes a widget as an argument, and returns @code{nil} |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
599 if the widget's current value is valid for the widget. Otherwise it |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
600 should return the widget containing the invalid data, and set that |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
601 widget's @code{:error} property to a string explaining the error. |
25829 | 602 |
603 The following predefined function can be used: | |
604 | |
605 @defun widget-children-validate widget | |
606 All the @code{:children} of @var{widget} must be valid. | |
607 @end defun | |
608 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
609 @vindex tab-order@r{ keyword} |
25829 | 610 @item :tab-order |
611 Specify the order in which widgets are traversed with | |
612 @code{widget-forward} or @code{widget-backward}. This is only partially | |
613 implemented. | |
614 | |
615 @enumerate a | |
616 @item | |
617 Widgets with tabbing order @code{-1} are ignored. | |
618 | |
619 @item | |
620 (Unimplemented) When on a widget with tabbing order @var{n}, go to the | |
621 next widget in the buffer with tabbing order @var{n+1} or @code{nil}, | |
622 whichever comes first. | |
623 | |
624 @item | |
625 When on a widget with no tabbing order specified, go to the next widget | |
626 in the buffer with a positive tabbing order, or @code{nil} | |
627 @end enumerate | |
628 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
629 @vindex parent@r{ keyword} |
25829 | 630 @item :parent |
631 The parent of a nested widget (e.g. a @code{menu-choice} item or an | |
632 element of a @code{editable-list} widget). | |
633 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
634 @vindex sibling-args@r{ keyword} |
25829 | 635 @item :sibling-args |
636 This keyword is only used for members of a @code{radio-button-choice} or | |
637 @code{checklist}. The value should be a list of extra keyword | |
638 arguments, which will be used when creating the @code{radio-button} or | |
639 @code{checkbox} associated with this item. | |
640 | |
641 @end table | |
642 | |
643 @deffn {User Option} widget-glyph-directory | |
644 Directory where glyphs are found. | |
645 Widget will look here for a file with the same name as specified for the | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
646 image, with either a @file{.xpm} (if supported) or @file{.xbm} extension. |
25829 | 647 @end deffn |
648 | |
649 @deffn{User Option} widget-glyph-enable | |
650 If non-nil, allow glyphs to appear on displays where they are supported. | |
651 @end deffn | |
652 | |
653 | |
654 @menu | |
655 * link:: | |
656 * url-link:: | |
657 * info-link:: | |
658 * push-button:: | |
659 * editable-field:: | |
660 * text:: | |
661 * menu-choice:: | |
662 * radio-button-choice:: | |
663 * item:: | |
664 * choice-item:: | |
665 * toggle:: | |
666 * checkbox:: | |
667 * checklist:: | |
668 * editable-list:: | |
669 * group:: | |
670 @end menu | |
671 | |
672 @node link, url-link, Basic Types, Basic Types | |
673 @comment node-name, next, previous, up | |
674 @subsection The @code{link} Widget | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
675 @findex link@r{ widget} |
25829 | 676 |
677 Syntax: | |
678 | |
679 @example | |
680 TYPE ::= (link [KEYWORD ARGUMENT]... [ VALUE ]) | |
681 @end example | |
682 | |
683 The @var{value}, if present, is used to initialize the @code{:value} | |
684 property. The value should be a string, which will be inserted in the | |
685 buffer. | |
686 | |
687 By default the link will be shown in brackets. | |
688 | |
689 @defopt widget-link-prefix | |
690 String to prefix links. | |
691 @end defopt | |
692 | |
693 @defopt widget-link-suffix | |
694 String to suffix links. | |
695 @end defopt | |
696 | |
697 @node url-link, info-link, link, Basic Types | |
698 @comment node-name, next, previous, up | |
699 @subsection The @code{url-link} Widget | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
700 @findex url-link@r{ widget} |
25829 | 701 |
702 Syntax: | |
703 | |
704 @example | |
705 TYPE ::= (url-link [KEYWORD ARGUMENT]... URL) | |
706 @end example | |
707 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
708 @findex browse-url-browser-function@r{, and @code{url-link} widget} |
25829 | 709 When this link is invoked, the @sc{www} browser specified by |
710 @code{browse-url-browser-function} will be called with @var{url}. | |
711 | |
712 @node info-link, push-button, url-link, Basic Types | |
713 @comment node-name, next, previous, up | |
714 @subsection The @code{info-link} Widget | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
715 @findex info-link@r{ widget} |
25829 | 716 |
717 Syntax: | |
718 | |
719 @example | |
720 TYPE ::= (info-link [KEYWORD ARGUMENT]... ADDRESS) | |
721 @end example | |
722 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
723 When this link is invoked, the built-in Info reader is started on |
25829 | 724 @var{address}. |
725 | |
726 @node push-button, editable-field, info-link, Basic Types | |
727 @comment node-name, next, previous, up | |
728 @subsection The @code{push-button} Widget | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
729 @findex push-button@r{ widget} |
25829 | 730 |
731 Syntax: | |
732 | |
733 @example | |
734 TYPE ::= (push-button [KEYWORD ARGUMENT]... [ VALUE ]) | |
735 @end example | |
736 | |
737 The @var{value}, if present, is used to initialize the @code{:value} | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
738 property. The value should be a string, which will be inserted in the |
25829 | 739 buffer. |
740 | |
741 By default the tag will be shown in brackets. | |
742 | |
743 @defopt widget-push-button-prefix | |
744 String to prefix push buttons. | |
745 @end defopt | |
746 | |
747 @defopt widget-push-button-suffix | |
748 String to suffix push buttons. | |
749 @end defopt | |
750 | |
751 @node editable-field, text, push-button, Basic Types | |
752 @comment node-name, next, previous, up | |
753 @subsection The @code{editable-field} Widget | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
754 @findex editable-field@r{ widget} |
25829 | 755 |
756 Syntax: | |
757 | |
758 @example | |
759 TYPE ::= (editable-field [KEYWORD ARGUMENT]... [ VALUE ]) | |
760 @end example | |
761 | |
762 The @var{value}, if present, is used to initialize the @code{:value} | |
763 property. The value should be a string, which will be inserted in | |
764 field. This widget will match all string values. | |
765 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
766 The following extra properties are recognized: |
25829 | 767 |
768 @table @code | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
769 @vindex size@r{ keyword} |
25829 | 770 @item :size |
771 The width of the editable field.@* | |
772 By default the field will reach to the end of the line. | |
773 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
774 @vindex value-face@r{ keyword} |
25829 | 775 @item :value-face |
776 Face used for highlighting the editable field. Default is | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
777 @code{widget-field-face}, see @ref{User Interface}. |
25829 | 778 |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
779 @vindex secret@r{ keyword} |
25829 | 780 @item :secret |
781 Character used to display the value. You can set this to e.g. @code{?*} | |
782 if the field contains a password or other secret information. By | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
783 default, this is nil, and the value is not secret. |
25829 | 784 |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
785 @vindex valid-regexp@r{ keyword} |
25829 | 786 @item :valid-regexp |
787 By default the @code{:validate} function will match the content of the | |
788 field with the value of this attribute. The default value is @code{""} | |
789 which matches everything. | |
790 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
791 @vindex keymap@r{ keyword} |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
792 @vindex widget-field-keymap |
25829 | 793 @item :keymap |
794 Keymap used in the editable field. The default value is | |
795 @code{widget-field-keymap}, which allows you to use all the normal | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
796 editing commands, even if the buffer's major mode suppresses some of |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
797 them. Pressing @key{RET} invokes the function specified by |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
798 @code{:action}. |
25829 | 799 @end table |
800 | |
801 @node text, menu-choice, editable-field, Basic Types | |
802 @comment node-name, next, previous, up | |
803 @subsection The @code{text} Widget | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
804 @findex text@r{ widget} |
25829 | 805 |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
806 @vindex widget-text-keymap |
25829 | 807 This is just like @code{editable-field}, but intended for multiline text |
808 fields. The default @code{:keymap} is @code{widget-text-keymap}, which | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
809 does not rebind the @key{RET} key. |
25829 | 810 |
811 @node menu-choice, radio-button-choice, text, Basic Types | |
812 @comment node-name, next, previous, up | |
813 @subsection The @code{menu-choice} Widget | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
814 @findex menu-choice@r{ widget} |
25829 | 815 |
816 Syntax: | |
817 | |
818 @example | |
819 TYPE ::= (menu-choice [KEYWORD ARGUMENT]... TYPE ... ) | |
820 @end example | |
821 | |
27214 | 822 The @var{type} argument represents each possible choice. The widget's |
823 value will be that of the chosen @var{type} argument. This widget will | |
824 match any value matching at least one of the specified @var{type} | |
825 arguments. | |
25829 | 826 |
827 @table @code | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
828 @vindex void@r{ keyword} |
25829 | 829 @item :void |
830 Widget type used as a fallback when the value does not match any of the | |
831 specified @var{type} arguments. | |
832 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
833 @vindex case-fold@r{ keyword} |
25829 | 834 @item :case-fold |
835 Set this to nil if you don't want to ignore case when prompting for a | |
836 choice through the minibuffer. | |
837 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
838 @vindex children@r{ keyword} |
25829 | 839 @item :children |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
840 A list whose @code{car} is the widget representing the currently chosen |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
841 type in the buffer. |
25829 | 842 |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
843 @vindex choice@r{ keyword} |
25829 | 844 @item :choice |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
845 The current chosen type. |
25829 | 846 |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
847 @vindex args@r{ keyword} |
25829 | 848 @item :args |
849 The list of types. | |
850 @end table | |
851 | |
852 @node radio-button-choice, item, menu-choice, Basic Types | |
853 @comment node-name, next, previous, up | |
854 @subsection The @code{radio-button-choice} Widget | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
855 @findex radio-button-choice@r{ widget} |
25829 | 856 |
857 Syntax: | |
858 | |
859 @example | |
860 TYPE ::= (radio-button-choice [KEYWORD ARGUMENT]... TYPE ... ) | |
861 @end example | |
862 | |
27214 | 863 The @var{type} argument represents each possible choice. The widget's |
864 value will be that of the chosen @var{type} argument. This widget will | |
865 match any value matching at least one of the specified @var{type} | |
866 arguments. | |
25829 | 867 |
868 The following extra properties are recognized. | |
869 | |
870 @table @code | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
871 @vindex entry-format@r{ keyword} |
25829 | 872 @item :entry-format |
873 This string will be inserted for each entry in the list. | |
874 The following @samp{%} escapes are available: | |
875 @table @samp | |
876 @item %v | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
877 Replace with the buffer representation of the @var{type} widget. |
25829 | 878 @item %b |
879 Replace with the radio button. | |
880 @item %% | |
881 Insert a literal @samp{%}. | |
882 @end table | |
883 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
884 @vindex button-args@r{ keyword} |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
885 @item :button-args |
25829 | 886 A list of keywords to pass to the radio buttons. Useful for setting |
887 e.g. the @samp{:help-echo} for each button. | |
888 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
889 @vindex buttons@r{ keyword} |
25829 | 890 @item :buttons |
891 The widgets representing the radio buttons. | |
892 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
893 @vindex children@r{ keyword} |
25829 | 894 @item :children |
895 The widgets representing each type. | |
896 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
897 @vindex choice@r{ keyword} |
25829 | 898 @item :choice |
899 The current chosen type | |
900 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
901 @vindex args@r{ keyword} |
25829 | 902 @item :args |
903 The list of types. | |
904 @end table | |
905 | |
906 You can add extra radio button items to a @code{radio-button-choice} | |
907 widget after it has been created with the function | |
908 @code{widget-radio-add-item}. | |
909 | |
910 @defun widget-radio-add-item widget type | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
911 Add to @code{radio-button-choice} widget @var{widget} a new radio button |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
912 item of type @var{type}. |
25829 | 913 @end defun |
914 | |
915 Please note that such items added after the @code{radio-button-choice} | |
916 widget has been created will @strong{not} be properly destructed when | |
917 you call @code{widget-delete}. | |
918 | |
919 @node item, choice-item, radio-button-choice, Basic Types | |
920 @comment node-name, next, previous, up | |
921 @subsection The @code{item} Widget | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
922 @findex item@r{ widget} |
25829 | 923 |
924 Syntax: | |
925 | |
926 @example | |
927 ITEM ::= (item [KEYWORD ARGUMENT]... VALUE) | |
928 @end example | |
929 | |
930 The @var{value}, if present, is used to initialize the @code{:value} | |
931 property. The value should be a string, which will be inserted in the | |
932 buffer. This widget will only match the specified value. | |
933 | |
934 @node choice-item, toggle, item, Basic Types | |
935 @comment node-name, next, previous, up | |
936 @subsection The @code{choice-item} Widget | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
937 @findex choice-item@r{ widget} |
25829 | 938 |
939 Syntax: | |
940 | |
941 @example | |
942 ITEM ::= (choice-item [KEYWORD ARGUMENT]... VALUE) | |
943 @end example | |
944 | |
945 The @var{value}, if present, is used to initialize the @code{:value} | |
946 property. The value should be a string, which will be inserted in the | |
947 buffer as a button. Activating the button of a @code{choice-item} is | |
948 equivalent to activating the parent widget. This widget will only match | |
949 the specified value. | |
950 | |
951 @node toggle, checkbox, choice-item, Basic Types | |
952 @comment node-name, next, previous, up | |
953 @subsection The @code{toggle} Widget | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
954 @findex toggle@r{ widget} |
25829 | 955 |
956 Syntax: | |
957 | |
958 @example | |
959 TYPE ::= (toggle [KEYWORD ARGUMENT]...) | |
960 @end example | |
961 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
962 The widget has two possible states, @samp{on} and @samp{off}, which |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
963 correspond to a @code{t} or @code{nil} value, respectively. |
25829 | 964 |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
965 The following extra properties are recognized: |
25829 | 966 |
967 @table @code | |
968 @item :on | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
969 A string representing the @samp{on} state. By default the string |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
970 @samp{on}. |
25829 | 971 @item :off |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
972 A string representing the @samp{off} state. By default the string |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
973 @samp{off}. |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
974 @vindex on-glyph@r{ keyword} |
25829 | 975 @item :on-glyph |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
976 Name of a glyph to be used instead of the @samp{:on} text string, on |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
977 emacsen that supports this. |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
978 @vindex off-glyph@r{ keyword} |
25829 | 979 @item :off-glyph |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
980 Name of a glyph to be used instead of the @samp{:off} text string, on |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
981 emacsen that supports this. |
25829 | 982 @end table |
983 | |
984 @node checkbox, checklist, toggle, Basic Types | |
985 @comment node-name, next, previous, up | |
986 @subsection The @code{checkbox} Widget | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
987 @findex checkbox@r{ widget} |
25829 | 988 |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
989 This widget has two possible states, @samp{selected} and |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
990 @samp{unselected}, which corresponds to a @code{t} or @code{nil} value. |
25829 | 991 |
992 Syntax: | |
993 | |
994 @example | |
995 TYPE ::= (checkbox [KEYWORD ARGUMENT]...) | |
996 @end example | |
997 | |
998 @node checklist, editable-list, checkbox, Basic Types | |
999 @comment node-name, next, previous, up | |
1000 @subsection The @code{checklist} Widget | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1001 @findex checklist@r{ widget} |
25829 | 1002 |
1003 Syntax: | |
1004 | |
1005 @example | |
1006 TYPE ::= (checklist [KEYWORD ARGUMENT]... TYPE ... ) | |
1007 @end example | |
1008 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1009 The @var{type} arguments represent each checklist item. The widget's |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1010 value will be a list containing the values of all checked @var{type} |
27214 | 1011 arguments. The checklist widget will match a list whose elements all |
1012 match at least one of the specified @var{type} arguments. | |
25829 | 1013 |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1014 The following extra properties are recognized: |
25829 | 1015 |
1016 @table @code | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1017 @vindex entry-format@r{ keyword} |
25829 | 1018 @item :entry-format |
1019 This string will be inserted for each entry in the list. | |
1020 The following @samp{%} escapes are available: | |
1021 @table @samp | |
1022 @item %v | |
1023 Replaced with the buffer representation of the @var{type} widget. | |
1024 @item %b | |
1025 Replace with the checkbox. | |
1026 @item %% | |
1027 Insert a literal @samp{%}. | |
1028 @end table | |
1029 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1030 @vindex greedy@r{ keyword} |
25829 | 1031 @item :greedy |
27214 | 1032 Usually a checklist will only match if the items are in the exact |
25829 | 1033 sequence given in the specification. By setting @code{:greedy} to |
1034 non-nil, it will allow the items to come in any sequence. However, if | |
1035 you extract the value they will be in the sequence given in the | |
27214 | 1036 checklist. I.e. the original sequence is forgotten. |
25829 | 1037 |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1038 @vindex button-args@r{ keyword} |
25829 | 1039 @item button-args |
1040 A list of keywords to pass to the checkboxes. Useful for setting | |
1041 e.g. the @samp{:help-echo} for each checkbox. | |
1042 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1043 @vindex buttons@r{ keyword} |
25829 | 1044 @item :buttons |
1045 The widgets representing the checkboxes. | |
1046 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1047 @vindex children@r{ keyword} |
25829 | 1048 @item :children |
1049 The widgets representing each type. | |
1050 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1051 @vindex args@r{ keyword} |
25829 | 1052 @item :args |
1053 The list of types. | |
1054 @end table | |
1055 | |
1056 @node editable-list, group, checklist, Basic Types | |
1057 @comment node-name, next, previous, up | |
1058 @subsection The @code{editable-list} Widget | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1059 @findex editable-list@r{ widget} |
25829 | 1060 |
1061 Syntax: | |
1062 | |
1063 @example | |
1064 TYPE ::= (editable-list [KEYWORD ARGUMENT]... TYPE) | |
1065 @end example | |
1066 | |
1067 The value is a list, where each member represents one widget of type | |
1068 @var{type}. | |
1069 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1070 The following extra properties are recognized: |
25829 | 1071 |
1072 @table @code | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1073 @vindex entry-format@r{ keyword} |
25829 | 1074 @item :entry-format |
1075 This string will be inserted for each entry in the list. | |
1076 The following @samp{%} escapes are available: | |
1077 @table @samp | |
1078 @item %v | |
1079 This will be replaced with the buffer representation of the @var{type} | |
1080 widget. | |
1081 @item %i | |
1082 Insert the @b{[INS]} button. | |
1083 @item %d | |
1084 Insert the @b{[DEL]} button. | |
1085 @item %% | |
1086 Insert a literal @samp{%}. | |
1087 @end table | |
1088 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1089 @vindex insert-button-args@r{ keyword} |
25829 | 1090 @item :insert-button-args |
1091 A list of keyword arguments to pass to the insert buttons. | |
1092 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1093 @vindex delete-button-args@r{ keyword} |
25829 | 1094 @item :delete-button-args |
1095 A list of keyword arguments to pass to the delete buttons. | |
1096 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1097 @vindex append-button-args@r{ keyword} |
25829 | 1098 @item :append-button-args |
1099 A list of keyword arguments to pass to the trailing insert button. | |
1100 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1101 @vindex buttons@r{ keyword} |
25829 | 1102 @item :buttons |
1103 The widgets representing the insert and delete buttons. | |
1104 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1105 @vindex children@r{ keyword} |
25829 | 1106 @item :children |
1107 The widgets representing the elements of the list. | |
1108 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1109 @vindex args@r{ keyword} |
25829 | 1110 @item :args |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1111 List whose @code{car} is the type of the list elements. |
25829 | 1112 @end table |
1113 | |
1114 @node group, , editable-list, Basic Types | |
1115 @comment node-name, next, previous, up | |
1116 @subsection The @code{group} Widget | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1117 @findex group@r{ widget} |
25829 | 1118 |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1119 This widget simply group other widgets together. |
25829 | 1120 |
1121 Syntax: | |
1122 | |
1123 @example | |
1124 TYPE ::= (group [KEYWORD ARGUMENT]... TYPE...) | |
1125 @end example | |
1126 | |
1127 The value is a list, with one member for each @var{type}. | |
1128 | |
1129 @node Sexp Types, Widget Properties, Basic Types, Top | |
1130 @comment | |
1131 @section Sexp Types | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1132 @cindex sexp types |
25829 | 1133 |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1134 A number of widgets for editing @dfn{s-expressions} (lisp types), sexp |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1135 for short, are also available. These basically fall in several |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1136 categories described in this section. |
25829 | 1137 |
1138 @menu | |
1139 * constants:: | |
1140 * generic:: | |
1141 * atoms:: | |
1142 * composite:: | |
1143 @end menu | |
1144 | |
1145 @node constants, generic, Sexp Types, Sexp Types | |
1146 @comment node-name, next, previous, up | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1147 @subsection The Constant Widgets |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1148 @cindex constant widgets |
25829 | 1149 |
1150 The @code{const} widget can contain any lisp expression, but the user is | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1151 prohibited from editing it, which is mainly useful as a component of one |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1152 of the composite widgets. |
25829 | 1153 |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1154 The syntax for the @code{const} widget is: |
25829 | 1155 |
1156 @example | |
1157 TYPE ::= (const [KEYWORD ARGUMENT]... [ VALUE ]) | |
1158 @end example | |
1159 | |
1160 The @var{value}, if present, is used to initialize the @code{:value} | |
1161 property and can be any s-expression. | |
1162 | |
1163 @deffn Widget const | |
1164 This will display any valid s-expression in an immutable part of the | |
1165 buffer. | |
1166 @end deffn | |
1167 | |
1168 There are two variations of the @code{const} widget, namely | |
1169 @code{variable-item} and @code{function-item}. These should contain a | |
1170 symbol with a variable or function binding. The major difference from | |
1171 the @code{const} widget is that they will allow the user to see the | |
1172 variable or function documentation for the symbol. | |
1173 | |
1174 @deffn Widget variable-item | |
1175 An immutable symbol that is bound as a variable. | |
1176 @end deffn | |
1177 | |
1178 @deffn Widget function-item | |
1179 An immutable symbol that is bound as a function. | |
1180 @end deffn | |
1181 | |
1182 @node generic, atoms, constants, Sexp Types | |
1183 @comment node-name, next, previous, up | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1184 @subsection Generic Sexp Widget |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1185 @cindex generic sexp widget |
25829 | 1186 |
1187 The @code{sexp} widget can contain any lisp expression, and allows the | |
1188 user to edit it inline in the buffer. | |
1189 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1190 The syntax for the @code{sexp} widget is: |
25829 | 1191 |
1192 @example | |
1193 TYPE ::= (sexp [KEYWORD ARGUMENT]... [ VALUE ]) | |
1194 @end example | |
1195 | |
1196 @deffn Widget sexp | |
1197 This will allow you to edit any valid s-expression in an editable buffer | |
1198 field. | |
1199 | |
1200 The @code{sexp} widget takes the same keyword arguments as the | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1201 @code{editable-field} widget. @xref{editable-field}. |
25829 | 1202 @end deffn |
1203 | |
1204 @node atoms, composite, generic, Sexp Types | |
1205 @comment node-name, next, previous, up | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1206 @subsection Atomic Sexp Widgets |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1207 @cindex atomic sexp widget |
25829 | 1208 |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1209 The atoms are s-expressions that do not consist of other s-expressions. |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1210 For example, a string, a file name, or a symbol are atoms, while a list |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1211 is a composite type. You can edit the value of an atom with the |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1212 following widgets. |
25829 | 1213 |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1214 The syntax for all the atoms are: |
25829 | 1215 |
1216 @example | |
1217 TYPE ::= (NAME [KEYWORD ARGUMENT]... [ VALUE ]) | |
1218 @end example | |
1219 | |
1220 The @var{value}, if present, is used to initialize the @code{:value} | |
1221 property and must be an expression of the same type as the widget. | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1222 That is, the string widget can only be initialized with a string. |
25829 | 1223 |
1224 All the atom widgets take the same keyword arguments as the | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1225 @code{editable-field} widget. @xref{editable-field}. |
25829 | 1226 |
1227 @deffn Widget string | |
1228 Allows you to edit a string in an editable field. | |
1229 @end deffn | |
1230 | |
1231 @deffn Widget regexp | |
1232 Allows you to edit a regular expression in an editable field. | |
1233 @end deffn | |
1234 | |
1235 @deffn Widget character | |
1236 Allows you to enter a character in an editable field. | |
1237 @end deffn | |
1238 | |
1239 @deffn Widget file | |
1240 Allows you to edit a file name in an editable field. If you invoke | |
1241 the tag button, you can edit the file name in the mini-buffer with | |
1242 completion. | |
1243 | |
1244 Keywords: | |
1245 @table @code | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1246 @vindex must-match@r{ keyword} |
25829 | 1247 @item :must-match |
1248 If this is set to non-nil, only existing file names will be allowed in | |
1249 the minibuffer. | |
1250 @end table | |
1251 @end deffn | |
1252 | |
1253 @deffn Widget directory | |
1254 Allows you to edit a directory name in an editable field. | |
1255 Similar to the @code{file} widget. | |
1256 @end deffn | |
1257 | |
1258 @deffn Widget symbol | |
1259 Allows you to edit a lisp symbol in an editable field. | |
1260 @end deffn | |
1261 | |
1262 @deffn Widget function | |
1263 Allows you to edit a lambda expression, or a function name with completion. | |
1264 @end deffn | |
1265 | |
1266 @deffn Widget variable | |
1267 Allows you to edit a variable name, with completion. | |
1268 @end deffn | |
1269 | |
1270 @deffn Widget integer | |
1271 Allows you to edit an integer in an editable field. | |
1272 @end deffn | |
1273 | |
1274 @deffn Widget number | |
1275 Allows you to edit a number in an editable field. | |
1276 @end deffn | |
1277 | |
1278 @deffn Widget boolean | |
1279 Allows you to edit a boolean. In lisp this means a variable which is | |
1280 either nil meaning false, or non-nil meaning true. | |
1281 @end deffn | |
1282 | |
1283 | |
1284 @node composite, , atoms, Sexp Types | |
1285 @comment node-name, next, previous, up | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1286 @subsection Composite Sexp Widgets |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1287 @cindex composite sexp widgets |
25829 | 1288 |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1289 The syntax for the composite widget is: |
25829 | 1290 |
1291 @example | |
1292 TYPE ::= (NAME [KEYWORD ARGUMENT]... COMPONENT...) | |
1293 @end example | |
1294 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1295 @noindent |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1296 where each @var{component} must be a widget type. Each component widget |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1297 will be displayed in the buffer, and will be editable by the user. |
25829 | 1298 |
1299 @deffn Widget cons | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1300 The value of a @code{cons} widget is a cons-cell where the @code{car} is |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1301 the value of the first component and the @code{cdr} is the value of the |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1302 second component. There must be exactly two components. |
25829 | 1303 @end deffn |
1304 | |
1305 @deffn Widget list | |
1306 The value of a @code{list} widget is a list containing the value of | |
1307 each of its component. | |
1308 @end deffn | |
1309 | |
1310 @deffn Widget vector | |
1311 The value of a @code{vector} widget is a vector containing the value of | |
1312 each of its component. | |
1313 @end deffn | |
1314 | |
1315 The above suffice for specifying fixed size lists and vectors. To get | |
1316 variable length lists and vectors, you can use a @code{choice}, | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1317 @code{set}, or @code{repeat} widgets together with the @code{:inline} |
25829 | 1318 keywords. If any component of a composite widget has the @code{:inline} |
1319 keyword set, its value must be a list which will then be spliced into | |
1320 the composite. For example, to specify a list whose first element must | |
1321 be a file name, and whose remaining arguments should either by the | |
1322 symbol @code{t} or two files, you can use the following widget | |
1323 specification: | |
1324 | |
1325 @example | |
1326 (list file | |
1327 (choice (const t) | |
1328 (list :inline t | |
1329 :value ("foo" "bar") | |
1330 string string))) | |
1331 @end example | |
1332 | |
1333 The value of a widget of this type will either have the form | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1334 @code{(file t)} or @code{(file string string)}. |
25829 | 1335 |
1336 This concept of inline is probably hard to understand. It was certainly | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1337 hard to implement, so instead of confusing you more by trying to explain |
27214 | 1338 it here, I'll just suggest you meditate over it for a while. |
25829 | 1339 |
1340 @deffn Widget choice | |
27214 | 1341 Allows you to edit a sexp which may have one of a fixed set of types. |
1342 It is currently implemented with the @code{choice-menu} basic widget, | |
1343 and has a similar syntax. | |
25829 | 1344 @end deffn |
1345 | |
1346 @deffn Widget set | |
1347 Allows you to specify a type which must be a list whose elements all | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1348 belong to given set. The elements of the list are not significant. |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1349 This is implemented on top of the @code{checklist} basic widget, and has |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1350 a similar syntax. |
25829 | 1351 @end deffn |
1352 | |
1353 @deffn Widget repeat | |
1354 Allows you to specify a variable length list whose members are all of | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1355 the same type. Implemented on top of the @code{editable-list} basic |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1356 widget, and has a similar syntax. |
25829 | 1357 @end deffn |
1358 | |
1359 @node Widget Properties, Defining New Widgets, Sexp Types, Top | |
1360 @comment node-name, next, previous, up | |
1361 @section Properties | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1362 @cindex properties of widgets |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1363 @cindex widget properties |
25829 | 1364 |
1365 You can examine or set the value of a widget by using the widget object | |
1366 that was returned by @code{widget-create}. | |
1367 | |
1368 @defun widget-value widget | |
1369 Return the current value contained in @var{widget}. | |
1370 It is an error to call this function on an uninitialized widget. | |
1371 @end defun | |
1372 | |
1373 @defun widget-value-set widget value | |
1374 Set the value contained in @var{widget} to @var{value}. | |
1375 It is an error to call this function with an invalid @var{value}. | |
1376 @end defun | |
1377 | |
1378 @strong{Important:} You @emph{must} call @code{widget-setup} after | |
1379 modifying the value of a widget before the user is allowed to edit the | |
1380 widget again. It is enough to call @code{widget-setup} once if you | |
1381 modify multiple widgets. This is currently only necessary if the widget | |
1382 contains an editing field, but may be necessary for other widgets in the | |
1383 future. | |
1384 | |
1385 If your application needs to associate some information with the widget | |
1386 objects, for example a reference to the item being edited, it can be | |
1387 done with @code{widget-put} and @code{widget-get}. The property names | |
1388 must begin with a @samp{:}. | |
1389 | |
1390 @defun widget-put widget property value | |
1391 In @var{widget} set @var{property} to @var{value}. | |
1392 @var{property} should be a symbol, while @var{value} can be anything. | |
1393 @end defun | |
1394 | |
1395 @defun widget-get widget property | |
1396 In @var{widget} return the value for @var{property}. | |
1397 @var{property} should be a symbol, the value is what was last set by | |
1398 @code{widget-put} for @var{property}. | |
1399 @end defun | |
1400 | |
1401 @defun widget-member widget property | |
1402 Non-nil if @var{widget} has a value (even nil) for property @var{property}. | |
1403 @end defun | |
1404 | |
1405 Occasionally it can be useful to know which kind of widget you have, | |
1406 i.e. the name of the widget type you gave when the widget was created. | |
1407 | |
1408 @defun widget-type widget | |
1409 Return the name of @var{widget}, a symbol. | |
1410 @end defun | |
1411 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1412 @cindex active widget |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1413 @cindex inactive widget |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1414 @cindex activate a widget |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1415 @cindex deactivate a widget |
25829 | 1416 Widgets can be in two states: active, which means they are modifiable by |
1417 the user, or inactive, which means they cannot be modified by the user. | |
1418 You can query or set the state with the following code: | |
1419 | |
1420 @lisp | |
1421 ;; Examine if @var{widget} is active or not. | |
1422 (if (widget-apply @var{widget} :active) | |
1423 (message "Widget is active.") | |
1424 (message "Widget is inactive.") | |
1425 | |
1426 ;; Make @var{widget} inactive. | |
1427 (widget-apply @var{widget} :deactivate) | |
1428 | |
1429 ;; Make @var{widget} active. | |
1430 (widget-apply @var{widget} :activate) | |
1431 @end lisp | |
1432 | |
27214 | 1433 A widget is inactive if it, or any of its ancestors (found by |
1434 following the @code{:parent} link), have been deactivated. To make sure | |
1435 a widget is really active, you must therefore activate both it and | |
25829 | 1436 all its ancestors. |
1437 | |
1438 @lisp | |
1439 (while widget | |
1440 (widget-apply widget :activate) | |
1441 (setq widget (widget-get widget :parent))) | |
1442 @end lisp | |
1443 | |
1444 You can check if a widget has been made inactive by examining the value | |
27214 | 1445 of the @code{:inactive} keyword. If this is non-nil, the widget itself |
1446 has been deactivated. This is different from using the @code{:active} | |
1447 keyword, in that the latter tells you if the widget @strong{or} any of | |
1448 its ancestors have been deactivated. Do not attempt to set the | |
25829 | 1449 @code{:inactive} keyword directly. Use the @code{:activate} |
27214 | 1450 @code{:deactivate} keywords instead. |
25829 | 1451 |
1452 | |
1453 @node Defining New Widgets, Widget Browser, Widget Properties, Top | |
1454 @comment node-name, next, previous, up | |
1455 @section Defining New Widgets | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1456 @cindex new widgets |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1457 @cindex defining new widgets |
25829 | 1458 |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1459 You can define specialized widgets with @code{widget-define}. It allows |
25829 | 1460 you to create a shorthand for more complex widgets, including specifying |
27214 | 1461 component widgets and new default values for the keyword |
25829 | 1462 arguments. |
1463 | |
1464 @defun widget-define name class doc &rest args | |
1465 Define a new widget type named @var{name} from @code{class}. | |
1466 | |
1467 @var{name} and class should both be symbols, @code{class} should be one | |
1468 of the existing widget types. | |
1469 | |
1470 The third argument @var{DOC} is a documentation string for the widget. | |
1471 | |
1472 After the new widget has been defined, the following two calls will | |
1473 create identical widgets: | |
1474 | |
1475 @itemize @bullet | |
1476 @item | |
1477 @lisp | |
1478 (widget-create @var{name}) | |
1479 @end lisp | |
1480 | |
1481 @item | |
1482 @lisp | |
1483 (apply widget-create @var{class} @var{args}) | |
1484 @end lisp | |
1485 @end itemize | |
1486 | |
1487 @end defun | |
1488 | |
27214 | 1489 Using @code{widget-define} just stores the definition of the widget type |
1490 in the @code{widget-type} property of @var{name}, which is what | |
25829 | 1491 @code{widget-create} uses. |
1492 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1493 If you only want to specify defaults for keywords with no complex |
25829 | 1494 conversions, you can use @code{identity} as your conversion function. |
1495 | |
1496 The following additional keyword arguments are useful when defining new | |
1497 widgets: | |
1498 @table @code | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1499 @vindex convert-widget@r{ keyword} |
25829 | 1500 @item :convert-widget |
1501 Function to convert a widget type before creating a widget of that | |
1502 type. It takes a widget type as an argument, and returns the converted | |
1503 widget type. When a widget is created, this function is called for the | |
27214 | 1504 widget type and all the widget's parent types, most derived first. |
25829 | 1505 |
1506 The following predefined functions can be used here: | |
1507 | |
1508 @defun widget-types-convert-widget widget | |
1509 Convert @code{:args} as widget types in @var{widget}. | |
1510 @end defun | |
1511 | |
1512 @defun widget-value-convert-widget widget | |
1513 Initialize @code{:value} from @code{:args} in @var{widget}. | |
1514 @end defun | |
1515 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1516 @vindex value-to-internal@r{ keyword} |
25829 | 1517 @item :value-to-internal |
1518 Function to convert the value to the internal format. The function | |
1519 takes two arguments, a widget and an external value, and returns the | |
1520 internal value. The function is called on the present @code{:value} | |
1521 when the widget is created, and on any value set later with | |
1522 @code{widget-value-set}. | |
1523 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1524 @vindex value-to-external@r{ keyword} |
25829 | 1525 @item :value-to-external |
1526 Function to convert the value to the external format. The function | |
1527 takes two arguments, a widget and an internal value, and returns the | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1528 external value. The function is called on the present @code{:value} |
25829 | 1529 when the widget is created, and on any value set later with |
1530 @code{widget-value-set}. | |
1531 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1532 @vindex create@r{ keyword} |
25829 | 1533 @item :create |
1534 Function to create a widget from scratch. The function takes one | |
27214 | 1535 argument, a widget type, and creates a widget of that type, inserts it |
1536 in the buffer, and returns a widget object. | |
25829 | 1537 |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1538 @vindex delete@r{ keyword} |
25829 | 1539 @item :delete |
1540 Function to delete a widget. The function takes one argument, a widget, | |
1541 and should remove all traces of the widget from the buffer. | |
1542 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1543 @vindex value-create@r{ keyword} |
25829 | 1544 @item :value-create |
1545 Function to expand the @samp{%v} escape in the format string. It will | |
27214 | 1546 be called with the widget as its argument and should insert a |
1547 representation of the widget's value in the buffer. | |
25829 | 1548 |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1549 @vindex value-delete@r{ keyword} |
25829 | 1550 @item :value-delete |
27214 | 1551 Should remove the representation of the widget's value from the buffer. |
25829 | 1552 It will be called with the widget as its argument. It doesn't have to |
1553 remove the text, but it should release markers and delete nested widgets | |
27214 | 1554 if such have been used. |
25829 | 1555 |
1556 The following predefined function can be used here: | |
1557 | |
1558 @defun widget-children-value-delete widget | |
1559 Delete all @code{:children} and @code{:buttons} in @var{widget}. | |
1560 @end defun | |
1561 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1562 @vindex value-get@r{ keyword} |
25829 | 1563 @item :value-get |
1564 Function to extract the value of a widget, as it is displayed in the | |
1565 buffer. | |
1566 | |
1567 The following predefined function can be used here: | |
1568 | |
1569 @defun widget-value-value-get widget | |
1570 Return the @code{:value} property of @var{widget}. | |
1571 @end defun | |
1572 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1573 @vindex format-handler@r{ keyword} |
25829 | 1574 @item :format-handler |
1575 Function to handle unknown @samp{%} escapes in the format string. It | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1576 will be called with the widget and the character that follows the |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1577 @samp{%} as arguments. You can set this to allow your widget to handle |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1578 non-standard escapes. |
25829 | 1579 |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1580 @findex widget-default-format-handler |
25829 | 1581 You should end up calling @code{widget-default-format-handler} to handle |
1582 unknown escape sequences, which will handle the @samp{%h} and any future | |
1583 escape sequences, as well as give an error for unknown escapes. | |
1584 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1585 @vindex action@r{ keyword} |
25829 | 1586 @item :action |
1587 Function to handle user initiated events. By default, @code{:notify} | |
1588 the parent. | |
1589 | |
1590 The following predefined function can be used here: | |
1591 | |
1592 @defun widget-parent-action widget &optional event | |
1593 Tell @code{:parent} of @var{widget} to handle the @code{:action}. | |
1594 Optional @var{event} is the event that triggered the action. | |
1595 @end defun | |
1596 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1597 @vindex prompt-value@r{ keyword} |
25829 | 1598 @item :prompt-value |
1599 Function to prompt for a value in the minibuffer. The function should | |
1600 take four arguments, @var{widget}, @var{prompt}, @var{value}, and | |
1601 @var{unbound} and should return a value for widget entered by the user. | |
1602 @var{prompt} is the prompt to use. @var{value} is the default value to | |
27214 | 1603 use, unless @var{unbound} is non-nil, in which case there is no default |
25829 | 1604 value. The function should read the value using the method most natural |
1605 for this widget, and does not have to check that it matches. | |
1606 @end table | |
1607 | |
1608 If you want to define a new widget from scratch, use the @code{default} | |
1609 widget as its base. | |
1610 | |
1611 @deffn Widget default | |
1612 Widget used as a base for other widgets. | |
1613 | |
1614 It provides most of the functionality that is referred to as ``by | |
1615 default'' in this text. | |
1616 @end deffn | |
1617 | |
1618 @node Widget Browser, Widget Minor Mode, Defining New Widgets, Top | |
1619 @comment node-name, next, previous, up | |
1620 @section Widget Browser | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1621 @cindex widget browser |
25829 | 1622 |
1623 There is a separate package to browse widgets. This is intended to help | |
1624 programmers who want to examine the content of a widget. The browser | |
1625 shows the value of each keyword, but uses links for certain keywords | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1626 such as @samp{:parent}, which avoids printing cyclic structures. |
25829 | 1627 |
1628 @deffn Command widget-browse WIDGET | |
1629 Create a widget browser for WIDGET. | |
1630 When called interactively, prompt for WIDGET. | |
1631 @end deffn | |
1632 | |
1633 @deffn Command widget-browse-other-window WIDGET | |
1634 Create a widget browser for WIDGET and show it in another window. | |
1635 When called interactively, prompt for WIDGET. | |
1636 @end deffn | |
1637 | |
1638 @deffn Command widget-browse-at POS | |
1639 Create a widget browser for the widget at POS. | |
1640 When called interactively, use the position of point. | |
1641 @end deffn | |
1642 | |
1643 @node Widget Minor Mode, Utilities, Widget Browser, Top | |
1644 @comment node-name, next, previous, up | |
1645 @section Widget Minor Mode | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1646 @cindex widget minor mode |
25829 | 1647 |
1648 There is a minor mode for manipulating widgets in major modes that | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1649 don't provide any support for widgets themselves. This is mostly |
25829 | 1650 intended to be useful for programmers doing experiments. |
1651 | |
1652 @deffn Command widget-minor-mode | |
1653 Toggle minor mode for traversing widgets. | |
1654 With arg, turn widget mode on if and only if arg is positive. | |
1655 @end deffn | |
1656 | |
1657 @defvar widget-minor-mode-keymap | |
1658 Keymap used in @code{widget-minor-mode}. | |
1659 @end defvar | |
1660 | |
1661 @node Utilities, Widget Wishlist, Widget Minor Mode, Top | |
1662 @comment node-name, next, previous, up | |
1663 @section Utilities. | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1664 @cindex utility functions for widgets |
25829 | 1665 |
1666 @defun widget-prompt-value widget prompt [ value unbound ] | |
1667 Prompt for a value matching @var{widget}, using @var{prompt}. | |
1668 The current value is assumed to be @var{value}, unless @var{unbound} is | |
1669 non-nil.@refill | |
1670 @end defun | |
1671 | |
1672 @defun widget-get-sibling widget | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1673 Get the item which @var{widget} is assumed to toggle. |
25829 | 1674 This is only meaningful for radio buttons or checkboxes in a list. |
1675 @end defun | |
1676 | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1677 @node Widget Wishlist, Index, Utilities, Top |
25829 | 1678 @comment node-name, next, previous, up |
1679 @section Wishlist | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1680 @cindex todo |
25829 | 1681 |
1682 @itemize @bullet | |
1683 @item | |
1684 It should be possible to add or remove items from a list with @kbd{C-k} | |
1685 and @kbd{C-o} (suggested by @sc{rms}). | |
1686 | |
1687 @item | |
1688 The @samp{[INS]} and @samp{[DEL]} buttons should be replaced by a single | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1689 dash (@samp{-}). The dash should be a button that, when invoked, asks |
25829 | 1690 whether you want to add or delete an item (@sc{rms} wanted to git rid of |
1691 the ugly buttons, the dash is my idea). | |
1692 | |
1693 @item | |
1694 The @code{menu-choice} tag should be prettier, something like the abbreviated | |
1695 menus in Open Look. | |
1696 | |
1697 @item | |
1698 Finish @code{:tab-order}. | |
1699 | |
1700 @item | |
1701 Make indentation work with glyphs and proportional fonts. | |
1702 | |
1703 @item | |
1704 Add commands to show overview of object and class hierarchies to the | |
1705 browser. | |
1706 | |
1707 @item | |
1708 Find a way to disable mouse highlight for inactive widgets. | |
1709 | |
1710 @item | |
1711 Find a way to make glyphs look inactive. | |
1712 | |
1713 @item | |
1714 Add @code{property-list} widget. | |
1715 | |
1716 @item | |
1717 Add @code{association-list} widget. | |
1718 | |
1719 @item | |
1720 Add @code{key-binding} widget. | |
1721 | |
1722 @item | |
1723 Add @code{widget} widget for editing widget specifications. | |
1724 | |
1725 @item | |
1726 Find clean way to implement variable length list. | |
1727 See @code{TeX-printer-list} for an explanation. | |
1728 | |
1729 @item | |
1730 @kbd{C-h} in @code{widget-prompt-value} should give type specific help. | |
1731 | |
1732 @item | |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1733 Add a @code{mailto} widget. |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1734 @end itemize |
25829 | 1735 |
30775
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1736 @node Index, , Widget Wishlist, Top |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1737 @comment node-name, next, previous, up |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1738 @unnumbered Index |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1739 |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1740 This is an alphabetical listing of all concepts, functions, commands, |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1741 variables, and widgets described in this manual. |
33d2bde9a99a
(Top): Add Index in the menu.
Eli Zaretskii <eliz@gnu.org>
parents:
30009
diff
changeset
|
1742 @printindex cp |
25829 | 1743 |
29713 | 1744 @setchapternewpage odd |
25829 | 1745 @contents |
1746 @bye |