annotate man/widget.texi @ 78151:cd5b15b5cd2e

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