annotate man/widget.texi @ 68603:4f414ab54d9e

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