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