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