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