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