annotate doc/misc/widget.texi @ 100194:f76e0ce31e62

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