Mercurial > emacs
annotate lispref/customize.texi @ 70016:b47f8cdc0b75
*** empty log message ***
author | Carsten Dominik <dominik@science.uva.nl> |
---|---|
date | Thu, 13 Apr 2006 15:11:06 +0000 |
parents | 6ca7f811a803 |
children | 80d80d23ec24 |
rev | line source |
---|---|
21006 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
64889
e836425ee789
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
64301
diff
changeset
|
3 @c Copyright (C) 1997, 1998, 1999, 2000, 2002, 2003, 2004, |
68648
067115a6e738
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
67711
diff
changeset
|
4 @c 2005, 2006 Free Software Foundation, Inc. |
21006 | 5 @c See the file elisp.texi for copying conditions. |
6 @setfilename ../info/customize | |
7 @node Customization, Loading, Macros, Top | |
8 @chapter Writing Customization Definitions | |
9 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
10 This chapter describes how to declare user options for customization, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
11 and also customization groups for classifying them. We use the term |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
12 @dfn{customization item} to include both kinds of customization |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
13 definitions---as well as face definitions (@pxref{Defining Faces}). |
21006 | 14 |
15 @menu | |
64301
ce506ff1d861
(Variable Definitions): Add `custom-initialize-safe-set' and
Luc Teirlinck <teirllm@auburn.edu>
parents:
63583
diff
changeset
|
16 * Common Keywords:: Common keyword arguments for all kinds of |
62246
8f1f80a5bd64
(Customization): Add menu descriptions.
Lute Kamstra <lute@gnu.org>
parents:
61618
diff
changeset
|
17 customization declarations. |
8f1f80a5bd64
(Customization): Add menu descriptions.
Lute Kamstra <lute@gnu.org>
parents:
61618
diff
changeset
|
18 * Group Definitions:: Writing customization group definitions. |
8f1f80a5bd64
(Customization): Add menu descriptions.
Lute Kamstra <lute@gnu.org>
parents:
61618
diff
changeset
|
19 * Variable Definitions:: Declaring user options. |
8f1f80a5bd64
(Customization): Add menu descriptions.
Lute Kamstra <lute@gnu.org>
parents:
61618
diff
changeset
|
20 * Customization Types:: Specifying the type of a user option. |
21006 | 21 @end menu |
22 | |
23 @node Common Keywords | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
24 @section Common Item Keywords |
21006 | 25 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
26 All kinds of customization declarations (for variables and groups, and |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
27 for faces) accept keyword arguments for specifying various information. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
28 This section describes some keywords that apply to all kinds. |
21006 | 29 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
30 All of these keywords, except @code{:tag}, can be used more than once |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
31 in a given item. Each use of the keyword has an independent effect. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
32 The keyword @code{:tag} is an exception because any given item can only |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
33 display one name. |
21006 | 34 |
35 @table @code | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
36 @item :tag @var{label} |
67491
e5693a64f4ea
(Common Keywords): State caveats for use of :tag.
Richard M. Stallman <rms@gnu.org>
parents:
67063
diff
changeset
|
37 Use @var{label}, a string, instead of the item's name, to label the |
e5693a64f4ea
(Common Keywords): State caveats for use of :tag.
Richard M. Stallman <rms@gnu.org>
parents:
67063
diff
changeset
|
38 item in customization menus and buffers. @strong{Don't use a tag |
e5693a64f4ea
(Common Keywords): State caveats for use of :tag.
Richard M. Stallman <rms@gnu.org>
parents:
67063
diff
changeset
|
39 which is substantially different from the item's real name; that would |
e5693a64f4ea
(Common Keywords): State caveats for use of :tag.
Richard M. Stallman <rms@gnu.org>
parents:
67063
diff
changeset
|
40 cause confusion.} One legitimate case for use of @code{:tag} is to |
e5693a64f4ea
(Common Keywords): State caveats for use of :tag.
Richard M. Stallman <rms@gnu.org>
parents:
67063
diff
changeset
|
41 specify a dash where normally a hyphen would be converted to a space: |
e5693a64f4ea
(Common Keywords): State caveats for use of :tag.
Richard M. Stallman <rms@gnu.org>
parents:
67063
diff
changeset
|
42 |
e5693a64f4ea
(Common Keywords): State caveats for use of :tag.
Richard M. Stallman <rms@gnu.org>
parents:
67063
diff
changeset
|
43 @example |
e5693a64f4ea
(Common Keywords): State caveats for use of :tag.
Richard M. Stallman <rms@gnu.org>
parents:
67063
diff
changeset
|
44 (defcustom cursor-in-non-selected-windows @dots{} |
e5693a64f4ea
(Common Keywords): State caveats for use of :tag.
Richard M. Stallman <rms@gnu.org>
parents:
67063
diff
changeset
|
45 :tag "Cursor In Non-selected Windows" |
e5693a64f4ea
(Common Keywords): State caveats for use of :tag.
Richard M. Stallman <rms@gnu.org>
parents:
67063
diff
changeset
|
46 @end example |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
47 |
21006 | 48 @item :group @var{group} |
49 Put this customization item in group @var{group}. When you use | |
50 @code{:group} in a @code{defgroup}, it makes the new group a subgroup of | |
51 @var{group}. | |
52 | |
53 If you use this keyword more than once, you can put a single item into | |
54 more than one group. Displaying any of those groups will show this | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
55 item. Please don't overdo this, since the result would be annoying. |
21006 | 56 |
57 @item :link @var{link-data} | |
58 Include an external link after the documentation string for this item. | |
59 This is a sentence containing an active field which references some | |
60 other documentation. | |
61 | |
67063
bc77b2e433fb
(Common Keywords): Update links types custom-manual and url-link.
Juri Linkov <juri@jurta.org>
parents:
66142
diff
changeset
|
62 There are several alternatives you can use for @var{link-data}: |
21006 | 63 |
64 @table @code | |
65 @item (custom-manual @var{info-node}) | |
66 Link to an Info node; @var{info-node} is a string which specifies the | |
67 node name, as in @code{"(emacs)Top"}. The link appears as | |
67063
bc77b2e433fb
(Common Keywords): Update links types custom-manual and url-link.
Juri Linkov <juri@jurta.org>
parents:
66142
diff
changeset
|
68 @samp{[Manual]} in the customization buffer and enters the built-in |
bc77b2e433fb
(Common Keywords): Update links types custom-manual and url-link.
Juri Linkov <juri@jurta.org>
parents:
66142
diff
changeset
|
69 Info reader on @var{info-node}. |
21006 | 70 |
71 @item (info-link @var{info-node}) | |
72 Like @code{custom-manual} except that the link appears | |
73 in the customization buffer with the Info node name. | |
74 | |
75 @item (url-link @var{url}) | |
67063
bc77b2e433fb
(Common Keywords): Update links types custom-manual and url-link.
Juri Linkov <juri@jurta.org>
parents:
66142
diff
changeset
|
76 Link to a web page; @var{url} is a string which specifies the |
bc77b2e433fb
(Common Keywords): Update links types custom-manual and url-link.
Juri Linkov <juri@jurta.org>
parents:
66142
diff
changeset
|
77 @acronym{URL}. The link appears in the customization buffer as |
bc77b2e433fb
(Common Keywords): Update links types custom-manual and url-link.
Juri Linkov <juri@jurta.org>
parents:
66142
diff
changeset
|
78 @var{url} and invokes the WWW browser specified by |
67688
7561789df348
(Common Keywords): Fix Texinfo usage.
Luc Teirlinck <teirllm@auburn.edu>
parents:
67491
diff
changeset
|
79 @code{browse-url-browser-function}. |
32521
bfbe1fcac416
custom types emacs-commentary-link, coding-system, color
Dave Love <fx@gnu.org>
parents:
30904
diff
changeset
|
80 |
bfbe1fcac416
custom types emacs-commentary-link, coding-system, color
Dave Love <fx@gnu.org>
parents:
30904
diff
changeset
|
81 @item (emacs-commentary-link @var{library}) |
bfbe1fcac416
custom types emacs-commentary-link, coding-system, color
Dave Love <fx@gnu.org>
parents:
30904
diff
changeset
|
82 Link to the commentary section of a library; @var{library} is a string |
bfbe1fcac416
custom types emacs-commentary-link, coding-system, color
Dave Love <fx@gnu.org>
parents:
30904
diff
changeset
|
83 which specifies the library name. |
67063
bc77b2e433fb
(Common Keywords): Update links types custom-manual and url-link.
Juri Linkov <juri@jurta.org>
parents:
66142
diff
changeset
|
84 |
bc77b2e433fb
(Common Keywords): Update links types custom-manual and url-link.
Juri Linkov <juri@jurta.org>
parents:
66142
diff
changeset
|
85 @item (emacs-library-link @var{library}) |
bc77b2e433fb
(Common Keywords): Update links types custom-manual and url-link.
Juri Linkov <juri@jurta.org>
parents:
66142
diff
changeset
|
86 Link to an Emacs Lisp library file; @var{library} is a string which |
bc77b2e433fb
(Common Keywords): Update links types custom-manual and url-link.
Juri Linkov <juri@jurta.org>
parents:
66142
diff
changeset
|
87 specifies the library name. |
bc77b2e433fb
(Common Keywords): Update links types custom-manual and url-link.
Juri Linkov <juri@jurta.org>
parents:
66142
diff
changeset
|
88 |
bc77b2e433fb
(Common Keywords): Update links types custom-manual and url-link.
Juri Linkov <juri@jurta.org>
parents:
66142
diff
changeset
|
89 @item (file-link @var{file}) |
bc77b2e433fb
(Common Keywords): Update links types custom-manual and url-link.
Juri Linkov <juri@jurta.org>
parents:
66142
diff
changeset
|
90 Link to a file; @var{file} is a string which specifies the name of the |
bc77b2e433fb
(Common Keywords): Update links types custom-manual and url-link.
Juri Linkov <juri@jurta.org>
parents:
66142
diff
changeset
|
91 file to visit with @code{find-file} when the user invokes this link. |
bc77b2e433fb
(Common Keywords): Update links types custom-manual and url-link.
Juri Linkov <juri@jurta.org>
parents:
66142
diff
changeset
|
92 |
bc77b2e433fb
(Common Keywords): Update links types custom-manual and url-link.
Juri Linkov <juri@jurta.org>
parents:
66142
diff
changeset
|
93 @item (function-link @var{function}) |
bc77b2e433fb
(Common Keywords): Update links types custom-manual and url-link.
Juri Linkov <juri@jurta.org>
parents:
66142
diff
changeset
|
94 Link to the documentation of a function; @var{function} is a string |
bc77b2e433fb
(Common Keywords): Update links types custom-manual and url-link.
Juri Linkov <juri@jurta.org>
parents:
66142
diff
changeset
|
95 which specifies the name of the function to describe with |
bc77b2e433fb
(Common Keywords): Update links types custom-manual and url-link.
Juri Linkov <juri@jurta.org>
parents:
66142
diff
changeset
|
96 @code{describe-function} when the user invokes this link. |
bc77b2e433fb
(Common Keywords): Update links types custom-manual and url-link.
Juri Linkov <juri@jurta.org>
parents:
66142
diff
changeset
|
97 |
bc77b2e433fb
(Common Keywords): Update links types custom-manual and url-link.
Juri Linkov <juri@jurta.org>
parents:
66142
diff
changeset
|
98 @item (variable-link @var{variable}) |
bc77b2e433fb
(Common Keywords): Update links types custom-manual and url-link.
Juri Linkov <juri@jurta.org>
parents:
66142
diff
changeset
|
99 Link to the documentation of a variable; @var{variable} is a string |
bc77b2e433fb
(Common Keywords): Update links types custom-manual and url-link.
Juri Linkov <juri@jurta.org>
parents:
66142
diff
changeset
|
100 which specifies the name of the variable to describe with |
bc77b2e433fb
(Common Keywords): Update links types custom-manual and url-link.
Juri Linkov <juri@jurta.org>
parents:
66142
diff
changeset
|
101 @code{describe-variable} when the user invokes this link. |
bc77b2e433fb
(Common Keywords): Update links types custom-manual and url-link.
Juri Linkov <juri@jurta.org>
parents:
66142
diff
changeset
|
102 |
bc77b2e433fb
(Common Keywords): Update links types custom-manual and url-link.
Juri Linkov <juri@jurta.org>
parents:
66142
diff
changeset
|
103 @item (custom-group-link @var{group}) |
bc77b2e433fb
(Common Keywords): Update links types custom-manual and url-link.
Juri Linkov <juri@jurta.org>
parents:
66142
diff
changeset
|
104 Link to another customization group. Invoking it creates a new |
bc77b2e433fb
(Common Keywords): Update links types custom-manual and url-link.
Juri Linkov <juri@jurta.org>
parents:
66142
diff
changeset
|
105 customization buffer for @var{group}. |
21006 | 106 @end table |
107 | |
108 You can specify the text to use in the customization buffer by adding | |
109 @code{:tag @var{name}} after the first element of the @var{link-data}; | |
110 for example, @code{(info-link :tag "foo" "(emacs)Top")} makes a link to | |
111 the Emacs manual which appears in the buffer as @samp{foo}. | |
112 | |
113 An item can have more than one external link; however, most items have | |
114 none at all. | |
115 | |
116 @item :load @var{file} | |
117 Load file @var{file} (a string) before displaying this customization | |
118 item. Loading is done with @code{load-library}, and only if the file is | |
119 not already loaded. | |
120 | |
121 @item :require @var{feature} | |
60499
a33defc96586
(Common Keywords): Clarify :require. Mention :version here.
Richard M. Stallman <rms@gnu.org>
parents:
59768
diff
changeset
|
122 Execute @code{(require '@var{feature})} when your saved customizations |
a33defc96586
(Common Keywords): Clarify :require. Mention :version here.
Richard M. Stallman <rms@gnu.org>
parents:
59768
diff
changeset
|
123 set the value of this item. @var{feature} should be a symbol. |
21006 | 124 |
125 The most common reason to use @code{:require} is when a variable enables | |
126 a feature such as a minor mode, and just setting the variable won't have | |
127 any effect unless the code which implements the mode is loaded. | |
60499
a33defc96586
(Common Keywords): Clarify :require. Mention :version here.
Richard M. Stallman <rms@gnu.org>
parents:
59768
diff
changeset
|
128 |
a33defc96586
(Common Keywords): Clarify :require. Mention :version here.
Richard M. Stallman <rms@gnu.org>
parents:
59768
diff
changeset
|
129 @item :version @var{version} |
a33defc96586
(Common Keywords): Clarify :require. Mention :version here.
Richard M. Stallman <rms@gnu.org>
parents:
59768
diff
changeset
|
130 This option specifies that the item was first introduced in Emacs |
a33defc96586
(Common Keywords): Clarify :require. Mention :version here.
Richard M. Stallman <rms@gnu.org>
parents:
59768
diff
changeset
|
131 version @var{version}, or that its default value was changed in that |
a33defc96586
(Common Keywords): Clarify :require. Mention :version here.
Richard M. Stallman <rms@gnu.org>
parents:
59768
diff
changeset
|
132 version. The value @var{version} must be a string. |
69923
9e0c65fe8bd1
(Common Keywords): Add :package-version.
Bill Wohler <wohler@newt.com>
parents:
68648
diff
changeset
|
133 |
9e0c65fe8bd1
(Common Keywords): Add :package-version.
Bill Wohler <wohler@newt.com>
parents:
68648
diff
changeset
|
134 @item :package-version '(@var{package} @var{version}) |
9e0c65fe8bd1
(Common Keywords): Add :package-version.
Bill Wohler <wohler@newt.com>
parents:
68648
diff
changeset
|
135 This option specifies that the item was first introduced in |
9e0c65fe8bd1
(Common Keywords): Add :package-version.
Bill Wohler <wohler@newt.com>
parents:
68648
diff
changeset
|
136 @var{package} version @var{version}, or that its default value was |
9e0c65fe8bd1
(Common Keywords): Add :package-version.
Bill Wohler <wohler@newt.com>
parents:
68648
diff
changeset
|
137 changed in that version. This keyword takes priority over :version. |
9e0c65fe8bd1
(Common Keywords): Add :package-version.
Bill Wohler <wohler@newt.com>
parents:
68648
diff
changeset
|
138 The @var{package} and @var{version} must appear in the alist |
69979
6ca7f811a803
(Common Keywords): Move description of
Bill Wohler <wohler@newt.com>
parents:
69923
diff
changeset
|
139 @code{customize-package-emacs-version-alist}. |
6ca7f811a803
(Common Keywords): Move description of
Bill Wohler <wohler@newt.com>
parents:
69923
diff
changeset
|
140 |
6ca7f811a803
(Common Keywords): Move description of
Bill Wohler <wohler@newt.com>
parents:
69923
diff
changeset
|
141 @end table |
6ca7f811a803
(Common Keywords): Move description of
Bill Wohler <wohler@newt.com>
parents:
69923
diff
changeset
|
142 |
6ca7f811a803
(Common Keywords): Move description of
Bill Wohler <wohler@newt.com>
parents:
69923
diff
changeset
|
143 Packages that use the @code{:package-version} keyword must also update |
6ca7f811a803
(Common Keywords): Move description of
Bill Wohler <wohler@newt.com>
parents:
69923
diff
changeset
|
144 the @code{customize-package-emacs-version-alist} variable. |
6ca7f811a803
(Common Keywords): Move description of
Bill Wohler <wohler@newt.com>
parents:
69923
diff
changeset
|
145 |
6ca7f811a803
(Common Keywords): Move description of
Bill Wohler <wohler@newt.com>
parents:
69923
diff
changeset
|
146 @defvar customize-package-emacs-version-alist |
6ca7f811a803
(Common Keywords): Move description of
Bill Wohler <wohler@newt.com>
parents:
69923
diff
changeset
|
147 This alist maps packages to alists that map all package versions used |
6ca7f811a803
(Common Keywords): Move description of
Bill Wohler <wohler@newt.com>
parents:
69923
diff
changeset
|
148 with the @code{:package-version} keyword to Emacs versions. Packages |
6ca7f811a803
(Common Keywords): Move description of
Bill Wohler <wohler@newt.com>
parents:
69923
diff
changeset
|
149 are symbols and versions are strings. For example, the MH-E package |
69923
9e0c65fe8bd1
(Common Keywords): Add :package-version.
Bill Wohler <wohler@newt.com>
parents:
68648
diff
changeset
|
150 updates this alist with the following: |
9e0c65fe8bd1
(Common Keywords): Add :package-version.
Bill Wohler <wohler@newt.com>
parents:
68648
diff
changeset
|
151 |
9e0c65fe8bd1
(Common Keywords): Add :package-version.
Bill Wohler <wohler@newt.com>
parents:
68648
diff
changeset
|
152 @smallexample |
9e0c65fe8bd1
(Common Keywords): Add :package-version.
Bill Wohler <wohler@newt.com>
parents:
68648
diff
changeset
|
153 (add-to-list 'customize-package-emacs-version-alist |
9e0c65fe8bd1
(Common Keywords): Add :package-version.
Bill Wohler <wohler@newt.com>
parents:
68648
diff
changeset
|
154 '(MH-E ("6.0" "22.1") ("6.1" "22.1") ("7.0" "22.1") |
9e0c65fe8bd1
(Common Keywords): Add :package-version.
Bill Wohler <wohler@newt.com>
parents:
68648
diff
changeset
|
155 ("7.1" "22.1") ("7.2" "22.1") ("7.3" "22.1") |
9e0c65fe8bd1
(Common Keywords): Add :package-version.
Bill Wohler <wohler@newt.com>
parents:
68648
diff
changeset
|
156 ("7.4" "22.1") ("8.0" "22.1"))) |
9e0c65fe8bd1
(Common Keywords): Add :package-version.
Bill Wohler <wohler@newt.com>
parents:
68648
diff
changeset
|
157 @end smallexample |
69979
6ca7f811a803
(Common Keywords): Move description of
Bill Wohler <wohler@newt.com>
parents:
69923
diff
changeset
|
158 @end defvar |
21006 | 159 |
160 @node Group Definitions | |
161 @section Defining Custom Groups | |
162 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
163 Each Emacs Lisp package should have one main customization group which |
21006 | 164 contains all the options, faces and other groups in the package. If the |
165 package has a small number of options and faces, use just one group and | |
166 put everything in it. When there are more than twelve or so options and | |
167 faces, then you should structure them into subgroups, and put the | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
168 subgroups under the package's main customization group. It is OK to |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
169 put some of the options and faces in the package's main group alongside |
21006 | 170 the subgroups. |
171 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
172 The package's main or only group should be a member of one or more of |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
173 the standard customization groups. (To display the full list of them, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
174 use @kbd{M-x customize}.) Choose one or more of them (but not too |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
175 many), and add your group to each of them using the @code{:group} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
176 keyword. |
21006 | 177 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
178 The way to declare new customization groups is with @code{defgroup}. |
21006 | 179 |
66142
17e84500628a
(Group Definitions): Replace `...' with `@dots{}' in `@defmac' and `@defspec'.
Juri Linkov <juri@jurta.org>
parents:
64889
diff
changeset
|
180 @defmac defgroup group members doc [keyword value]@dots{} |
21006 | 181 Declare @var{group} as a customization group containing @var{members}. |
182 Do not quote the symbol @var{group}. The argument @var{doc} specifies | |
67688
7561789df348
(Common Keywords): Fix Texinfo usage.
Luc Teirlinck <teirllm@auburn.edu>
parents:
67491
diff
changeset
|
183 the documentation string for the group. |
21006 | 184 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
185 The argument @var{members} is a list specifying an initial set of |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
186 customization items to be members of the group. However, most often |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
187 @var{members} is @code{nil}, and you specify the group's members by |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
188 using the @code{:group} keyword when defining those members. |
21006 | 189 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
190 If you want to specify group members through @var{members}, each element |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
191 should have the form @code{(@var{name} @var{widget})}. Here @var{name} |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
192 is a symbol, and @var{widget} is a widget type for editing that symbol. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
193 Useful widgets are @code{custom-variable} for a variable, |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
194 @code{custom-face} for a face, and @code{custom-group} for a group. |
21006 | 195 |
60499
a33defc96586
(Common Keywords): Clarify :require. Mention :version here.
Richard M. Stallman <rms@gnu.org>
parents:
59768
diff
changeset
|
196 When you introduce a new group into Emacs, use the @code{:version} |
a33defc96586
(Common Keywords): Clarify :require. Mention :version here.
Richard M. Stallman <rms@gnu.org>
parents:
59768
diff
changeset
|
197 keyword in the @code{defgroup}; then you need not use it for |
a33defc96586
(Common Keywords): Clarify :require. Mention :version here.
Richard M. Stallman <rms@gnu.org>
parents:
59768
diff
changeset
|
198 the individual members of the group. |
33150 | 199 |
21006 | 200 In addition to the common keywords (@pxref{Common Keywords}), you can |
33150 | 201 also use this keyword in @code{defgroup}: |
21006 | 202 |
203 @table @code | |
204 @item :prefix @var{prefix} | |
205 If the name of an item in the group starts with @var{prefix}, then the | |
206 tag for that item is constructed (by default) by omitting @var{prefix}. | |
207 | |
208 One group can have any number of prefixes. | |
209 @end table | |
210 @end defmac | |
211 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
212 The prefix-discarding feature is currently turned off, which means |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
213 that @code{:prefix} currently has no effect. We did this because we |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
214 found that discarding the specified prefixes often led to confusing |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
215 names for options. This happened because the people who wrote the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
216 @code{defgroup} definitions for various groups added @code{:prefix} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
217 keywords whenever they make logical sense---that is, whenever the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
218 variables in the library have a common prefix. |
21006 | 219 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
220 In order to obtain good results with @code{:prefix}, it would be |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
221 necessary to check the specific effects of discarding a particular |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
222 prefix, given the specific items in a group and their names and |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
223 documentation. If the resulting text is not clear, then @code{:prefix} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
224 should not be used in that case. |
21006 | 225 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
226 It should be possible to recheck all the customization groups, delete |
21006 | 227 the @code{:prefix} specifications which give unclear results, and then |
228 turn this feature back on, if someone would like to do the work. | |
229 | |
230 @node Variable Definitions | |
231 @section Defining Customization Variables | |
232 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
233 Use @code{defcustom} to declare user-editable variables. |
21006 | 234 |
35009
d80f2bfd0e05
Add `radio' type. User variable doc strings and backquote in
Dave Love <fx@gnu.org>
parents:
33150
diff
changeset
|
235 @defmac defcustom option default doc [keyword value]@dots{} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
236 Declare @var{option} as a customizable user option variable. Do not |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
237 quote @var{option}. The argument @var{doc} specifies the documentation |
67688
7561789df348
(Common Keywords): Fix Texinfo usage.
Luc Teirlinck <teirllm@auburn.edu>
parents:
67491
diff
changeset
|
238 string for the variable. There is no need to start it with a @samp{*} |
7561789df348
(Common Keywords): Fix Texinfo usage.
Luc Teirlinck <teirllm@auburn.edu>
parents:
67491
diff
changeset
|
239 because @code{defcustom} automatically marks @var{option} as a |
7561789df348
(Common Keywords): Fix Texinfo usage.
Luc Teirlinck <teirllm@auburn.edu>
parents:
67491
diff
changeset
|
240 @dfn{user option} (@pxref{Defining Variables}). |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
241 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
242 If @var{option} is void, @code{defcustom} initializes it to |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
243 @var{default}. @var{default} should be an expression to compute the |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
244 value; be careful in writing it, because it can be evaluated on more |
35009
d80f2bfd0e05
Add `radio' type. User variable doc strings and backquote in
Dave Love <fx@gnu.org>
parents:
33150
diff
changeset
|
245 than one occasion. You should normally avoid using backquotes in |
d80f2bfd0e05
Add `radio' type. User variable doc strings and backquote in
Dave Love <fx@gnu.org>
parents:
33150
diff
changeset
|
246 @var{default} because they are not expanded when editing the value, |
d80f2bfd0e05
Add `radio' type. User variable doc strings and backquote in
Dave Love <fx@gnu.org>
parents:
33150
diff
changeset
|
247 causing list values to appear to have the wrong structure. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
248 |
56235
ba5561d20501
(Variable Definitions): Note about doc strings and :set.
Richard M. Stallman <rms@gnu.org>
parents:
54299
diff
changeset
|
249 If you specify the @code{:set} option, to make the variable take other |
ba5561d20501
(Variable Definitions): Note about doc strings and :set.
Richard M. Stallman <rms@gnu.org>
parents:
54299
diff
changeset
|
250 special actions when set through the customization buffer, the |
ba5561d20501
(Variable Definitions): Note about doc strings and :set.
Richard M. Stallman <rms@gnu.org>
parents:
54299
diff
changeset
|
251 variable's documentation string should tell the user specifically how |
ba5561d20501
(Variable Definitions): Note about doc strings and :set.
Richard M. Stallman <rms@gnu.org>
parents:
54299
diff
changeset
|
252 to do the same job in hand-written Lisp code. |
ba5561d20501
(Variable Definitions): Note about doc strings and :set.
Richard M. Stallman <rms@gnu.org>
parents:
54299
diff
changeset
|
253 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
254 When you evaluate a @code{defcustom} form with @kbd{C-M-x} in Emacs Lisp |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
255 mode (@code{eval-defun}), a special feature of @code{eval-defun} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
256 arranges to set the variable unconditionally, without testing whether |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
257 its value is void. (The same feature applies to @code{defvar}.) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
258 @xref{Defining Variables}. |
22274
f0cd03a7dac9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
259 @end defmac |
21006 | 260 |
22274
f0cd03a7dac9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
261 @code{defcustom} accepts the following additional keywords: |
21006 | 262 |
263 @table @code | |
264 @item :type @var{type} | |
265 Use @var{type} as the data type for this option. It specifies which | |
266 values are legitimate, and how to display the value. | |
267 @xref{Customization Types}, for more information. | |
268 | |
269 @item :options @var{list} | |
270 Specify @var{list} as the list of reasonable values for use in this | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
271 option. The user is not restricted to using only these values, but they |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
272 are offered as convenient alternatives. |
21006 | 273 |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
274 This is meaningful only for certain types, currently including |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
275 @code{hook}, @code{plist} and @code{alist}. See the definition of the |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
276 individual types for a description of how to use @code{:options}. |
21006 | 277 |
278 @item :set @var{setfunction} | |
60499
a33defc96586
(Common Keywords): Clarify :require. Mention :version here.
Richard M. Stallman <rms@gnu.org>
parents:
59768
diff
changeset
|
279 Specify @var{setfunction} as the way to change the value of this |
a33defc96586
(Common Keywords): Clarify :require. Mention :version here.
Richard M. Stallman <rms@gnu.org>
parents:
59768
diff
changeset
|
280 option. The function @var{setfunction} should take two arguments, a |
a33defc96586
(Common Keywords): Clarify :require. Mention :version here.
Richard M. Stallman <rms@gnu.org>
parents:
59768
diff
changeset
|
281 symbol (the option name) and the new value, and should do whatever is |
a33defc96586
(Common Keywords): Clarify :require. Mention :version here.
Richard M. Stallman <rms@gnu.org>
parents:
59768
diff
changeset
|
282 necessary to update the value properly for this option (which may not |
a33defc96586
(Common Keywords): Clarify :require. Mention :version here.
Richard M. Stallman <rms@gnu.org>
parents:
59768
diff
changeset
|
283 mean simply setting the option as a Lisp variable). The default for |
a33defc96586
(Common Keywords): Clarify :require. Mention :version here.
Richard M. Stallman <rms@gnu.org>
parents:
59768
diff
changeset
|
284 @var{setfunction} is @code{set-default}. |
21006 | 285 |
286 @item :get @var{getfunction} | |
287 Specify @var{getfunction} as the way to extract the value of this | |
288 option. The function @var{getfunction} should take one argument, a | |
47783
e297e727596c
(Variable Definitions): Update info on :get and default :initialize function.
Richard M. Stallman <rms@gnu.org>
parents:
46809
diff
changeset
|
289 symbol, and should return whatever customize should use as the |
e297e727596c
(Variable Definitions): Update info on :get and default :initialize function.
Richard M. Stallman <rms@gnu.org>
parents:
46809
diff
changeset
|
290 ``current value'' for that symbol (which need not be the symbol's Lisp |
e297e727596c
(Variable Definitions): Update info on :get and default :initialize function.
Richard M. Stallman <rms@gnu.org>
parents:
46809
diff
changeset
|
291 value). The default is @code{default-value}. |
e297e727596c
(Variable Definitions): Update info on :get and default :initialize function.
Richard M. Stallman <rms@gnu.org>
parents:
46809
diff
changeset
|
292 |
e297e727596c
(Variable Definitions): Update info on :get and default :initialize function.
Richard M. Stallman <rms@gnu.org>
parents:
46809
diff
changeset
|
293 You have to really understand the workings of Custom to use |
e297e727596c
(Variable Definitions): Update info on :get and default :initialize function.
Richard M. Stallman <rms@gnu.org>
parents:
46809
diff
changeset
|
294 @code{:get} correctly. It is meant for values that are treated in |
e297e727596c
(Variable Definitions): Update info on :get and default :initialize function.
Richard M. Stallman <rms@gnu.org>
parents:
46809
diff
changeset
|
295 Custom as variables but are not actually stored in Lisp variables. It |
e297e727596c
(Variable Definitions): Update info on :get and default :initialize function.
Richard M. Stallman <rms@gnu.org>
parents:
46809
diff
changeset
|
296 is almost surely a mistake to specify @code{getfunction} for a value |
e297e727596c
(Variable Definitions): Update info on :get and default :initialize function.
Richard M. Stallman <rms@gnu.org>
parents:
46809
diff
changeset
|
297 that really is stored in a Lisp variable. |
21006 | 298 |
299 @item :initialize @var{function} | |
60499
a33defc96586
(Common Keywords): Clarify :require. Mention :version here.
Richard M. Stallman <rms@gnu.org>
parents:
59768
diff
changeset
|
300 @var{function} should be a function used to initialize the variable |
a33defc96586
(Common Keywords): Clarify :require. Mention :version here.
Richard M. Stallman <rms@gnu.org>
parents:
59768
diff
changeset
|
301 when the @code{defcustom} is evaluated. It should take two arguments, |
a33defc96586
(Common Keywords): Clarify :require. Mention :version here.
Richard M. Stallman <rms@gnu.org>
parents:
59768
diff
changeset
|
302 the option name (a symbol) and the value. Here are some predefined |
a33defc96586
(Common Keywords): Clarify :require. Mention :version here.
Richard M. Stallman <rms@gnu.org>
parents:
59768
diff
changeset
|
303 functions meant for use in this way: |
21006 | 304 |
305 @table @code | |
306 @item custom-initialize-set | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
307 Use the variable's @code{:set} function to initialize the variable, but |
47783
e297e727596c
(Variable Definitions): Update info on :get and default :initialize function.
Richard M. Stallman <rms@gnu.org>
parents:
46809
diff
changeset
|
308 do not reinitialize it if it is already non-void. |
21006 | 309 |
310 @item custom-initialize-default | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
311 Like @code{custom-initialize-set}, but use the function |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
312 @code{set-default} to set the variable, instead of the variable's |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
313 @code{:set} function. This is the usual choice for a variable whose |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
314 @code{:set} function enables or disables a minor mode; with this choice, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
315 defining the variable will not call the minor mode function, but |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
316 customizing the variable will do so. |
21006 | 317 |
318 @item custom-initialize-reset | |
47783
e297e727596c
(Variable Definitions): Update info on :get and default :initialize function.
Richard M. Stallman <rms@gnu.org>
parents:
46809
diff
changeset
|
319 Always use the @code{:set} function to initialize the variable. If |
e297e727596c
(Variable Definitions): Update info on :get and default :initialize function.
Richard M. Stallman <rms@gnu.org>
parents:
46809
diff
changeset
|
320 the variable is already non-void, reset it by calling the @code{:set} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
321 function using the current value (returned by the @code{:get} method). |
47783
e297e727596c
(Variable Definitions): Update info on :get and default :initialize function.
Richard M. Stallman <rms@gnu.org>
parents:
46809
diff
changeset
|
322 This is the default @code{:initialize} function. |
21006 | 323 |
324 @item custom-initialize-changed | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
325 Use the @code{:set} function to initialize the variable, if it is |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
326 already set or has been customized; otherwise, just use |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
327 @code{set-default}. |
64301
ce506ff1d861
(Variable Definitions): Add `custom-initialize-safe-set' and
Luc Teirlinck <teirllm@auburn.edu>
parents:
63583
diff
changeset
|
328 |
ce506ff1d861
(Variable Definitions): Add `custom-initialize-safe-set' and
Luc Teirlinck <teirllm@auburn.edu>
parents:
63583
diff
changeset
|
329 @item custom-initialize-safe-set |
ce506ff1d861
(Variable Definitions): Add `custom-initialize-safe-set' and
Luc Teirlinck <teirllm@auburn.edu>
parents:
63583
diff
changeset
|
330 @itemx custom-initialize-safe-default |
ce506ff1d861
(Variable Definitions): Add `custom-initialize-safe-set' and
Luc Teirlinck <teirllm@auburn.edu>
parents:
63583
diff
changeset
|
331 These functions behave like @code{custom-initialize-set} |
ce506ff1d861
(Variable Definitions): Add `custom-initialize-safe-set' and
Luc Teirlinck <teirllm@auburn.edu>
parents:
63583
diff
changeset
|
332 (@code{custom-initialize-default}, respectively), but catch errors. |
ce506ff1d861
(Variable Definitions): Add `custom-initialize-safe-set' and
Luc Teirlinck <teirllm@auburn.edu>
parents:
63583
diff
changeset
|
333 If an error occurs during initialization, they set the variable to |
ce506ff1d861
(Variable Definitions): Add `custom-initialize-safe-set' and
Luc Teirlinck <teirllm@auburn.edu>
parents:
63583
diff
changeset
|
334 @code{nil} using @code{set-default}, and throw no error. |
ce506ff1d861
(Variable Definitions): Add `custom-initialize-safe-set' and
Luc Teirlinck <teirllm@auburn.edu>
parents:
63583
diff
changeset
|
335 |
ce506ff1d861
(Variable Definitions): Add `custom-initialize-safe-set' and
Luc Teirlinck <teirllm@auburn.edu>
parents:
63583
diff
changeset
|
336 These two functions are only meant for options defined in pre-loaded |
ce506ff1d861
(Variable Definitions): Add `custom-initialize-safe-set' and
Luc Teirlinck <teirllm@auburn.edu>
parents:
63583
diff
changeset
|
337 files, where some variables or functions used to compute the option's |
ce506ff1d861
(Variable Definitions): Add `custom-initialize-safe-set' and
Luc Teirlinck <teirllm@auburn.edu>
parents:
63583
diff
changeset
|
338 value may not yet be defined. The option normally gets updated in |
ce506ff1d861
(Variable Definitions): Add `custom-initialize-safe-set' and
Luc Teirlinck <teirllm@auburn.edu>
parents:
63583
diff
changeset
|
339 @file{startup.el}, ignoring the previously computed value. Because of |
ce506ff1d861
(Variable Definitions): Add `custom-initialize-safe-set' and
Luc Teirlinck <teirllm@auburn.edu>
parents:
63583
diff
changeset
|
340 this typical usage, the value which these two functions compute |
ce506ff1d861
(Variable Definitions): Add `custom-initialize-safe-set' and
Luc Teirlinck <teirllm@auburn.edu>
parents:
63583
diff
changeset
|
341 normally only matters when, after startup, one unsets the option's |
ce506ff1d861
(Variable Definitions): Add `custom-initialize-safe-set' and
Luc Teirlinck <teirllm@auburn.edu>
parents:
63583
diff
changeset
|
342 value and then reevaluates the defcustom. By that time, the necessary |
ce506ff1d861
(Variable Definitions): Add `custom-initialize-safe-set' and
Luc Teirlinck <teirllm@auburn.edu>
parents:
63583
diff
changeset
|
343 variables and functions will be defined, so there will not be an error. |
21006 | 344 @end table |
26826
8f36e5feb992
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25950
diff
changeset
|
345 |
8f36e5feb992
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25950
diff
changeset
|
346 @item :set-after @var{variables} |
8f36e5feb992
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25950
diff
changeset
|
347 When setting variables according to saved customizations, make sure to |
8f36e5feb992
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25950
diff
changeset
|
348 set the variables @var{variables} before this one; in other words, delay |
8f36e5feb992
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25950
diff
changeset
|
349 setting this variable until after those others have been handled. Use |
8f36e5feb992
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25950
diff
changeset
|
350 @code{:set-after} if setting this variable won't work properly unless |
8f36e5feb992
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25950
diff
changeset
|
351 those other variables already have their intended values. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
352 @end table |
21006 | 353 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
354 The @code{:require} option is useful for an option that turns on the |
21006 | 355 operation of a certain feature. Assuming that the package is coded to |
356 check the value of the option, you still need to arrange for the package | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
357 to be loaded. You can do that with @code{:require}. @xref{Common |
61618
72a73fd3289a
(Variable Definitions): Replace tooltip-mode
Nick Roberts <nickrob@snap.net.nz>
parents:
60499
diff
changeset
|
358 Keywords}. Here is an example, from the library @file{saveplace.el}: |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
359 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
360 @example |
61618
72a73fd3289a
(Variable Definitions): Replace tooltip-mode
Nick Roberts <nickrob@snap.net.nz>
parents:
60499
diff
changeset
|
361 (defcustom save-place nil |
72a73fd3289a
(Variable Definitions): Replace tooltip-mode
Nick Roberts <nickrob@snap.net.nz>
parents:
60499
diff
changeset
|
362 "*Non-nil means automatically save place in each file..." |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
363 :type 'boolean |
61618
72a73fd3289a
(Variable Definitions): Replace tooltip-mode
Nick Roberts <nickrob@snap.net.nz>
parents:
60499
diff
changeset
|
364 :require 'saveplace |
72a73fd3289a
(Variable Definitions): Replace tooltip-mode
Nick Roberts <nickrob@snap.net.nz>
parents:
60499
diff
changeset
|
365 :group 'save-place) |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
366 @end example |
21006 | 367 |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
368 If a customization item has a type such as @code{hook} or @code{alist}, |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
369 which supports @code{:options}, you can add additional options to the |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
370 item, outside the @code{defcustom} declaration, by calling |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
371 @code{custom-add-option}. For example, if you define a function |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
372 @code{my-lisp-mode-initialization} intended to be called from |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
373 @code{emacs-lisp-mode-hook}, you might want to add that to the list of |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
374 options for @code{emacs-lisp-mode-hook}, but not by editing its |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
375 definition. You can do it thus: |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
376 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
377 @example |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
378 (custom-add-option 'emacs-lisp-mode-hook |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
379 'my-lisp-mode-initialization) |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
380 @end example |
21006 | 381 |
382 @defun custom-add-option symbol option | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
383 To the customization @var{symbol}, add @var{option}. |
21006 | 384 |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
385 The precise effect of adding @var{option} depends on the customization |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
386 type of @var{symbol}. |
21006 | 387 @end defun |
388 | |
389 Internally, @code{defcustom} uses the symbol property | |
390 @code{standard-value} to record the expression for the default value, | |
391 and @code{saved-value} to record the value saved by the user with the | |
64301
ce506ff1d861
(Variable Definitions): Add `custom-initialize-safe-set' and
Luc Teirlinck <teirllm@auburn.edu>
parents:
63583
diff
changeset
|
392 customization buffer. Both properties are actually lists whose car is |
ce506ff1d861
(Variable Definitions): Add `custom-initialize-safe-set' and
Luc Teirlinck <teirllm@auburn.edu>
parents:
63583
diff
changeset
|
393 an expression which evaluates to the value. |
21006 | 394 |
395 @node Customization Types | |
396 @section Customization Types | |
397 | |
398 When you define a user option with @code{defcustom}, you must specify | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
399 its @dfn{customization type}. That is a Lisp object which describes (1) |
21006 | 400 which values are legitimate and (2) how to display the value in the |
401 customization buffer for editing. | |
402 | |
403 You specify the customization type in @code{defcustom} with the | |
48404
cd3ad87f8d7a
Clarify evaluation of :type arg in defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
47783
diff
changeset
|
404 @code{:type} keyword. The argument of @code{:type} is evaluated, but |
cd3ad87f8d7a
Clarify evaluation of :type arg in defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
47783
diff
changeset
|
405 only once when the @code{defcustom} is executed, so it isn't useful |
cd3ad87f8d7a
Clarify evaluation of :type arg in defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
47783
diff
changeset
|
406 for the value to vary. Normally we use a quoted constant. For |
cd3ad87f8d7a
Clarify evaluation of :type arg in defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
47783
diff
changeset
|
407 example: |
21006 | 408 |
409 @example | |
410 (defcustom diff-command "diff" | |
411 "*The command to use to run diff." | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
412 :type '(string) |
21006 | 413 :group 'diff) |
414 @end example | |
415 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
416 In general, a customization type is a list whose first element is a |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
417 symbol, one of the customization type names defined in the following |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
418 sections. After this symbol come a number of arguments, depending on |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
419 the symbol. Between the type symbol and its arguments, you can |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
420 optionally write keyword-value pairs (@pxref{Type Keywords}). |
21006 | 421 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
422 Some of the type symbols do not use any arguments; those are called |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
423 @dfn{simple types}. For a simple type, if you do not use any |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
424 keyword-value pairs, you can omit the parentheses around the type |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
425 symbol. For example just @code{string} as a customization type is |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
426 equivalent to @code{(string)}. |
21006 | 427 |
428 @menu | |
429 * Simple Types:: | |
430 * Composite Types:: | |
431 * Splicing into Lists:: | |
432 * Type Keywords:: | |
53319
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
433 * Defining New Types:: |
21006 | 434 @end menu |
435 | |
40414
4d919b7986eb
(Customization Types): Add a reference to the Widget manual.
Eli Zaretskii <eliz@gnu.org>
parents:
35009
diff
changeset
|
436 All customization types are implemented as widgets; see @ref{Top, , |
50475
b65aa1d740eb
Fix cross references.
Juanma Barranquero <lekktu@gmail.com>
parents:
49600
diff
changeset
|
437 Introduction, widget, The Emacs Widget Library}, for details. |
40414
4d919b7986eb
(Customization Types): Add a reference to the Widget manual.
Eli Zaretskii <eliz@gnu.org>
parents:
35009
diff
changeset
|
438 |
21006 | 439 @node Simple Types |
440 @subsection Simple Types | |
441 | |
442 This section describes all the simple customization types. | |
443 | |
444 @table @code | |
445 @item sexp | |
446 The value may be any Lisp object that can be printed and read back. You | |
447 can use @code{sexp} as a fall-back for any option, if you don't want to | |
448 take the time to work out a more specific type to use. | |
449 | |
450 @item integer | |
451 The value must be an integer, and is represented textually | |
452 in the customization buffer. | |
453 | |
454 @item number | |
48711
7edccee41a2a
(Simple Types): Clarify decription of custom type 'number.
Markus Rost <rost@math.uni-bielefeld.de>
parents:
48585
diff
changeset
|
455 The value must be a number (floating point or integer), and is |
7edccee41a2a
(Simple Types): Clarify decription of custom type 'number.
Markus Rost <rost@math.uni-bielefeld.de>
parents:
48585
diff
changeset
|
456 represented textually in the customization buffer. |
7edccee41a2a
(Simple Types): Clarify decription of custom type 'number.
Markus Rost <rost@math.uni-bielefeld.de>
parents:
48585
diff
changeset
|
457 |
7edccee41a2a
(Simple Types): Clarify decription of custom type 'number.
Markus Rost <rost@math.uni-bielefeld.de>
parents:
48585
diff
changeset
|
458 @item float |
7edccee41a2a
(Simple Types): Clarify decription of custom type 'number.
Markus Rost <rost@math.uni-bielefeld.de>
parents:
48585
diff
changeset
|
459 The value must be a floating point number, and is represented |
7edccee41a2a
(Simple Types): Clarify decription of custom type 'number.
Markus Rost <rost@math.uni-bielefeld.de>
parents:
48585
diff
changeset
|
460 textually in the customization buffer. |
21006 | 461 |
462 @item string | |
463 The value must be a string, and the customization buffer shows just the | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
464 contents, with no delimiting @samp{"} characters and no quoting with |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
465 @samp{\}. |
21006 | 466 |
467 @item regexp | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
468 Like @code{string} except that the string must be a valid regular |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
469 expression. |
21006 | 470 |
471 @item character | |
472 The value must be a character code. A character code is actually an | |
473 integer, but this type shows the value by inserting the character in the | |
474 buffer, rather than by showing the number. | |
475 | |
476 @item file | |
477 The value must be a file name, and you can do completion with | |
478 @kbd{M-@key{TAB}}. | |
479 | |
480 @item (file :must-match t) | |
481 The value must be a file name for an existing file, and you can do | |
482 completion with @kbd{M-@key{TAB}}. | |
483 | |
484 @item directory | |
485 The value must be a directory name, and you can do completion with | |
486 @kbd{M-@key{TAB}}. | |
487 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
488 @item hook |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
489 The value must be a list of functions (or a single function, but that is |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
490 obsolete usage). This customization type is used for hook variables. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
491 You can use the @code{:options} keyword in a hook variable's |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
492 @code{defcustom} to specify a list of functions recommended for use in |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
493 the hook; see @ref{Variable Definitions}. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
494 |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
495 @item alist |
24952 | 496 The value must be a list of cons-cells, the @sc{car} of each cell |
497 representing a key, and the @sc{cdr} of the same cell representing an | |
498 associated value. The user can add and delete key/value pairs, and | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
499 edit both the key and the value of each pair. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
500 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
501 You can specify the key and value types like this: |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
502 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
503 @smallexample |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
504 (alist :key-type @var{key-type} :value-type @var{value-type}) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
505 @end smallexample |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
506 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
507 @noindent |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
508 where @var{key-type} and @var{value-type} are customization type |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
509 specifications. The default key type is @code{sexp}, and the default |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
510 value type is @code{sexp}. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
511 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
512 The user can add any key matching the specified key type, but you can |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
513 give some keys a preferential treatment by specifying them with the |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
514 @code{:options} (see @ref{Variable Definitions}). The specified keys |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
515 will always be shown in the customize buffer (together with a suitable |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
516 value), with a checkbox to include or exclude or disable the key/value |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
517 pair from the alist. The user will not be able to edit the keys |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
518 specified by the @code{:options} keyword argument. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
519 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
520 The argument to the @code{:options} keywords should be a list of option |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
521 specifications. Ordinarily, the options are simply atoms, which are the |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
522 specified keys. For example: |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
523 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
524 @smallexample |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
525 :options '("foo" "bar" "baz") |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
526 @end smallexample |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
527 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
528 @noindent |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
529 specifies that there are three ``known'' keys, namely @code{"foo"}, |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
530 @code{"bar"} and @code{"baz"}, which will always be shown first. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
531 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
532 You may want to restrict the value type for specific keys, for example, |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
533 the value associated with the @code{"bar"} key can only be an integer. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
534 You can specify this by using a list instead of an atom in the option |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
535 specification. The first element will specify the key, like before, |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
536 while the second element will specify the value type. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
537 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
538 @smallexample |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
539 :options '("foo" ("bar" integer) "baz") |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
540 @end smallexample |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
541 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
542 Finally, you may want to change how the key is presented. By default, |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
543 the key is simply shown as a @code{const}, since the user cannot change |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
544 the special keys specified with the @code{:options} keyword. However, |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
545 you may want to use a more specialized type for presenting the key, like |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
546 @code{function-item} if you know it is a symbol with a function binding. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
547 This is done by using a customization type specification instead of a |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
548 symbol for the key. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
549 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
550 @smallexample |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
551 :options '("foo" ((function-item some-function) integer) "baz") |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
552 @end smallexample |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
553 |
24952 | 554 Many alists use lists with two elements, instead of cons cells. For |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
555 example, |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
556 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
557 @smallexample |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
558 (defcustom list-alist '(("foo" 1) ("bar" 2) ("baz" 3)) |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
559 "Each element is a list of the form (KEY VALUE).") |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
560 @end smallexample |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
561 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
562 @noindent |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48711
diff
changeset
|
563 instead of |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
564 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
565 @smallexample |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
566 (defcustom cons-alist '(("foo" . 1) ("bar" . 2) ("baz" . 3)) |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
567 "Each element is a cons-cell (KEY . VALUE).") |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
568 @end smallexample |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
569 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
570 Because of the way lists are implemented on top of cons cells, you can |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
571 treat @code{list-alist} in the example above as a cons cell alist, where |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
572 the value type is a list with a single element containing the real |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
573 value. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
574 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
575 @smallexample |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
576 (defcustom list-alist '(("foo" 1) ("bar" 2) ("baz" 3)) |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
577 "Each element is a list of the form (KEY VALUE)." |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
578 :type '(alist :value-type (group integer))) |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
579 @end smallexample |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
580 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
581 The @code{group} widget is used here instead of @code{list} only because |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
582 the formatting is better suited for the purpose. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
583 |
58495
a30209899fa0
(Variable Definitions): Replace show-paren-mode example with tooltip-mode.
Richard M. Stallman <rms@gnu.org>
parents:
56235
diff
changeset
|
584 Similarly, you can have alists with more values associated with each |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
585 key, using variations of this trick: |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
586 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
587 @smallexample |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48711
diff
changeset
|
588 (defcustom person-data '(("brian" 50 t) |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
589 ("dorith" 55 nil) |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
590 ("ken" 52 t)) |
28398
844fb933c1aa
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
591 "Alist of basic info about people. |
844fb933c1aa
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
592 Each element has the form (NAME AGE MALE-FLAG)." |
58495
a30209899fa0
(Variable Definitions): Replace show-paren-mode example with tooltip-mode.
Richard M. Stallman <rms@gnu.org>
parents:
56235
diff
changeset
|
593 :type '(alist :value-type (group integer boolean))) |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
594 |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48711
diff
changeset
|
595 (defcustom pets '(("brian") |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
596 ("dorith" "dog" "guppy") |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
597 ("ken" "cat")) |
28398
844fb933c1aa
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
598 "Alist of people's pets. |
844fb933c1aa
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
599 In an element (KEY . VALUE), KEY is the person's name, |
844fb933c1aa
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
600 and the VALUE is a list of that person's pets." |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
601 :type '(alist :value-type (repeat string))) |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
602 @end smallexample |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
603 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
604 @item plist |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
605 The @code{plist} custom type is similar to the @code{alist} (see above), |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
606 except that the information is stored as a property list, i.e. a list of |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
607 this form: |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
608 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
609 @smallexample |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
610 (@var{key} @var{value} @var{key} @var{value} @var{key} @var{value} @dots{}) |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
611 @end smallexample |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
612 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
613 The default @code{:key-type} for @code{plist} is @code{symbol}, |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
614 rather than @code{sexp}. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23902
diff
changeset
|
615 |
21006 | 616 @item symbol |
617 The value must be a symbol. It appears in the customization buffer as | |
618 the name of the symbol. | |
619 | |
620 @item function | |
621 The value must be either a lambda expression or a function name. When | |
622 it is a function name, you can do completion with @kbd{M-@key{TAB}}. | |
623 | |
624 @item variable | |
625 The value must be a variable name, and you can do completion with | |
626 @kbd{M-@key{TAB}}. | |
627 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
628 @item face |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
629 The value must be a symbol which is a face name, and you can do |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
630 completion with @kbd{M-@key{TAB}}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
631 |
21006 | 632 @item boolean |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
633 The value is boolean---either @code{nil} or @code{t}. Note that by |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
634 using @code{choice} and @code{const} together (see the next section), |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
635 you can specify that the value must be @code{nil} or @code{t}, but also |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
636 specify the text to describe each value in a way that fits the specific |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
637 meaning of the alternative. |
32521
bfbe1fcac416
custom types emacs-commentary-link, coding-system, color
Dave Love <fx@gnu.org>
parents:
30904
diff
changeset
|
638 |
bfbe1fcac416
custom types emacs-commentary-link, coding-system, color
Dave Love <fx@gnu.org>
parents:
30904
diff
changeset
|
639 @item coding-system |
bfbe1fcac416
custom types emacs-commentary-link, coding-system, color
Dave Love <fx@gnu.org>
parents:
30904
diff
changeset
|
640 The value must be a coding-system name, and you can do completion with |
bfbe1fcac416
custom types emacs-commentary-link, coding-system, color
Dave Love <fx@gnu.org>
parents:
30904
diff
changeset
|
641 @kbd{M-@key{TAB}}. |
bfbe1fcac416
custom types emacs-commentary-link, coding-system, color
Dave Love <fx@gnu.org>
parents:
30904
diff
changeset
|
642 |
bfbe1fcac416
custom types emacs-commentary-link, coding-system, color
Dave Love <fx@gnu.org>
parents:
30904
diff
changeset
|
643 @item color |
bfbe1fcac416
custom types emacs-commentary-link, coding-system, color
Dave Love <fx@gnu.org>
parents:
30904
diff
changeset
|
644 The value must be a valid color name, and you can do completion with |
54299 | 645 @kbd{M-@key{TAB}}. A sample is provided. |
21006 | 646 @end table |
647 | |
648 @node Composite Types | |
649 @subsection Composite Types | |
46643
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
650 @cindex arguments (of composite type) |
21006 | 651 |
652 When none of the simple types is appropriate, you can use composite | |
46643
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
653 types, which build new types from other types or from specified data. |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
654 The specified types or data are called the @dfn{arguments} of the |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
655 composite type. The composite type normally looks like this: |
21006 | 656 |
657 @example | |
46643
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
658 (@var{constructor} @var{arguments}@dots{}) |
21006 | 659 @end example |
660 | |
661 @noindent | |
46643
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
662 but you can also add keyword-value pairs before the arguments, like |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
663 this: |
21006 | 664 |
46643
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
665 @example |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
666 (@var{constructor} @r{@{}@var{keyword} @var{value}@r{@}}@dots{} @var{arguments}@dots{}) |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
667 @end example |
21006 | 668 |
46643
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
669 Here is a table of constructors and how to use them to write |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
670 composite types: |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
671 |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
672 @table @code |
21006 | 673 @item (cons @var{car-type} @var{cdr-type}) |
674 The value must be a cons cell, its @sc{car} must fit @var{car-type}, and | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
675 its @sc{cdr} must fit @var{cdr-type}. For example, @code{(cons string |
21006 | 676 symbol)} is a customization type which matches values such as |
677 @code{("foo" . foo)}. | |
678 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
679 In the customization buffer, the @sc{car} and the @sc{cdr} are |
21006 | 680 displayed and edited separately, each according to the type |
681 that you specify for it. | |
682 | |
683 @item (list @var{element-types}@dots{}) | |
684 The value must be a list with exactly as many elements as the | |
685 @var{element-types} you have specified; and each element must fit the | |
686 corresponding @var{element-type}. | |
687 | |
688 For example, @code{(list integer string function)} describes a list of | |
689 three elements; the first element must be an integer, the second a | |
690 string, and the third a function. | |
691 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
692 In the customization buffer, each element is displayed and edited |
21006 | 693 separately, according to the type specified for it. |
694 | |
695 @item (vector @var{element-types}@dots{}) | |
696 Like @code{list} except that the value must be a vector instead of a | |
697 list. The elements work the same as in @code{list}. | |
698 | |
35009
d80f2bfd0e05
Add `radio' type. User variable doc strings and backquote in
Dave Love <fx@gnu.org>
parents:
33150
diff
changeset
|
699 @item (choice @var{alternative-types}@dots{}) |
21006 | 700 The value must fit at least one of @var{alternative-types}. |
701 For example, @code{(choice integer string)} allows either an | |
702 integer or a string. | |
703 | |
704 In the customization buffer, the user selects one of the alternatives | |
705 using a menu, and can then edit the value in the usual way for that | |
706 alternative. | |
707 | |
708 Normally the strings in this menu are determined automatically from the | |
709 choices; however, you can specify different strings for the menu by | |
710 including the @code{:tag} keyword in the alternatives. For example, if | |
711 an integer stands for a number of spaces, while a string is text to use | |
712 verbatim, you might write the customization type this way, | |
713 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
714 @example |
21006 | 715 (choice (integer :tag "Number of spaces") |
716 (string :tag "Literal text")) | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
717 @end example |
21006 | 718 |
719 @noindent | |
58495
a30209899fa0
(Variable Definitions): Replace show-paren-mode example with tooltip-mode.
Richard M. Stallman <rms@gnu.org>
parents:
56235
diff
changeset
|
720 so that the menu offers @samp{Number of spaces} and @samp{Literal text}. |
21006 | 721 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
722 In any alternative for which @code{nil} is not a valid value, other than |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
723 a @code{const}, you should specify a valid default for that alternative |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
724 using the @code{:value} keyword. @xref{Type Keywords}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
725 |
48585
be738e9c1a09
Explain about ordering of alternatives in `choice'.
Richard M. Stallman <rms@gnu.org>
parents:
48404
diff
changeset
|
726 If some values are covered by more than one of the alternatives, |
be738e9c1a09
Explain about ordering of alternatives in `choice'.
Richard M. Stallman <rms@gnu.org>
parents:
48404
diff
changeset
|
727 customize will choose the first alternative that the value fits. This |
be738e9c1a09
Explain about ordering of alternatives in `choice'.
Richard M. Stallman <rms@gnu.org>
parents:
48404
diff
changeset
|
728 means you should always list the most specific types first, and the |
be738e9c1a09
Explain about ordering of alternatives in `choice'.
Richard M. Stallman <rms@gnu.org>
parents:
48404
diff
changeset
|
729 most general last. Here's an example of proper usage: |
be738e9c1a09
Explain about ordering of alternatives in `choice'.
Richard M. Stallman <rms@gnu.org>
parents:
48404
diff
changeset
|
730 |
be738e9c1a09
Explain about ordering of alternatives in `choice'.
Richard M. Stallman <rms@gnu.org>
parents:
48404
diff
changeset
|
731 @example |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
62246
diff
changeset
|
732 (choice (const :tag "Off" nil) |
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
62246
diff
changeset
|
733 symbol (sexp :tag "Other")) |
48585
be738e9c1a09
Explain about ordering of alternatives in `choice'.
Richard M. Stallman <rms@gnu.org>
parents:
48404
diff
changeset
|
734 @end example |
be738e9c1a09
Explain about ordering of alternatives in `choice'.
Richard M. Stallman <rms@gnu.org>
parents:
48404
diff
changeset
|
735 |
be738e9c1a09
Explain about ordering of alternatives in `choice'.
Richard M. Stallman <rms@gnu.org>
parents:
48404
diff
changeset
|
736 @noindent |
be738e9c1a09
Explain about ordering of alternatives in `choice'.
Richard M. Stallman <rms@gnu.org>
parents:
48404
diff
changeset
|
737 This way, the special value @code{nil} is not treated like other |
be738e9c1a09
Explain about ordering of alternatives in `choice'.
Richard M. Stallman <rms@gnu.org>
parents:
48404
diff
changeset
|
738 symbols, and symbols are not treated like other Lisp expressions. |
be738e9c1a09
Explain about ordering of alternatives in `choice'.
Richard M. Stallman <rms@gnu.org>
parents:
48404
diff
changeset
|
739 |
35009
d80f2bfd0e05
Add `radio' type. User variable doc strings and backquote in
Dave Love <fx@gnu.org>
parents:
33150
diff
changeset
|
740 @item (radio @var{element-types}@dots{}) |
d80f2bfd0e05
Add `radio' type. User variable doc strings and backquote in
Dave Love <fx@gnu.org>
parents:
33150
diff
changeset
|
741 This is similar to @code{choice}, except that the choices are displayed |
d80f2bfd0e05
Add `radio' type. User variable doc strings and backquote in
Dave Love <fx@gnu.org>
parents:
33150
diff
changeset
|
742 using `radio buttons' rather than a menu. This has the advantage of |
d80f2bfd0e05
Add `radio' type. User variable doc strings and backquote in
Dave Love <fx@gnu.org>
parents:
33150
diff
changeset
|
743 displaying documentation for the choices when applicable and so is often |
d80f2bfd0e05
Add `radio' type. User variable doc strings and backquote in
Dave Love <fx@gnu.org>
parents:
33150
diff
changeset
|
744 a good choice for a choice between constant functions |
d80f2bfd0e05
Add `radio' type. User variable doc strings and backquote in
Dave Love <fx@gnu.org>
parents:
33150
diff
changeset
|
745 (@code{function-item} customization types). |
d80f2bfd0e05
Add `radio' type. User variable doc strings and backquote in
Dave Love <fx@gnu.org>
parents:
33150
diff
changeset
|
746 |
21006 | 747 @item (const @var{value}) |
748 The value must be @var{value}---nothing else is allowed. | |
749 | |
750 The main use of @code{const} is inside of @code{choice}. For example, | |
751 @code{(choice integer (const nil))} allows either an integer or | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
752 @code{nil}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
753 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
754 @code{:tag} is often used with @code{const}, inside of @code{choice}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
755 For example, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
756 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
757 @example |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
758 (choice (const :tag "Yes" t) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
759 (const :tag "No" nil) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
760 (const :tag "Ask" foo)) |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
761 @end example |
21006 | 762 |
22433
a9820c4e8c9e
Describe widget type `other'.
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
763 @noindent |
a9820c4e8c9e
Describe widget type `other'.
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
764 describes a variable for which @code{t} means yes, @code{nil} means no, |
a9820c4e8c9e
Describe widget type `other'.
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
765 and @code{foo} means ``ask.'' |
a9820c4e8c9e
Describe widget type `other'.
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
766 |
a9820c4e8c9e
Describe widget type `other'.
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
767 @item (other @var{value}) |
a9820c4e8c9e
Describe widget type `other'.
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
768 This alternative can match any Lisp value, but if the user chooses this |
a9820c4e8c9e
Describe widget type `other'.
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
769 alternative, that selects the value @var{value}. |
a9820c4e8c9e
Describe widget type `other'.
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
770 |
a9820c4e8c9e
Describe widget type `other'.
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
771 The main use of @code{other} is as the last element of @code{choice}. |
a9820c4e8c9e
Describe widget type `other'.
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
772 For example, |
a9820c4e8c9e
Describe widget type `other'.
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
773 |
a9820c4e8c9e
Describe widget type `other'.
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
774 @example |
a9820c4e8c9e
Describe widget type `other'.
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
775 (choice (const :tag "Yes" t) |
a9820c4e8c9e
Describe widget type `other'.
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
776 (const :tag "No" nil) |
a9820c4e8c9e
Describe widget type `other'.
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
777 (other :tag "Ask" foo)) |
a9820c4e8c9e
Describe widget type `other'.
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
778 @end example |
a9820c4e8c9e
Describe widget type `other'.
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
779 |
a9820c4e8c9e
Describe widget type `other'.
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
780 @noindent |
a9820c4e8c9e
Describe widget type `other'.
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
781 describes a variable for which @code{t} means yes, @code{nil} means no, |
a9820c4e8c9e
Describe widget type `other'.
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
782 and anything else means ``ask.'' If the user chooses @samp{Ask} from |
a9820c4e8c9e
Describe widget type `other'.
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
783 the menu of alternatives, that specifies the value @code{foo}; but any |
a9820c4e8c9e
Describe widget type `other'.
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
784 other value (not @code{t}, @code{nil} or @code{foo}) displays as |
a9820c4e8c9e
Describe widget type `other'.
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
785 @samp{Ask}, just like @code{foo}. |
a9820c4e8c9e
Describe widget type `other'.
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
786 |
21006 | 787 @item (function-item @var{function}) |
788 Like @code{const}, but used for values which are functions. This | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
789 displays the documentation string as well as the function name. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
790 The documentation string is either the one you specify with |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
791 @code{:doc}, or @var{function}'s own documentation string. |
21006 | 792 |
793 @item (variable-item @var{variable}) | |
794 Like @code{const}, but used for values which are variable names. This | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
795 displays the documentation string as well as the variable name. The |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
796 documentation string is either the one you specify with @code{:doc}, or |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
797 @var{variable}'s own documentation string. |
21006 | 798 |
23902 | 799 @item (set @var{types}@dots{}) |
800 The value must be a list, and each element of the list must match one of | |
801 the @var{types} specified. | |
802 | |
803 This appears in the customization buffer as a checklist, so that each of | |
804 @var{types} may have either one corresponding element or none. It is | |
805 not possible to specify two different elements that match the same one | |
806 of @var{types}. For example, @code{(set integer symbol)} allows one | |
807 integer and/or one symbol in the list; it does not allow multiple | |
808 integers or multiple symbols. As a result, it is rare to use | |
809 nonspecific types such as @code{integer} in a @code{set}. | |
810 | |
811 Most often, the @var{types} in a @code{set} are @code{const} types, as | |
812 shown here: | |
813 | |
814 @example | |
815 (set (const :bold) (const :italic)) | |
816 @end example | |
817 | |
818 Sometimes they describe possible elements in an alist: | |
819 | |
820 @example | |
821 (set (cons :tag "Height" (const height) integer) | |
822 (cons :tag "Width" (const width) integer)) | |
823 @end example | |
824 | |
825 @noindent | |
826 That lets the user specify a height value optionally | |
827 and a width value optionally. | |
21006 | 828 |
829 @item (repeat @var{element-type}) | |
830 The value must be a list and each element of the list must fit the type | |
831 @var{element-type}. This appears in the customization buffer as a | |
832 list of elements, with @samp{[INS]} and @samp{[DEL]} buttons for adding | |
833 more elements or removing elements. | |
46643
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
834 |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
835 @item (restricted-sexp :match-alternatives @var{criteria}) |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
836 This is the most general composite type construct. The value may be |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
837 any Lisp object that satisfies one of @var{criteria}. @var{criteria} |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
838 should be a list, and each element should be one of these |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
839 possibilities: |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
840 |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
841 @itemize @bullet |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
842 @item |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
843 A predicate---that is, a function of one argument that has no side |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
844 effects, and returns either @code{nil} or non-@code{nil} according to |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
845 the argument. Using a predicate in the list says that objects for which |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
846 the predicate returns non-@code{nil} are acceptable. |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
847 |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
848 @item |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
849 A quoted constant---that is, @code{'@var{object}}. This sort of element |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
850 in the list says that @var{object} itself is an acceptable value. |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
851 @end itemize |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
852 |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
853 For example, |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
854 |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
855 @example |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
856 (restricted-sexp :match-alternatives |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
857 (integerp 't 'nil)) |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
858 @end example |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
859 |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
860 @noindent |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
861 allows integers, @code{t} and @code{nil} as legitimate values. |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
862 |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
863 The customization buffer shows all legitimate values using their read |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
864 syntax, and the user edits them textually. |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
865 @end table |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
866 |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
867 Here is a table of the keywords you can use in keyword-value pairs |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
868 in a composite type: |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
869 |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
870 @table @code |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
871 @item :tag @var{tag} |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
872 Use @var{tag} as the name of this alternative, for user communication |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
873 purposes. This is useful for a type that appears inside of a |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
874 @code{choice}. |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
875 |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
876 @item :match-alternatives @var{criteria} |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
877 Use @var{criteria} to match possible values. This is used only in |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
878 @code{restricted-sexp}. |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
879 |
58495
a30209899fa0
(Variable Definitions): Replace show-paren-mode example with tooltip-mode.
Richard M. Stallman <rms@gnu.org>
parents:
56235
diff
changeset
|
880 @item :args @var{argument-list} |
a30209899fa0
(Variable Definitions): Replace show-paren-mode example with tooltip-mode.
Richard M. Stallman <rms@gnu.org>
parents:
56235
diff
changeset
|
881 Use the elements of @var{argument-list} as the arguments of the type |
46643
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
882 construct. For instance, @code{(const :args (foo))} is equivalent to |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
883 @code{(const foo)}. You rarely need to write @code{:args} explicitly, |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
884 because normally the arguments are recognized automatically as |
7715f3004d93
(Composite Types): Explain what arguments are. Show what keyword-value
Richard M. Stallman <rms@gnu.org>
parents:
44142
diff
changeset
|
885 whatever follows the last keyword-value pair. |
21006 | 886 @end table |
887 | |
888 @node Splicing into Lists | |
889 @subsection Splicing into Lists | |
890 | |
891 The @code{:inline} feature lets you splice a variable number of | |
892 elements into the middle of a list or vector. You use it in a | |
893 @code{set}, @code{choice} or @code{repeat} type which appears among the | |
894 element-types of a @code{list} or @code{vector}. | |
895 | |
896 Normally, each of the element-types in a @code{list} or @code{vector} | |
897 describes one and only one element of the list or vector. Thus, if an | |
898 element-type is a @code{repeat}, that specifies a list of unspecified | |
899 length which appears as one element. | |
900 | |
901 But when the element-type uses @code{:inline}, the value it matches is | |
902 merged directly into the containing sequence. For example, if it | |
903 matches a list with three elements, those become three elements of the | |
904 overall sequence. This is analogous to using @samp{,@@} in the backquote | |
905 construct. | |
906 | |
46809
a7c081b4fc3c
2002-08-05 Per Abrahamsen <abraham@dina.kvl.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
46643
diff
changeset
|
907 For example, to specify a list whose first element must be @code{baz} |
21006 | 908 and whose remaining arguments should be zero or more of @code{foo} and |
909 @code{bar}, use this customization type: | |
910 | |
911 @example | |
46809
a7c081b4fc3c
2002-08-05 Per Abrahamsen <abraham@dina.kvl.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
46643
diff
changeset
|
912 (list (const baz) (set :inline t (const foo) (const bar))) |
21006 | 913 @end example |
914 | |
915 @noindent | |
46809
a7c081b4fc3c
2002-08-05 Per Abrahamsen <abraham@dina.kvl.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
46643
diff
changeset
|
916 This matches values such as @code{(baz)}, @code{(baz foo)}, @code{(baz bar)} |
a7c081b4fc3c
2002-08-05 Per Abrahamsen <abraham@dina.kvl.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
46643
diff
changeset
|
917 and @code{(baz foo bar)}. |
21006 | 918 |
919 When the element-type is a @code{choice}, you use @code{:inline} not | |
920 in the @code{choice} itself, but in (some of) the alternatives of the | |
921 @code{choice}. For example, to match a list which must start with a | |
922 file name, followed either by the symbol @code{t} or two strings, use | |
923 this customization type: | |
924 | |
925 @example | |
926 (list file | |
927 (choice (const t) | |
928 (list :inline t string string))) | |
929 @end example | |
930 | |
931 @noindent | |
932 If the user chooses the first alternative in the choice, then the | |
933 overall list has two elements and the second element is @code{t}. If | |
934 the user chooses the second alternative, then the overall list has three | |
935 elements and the second and third must be strings. | |
936 | |
937 @node Type Keywords | |
938 @subsection Type Keywords | |
939 | |
940 You can specify keyword-argument pairs in a customization type after the | |
941 type name symbol. Here are the keywords you can use, and their | |
942 meanings: | |
943 | |
944 @table @code | |
945 @item :value @var{default} | |
946 This is used for a type that appears as an alternative inside of | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
947 @code{choice}; it specifies the default value to use, at first, if and |
21006 | 948 when the user selects this alternative with the menu in the |
949 customization buffer. | |
950 | |
951 Of course, if the actual value of the option fits this alternative, it | |
952 will appear showing the actual value, not @var{default}. | |
953 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
954 If @code{nil} is not a valid value for the alternative, then it is |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
955 essential to specify a valid default with @code{:value}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
956 |
21006 | 957 @item :format @var{format-string} |
958 This string will be inserted in the buffer to represent the value | |
959 corresponding to the type. The following @samp{%} escapes are available | |
960 for use in @var{format-string}: | |
961 | |
962 @table @samp | |
963 @item %[@var{button}%] | |
964 Display the text @var{button} marked as a button. The @code{:action} | |
965 attribute specifies what the button will do if the user invokes it; | |
966 its value is a function which takes two arguments---the widget which | |
967 the button appears in, and the event. | |
968 | |
969 There is no way to specify two different buttons with different | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
970 actions. |
21006 | 971 |
972 @item %@{@var{sample}%@} | |
973 Show @var{sample} in a special face specified by @code{:sample-face}. | |
974 | |
975 @item %v | |
976 Substitute the item's value. How the value is represented depends on | |
977 the kind of item, and (for variables) on the customization type. | |
978 | |
979 @item %d | |
980 Substitute the item's documentation string. | |
981 | |
982 @item %h | |
983 Like @samp{%d}, but if the documentation string is more than one line, | |
984 add an active field to control whether to show all of it or just the | |
985 first line. | |
986 | |
987 @item %t | |
988 Substitute the tag here. You specify the tag with the @code{:tag} | |
989 keyword. | |
990 | |
991 @item %% | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48711
diff
changeset
|
992 Display a literal @samp{%}. |
21006 | 993 @end table |
994 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
995 @item :action @var{action} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
996 Perform @var{action} if the user clicks on a button. |
21006 | 997 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
998 @item :button-face @var{face} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
999 Use the face @var{face} (a face name or a list of face names) for button |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1000 text displayed with @samp{%[@dots{}%]}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1001 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1002 @item :button-prefix @var{prefix} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1003 @itemx :button-suffix @var{suffix} |
21006 | 1004 These specify the text to display before and after a button. |
1005 Each can be: | |
1006 | |
1007 @table @asis | |
1008 @item @code{nil} | |
1009 No text is inserted. | |
1010 | |
1011 @item a string | |
1012 The string is inserted literally. | |
1013 | |
1014 @item a symbol | |
1015 The symbol's value is used. | |
1016 @end table | |
1017 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1018 @item :tag @var{tag} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1019 Use @var{tag} (a string) as the tag for the value (or part of the value) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1020 that corresponds to this type. |
21006 | 1021 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1022 @item :doc @var{doc} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1023 Use @var{doc} as the documentation string for this value (or part of the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1024 value) that corresponds to this type. In order for this to work, you |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1025 must specify a value for @code{:format}, and use @samp{%d} or @samp{%h} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1026 in that value. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1027 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1028 The usual reason to specify a documentation string for a type is to |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1029 provide more information about the meanings of alternatives inside a |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1030 @code{:choice} type or the parts of some other composite type. |
21006 | 1031 |
1032 @item :help-echo @var{motion-doc} | |
1033 When you move to this item with @code{widget-forward} or | |
30500 | 1034 @code{widget-backward}, it will display the string @var{motion-doc} in |
1035 the echo area. In addition, @var{motion-doc} is used as the mouse | |
1036 @code{help-echo} string and may actually be a function or form evaluated | |
52267
248944d84147
(Type Keywords): Correct the description of `:help-echo' in the case
Luc Teirlinck <teirllm@auburn.edu>
parents:
50475
diff
changeset
|
1037 to yield a help string. If it is a function, it is called with one |
248944d84147
(Type Keywords): Correct the description of `:help-echo' in the case
Luc Teirlinck <teirllm@auburn.edu>
parents:
50475
diff
changeset
|
1038 argument, the widget. |
21006 | 1039 |
1040 @item :match @var{function} | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1041 Specify how to decide whether a value matches the type. The |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1042 corresponding value, @var{function}, should be a function that accepts |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1043 two arguments, a widget and a value; it should return non-@code{nil} if |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1044 the value is acceptable. |
21006 | 1045 |
1046 @ignore | |
1047 @item :indent @var{columns} | |
1048 Indent this item by @var{columns} columns. The indentation is used for | |
1049 @samp{%n}, and automatically for group names, for checklists and radio | |
1050 buttons, and for editable lists. It affects the whole of the | |
1051 item except for the first line. | |
1052 | |
1053 @item :offset @var{columns} | |
1054 An integer indicating how many extra spaces to indent the subitems of | |
1055 this item. By default, subitems are indented the same as their parent. | |
1056 | |
1057 @item :extra-offset | |
1058 An integer indicating how many extra spaces to add to this item's | |
1059 indentation, compared to its parent. | |
1060 | |
1061 @item :notify | |
1062 A function called each time the item or a subitem is changed. The | |
1063 function is called with two or three arguments. The first argument is | |
1064 the item itself, the second argument is the item that was changed, and | |
1065 the third argument is the event leading to the change, if any. | |
1066 | |
1067 @item :menu-tag | |
44142
ad5105ded8ed
(Type Keywords): Minor corrections and cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
43477
diff
changeset
|
1068 A tag used in the menu when the widget is used as an option in a |
21006 | 1069 @code{menu-choice} widget. |
1070 | |
1071 @item :menu-tag-get | |
44142
ad5105ded8ed
(Type Keywords): Minor corrections and cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
43477
diff
changeset
|
1072 A function used for finding the tag when the widget is used as an option |
21006 | 1073 in a @code{menu-choice} widget. By default, the tag used will be either the |
1074 @code{:menu-tag} or @code{:tag} property if present, or the @code{princ} | |
1075 representation of the @code{:value} property if not. | |
1076 | |
1077 @item :validate | |
44142
ad5105ded8ed
(Type Keywords): Minor corrections and cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
43477
diff
changeset
|
1078 A function which takes a widget as an argument, and return @code{nil} |
ad5105ded8ed
(Type Keywords): Minor corrections and cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
43477
diff
changeset
|
1079 if the widget's current value is valid for the widget. Otherwise, it |
ad5105ded8ed
(Type Keywords): Minor corrections and cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
43477
diff
changeset
|
1080 should return the widget containing the invalid data, and set that |
ad5105ded8ed
(Type Keywords): Minor corrections and cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
43477
diff
changeset
|
1081 widget's @code{:error} property to a string explaining the error. |
21006 | 1082 |
1083 You can use the function @code{widget-children-validate} for this job; | |
1084 it tests that all children of @var{widget} are valid. | |
1085 | |
1086 @item :tab-order | |
1087 Specify the order in which widgets are traversed with | |
1088 @code{widget-forward} or @code{widget-backward}. This is only partially | |
1089 implemented. | |
1090 | |
1091 @enumerate a | |
1092 @item | |
1093 Widgets with tabbing order @code{-1} are ignored. | |
1094 | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48711
diff
changeset
|
1095 @item |
21006 | 1096 (Unimplemented) When on a widget with tabbing order @var{n}, go to the |
1097 next widget in the buffer with tabbing order @var{n+1} or @code{nil}, | |
1098 whichever comes first. | |
1099 | |
1100 @item | |
1101 When on a widget with no tabbing order specified, go to the next widget | |
1102 in the buffer with a positive tabbing order, or @code{nil} | |
1103 @end enumerate | |
1104 | |
1105 @item :parent | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1106 The parent of a nested widget (e.g., a @code{menu-choice} item or an |
21006 | 1107 element of a @code{editable-list} widget). |
1108 | |
1109 @item :sibling-args | |
1110 This keyword is only used for members of a @code{radio-button-choice} or | |
1111 @code{checklist}. The value should be a list of extra keyword | |
1112 arguments, which will be used when creating the @code{radio-button} or | |
1113 @code{checkbox} associated with this item. | |
1114 @end ignore | |
1115 @end table | |
52401 | 1116 |
53319
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1117 @node Defining New Types |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1118 @subsection Defining New Types |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1119 |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1120 In the previous sections we have described how to construct elaborate |
58495
a30209899fa0
(Variable Definitions): Replace show-paren-mode example with tooltip-mode.
Richard M. Stallman <rms@gnu.org>
parents:
56235
diff
changeset
|
1121 type specifications for @code{defcustom}. In some cases you may want |
a30209899fa0
(Variable Definitions): Replace show-paren-mode example with tooltip-mode.
Richard M. Stallman <rms@gnu.org>
parents:
56235
diff
changeset
|
1122 to give such a type specification a name. The obvious case is when |
a30209899fa0
(Variable Definitions): Replace show-paren-mode example with tooltip-mode.
Richard M. Stallman <rms@gnu.org>
parents:
56235
diff
changeset
|
1123 you are using the same type for many user options: rather than repeat |
a30209899fa0
(Variable Definitions): Replace show-paren-mode example with tooltip-mode.
Richard M. Stallman <rms@gnu.org>
parents:
56235
diff
changeset
|
1124 the specification for each option, you can give the type specification |
a30209899fa0
(Variable Definitions): Replace show-paren-mode example with tooltip-mode.
Richard M. Stallman <rms@gnu.org>
parents:
56235
diff
changeset
|
1125 a name, and use that name each @code{defcustom}. The other case is |
a30209899fa0
(Variable Definitions): Replace show-paren-mode example with tooltip-mode.
Richard M. Stallman <rms@gnu.org>
parents:
56235
diff
changeset
|
1126 when a user option's value is a recursive data structure. To make it |
53319
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1127 possible for a datatype to refer to itself, it needs to have a name. |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1128 |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1129 Since custom types are implemented as widgets, the way to define a new |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1130 customize type is to define a new widget. We are not going to describe |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1131 the widget interface here in details, see @ref{Top, , Introduction, |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1132 widget, The Emacs Widget Library}, for that. Instead we are going to |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1133 demonstrate the minimal functionality needed for defining new customize |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1134 types by a simple example. |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1135 |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1136 @example |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1137 (define-widget 'binary-tree-of-string 'lazy |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1138 "A binary tree made of cons-cells and strings." |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1139 :offset 4 |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1140 :tag "Node" |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1141 :type '(choice (string :tag "Leaf" :value "") |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1142 (cons :tag "Interior" |
54299 | 1143 :value ("" . "") |
53319
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1144 binary-tree-of-string |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1145 binary-tree-of-string))) |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1146 |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1147 (defcustom foo-bar "" |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1148 "Sample variable holding a binary tree of strings." |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1149 :type 'binary-tree-of-string) |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1150 @end example |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1151 |
58495
a30209899fa0
(Variable Definitions): Replace show-paren-mode example with tooltip-mode.
Richard M. Stallman <rms@gnu.org>
parents:
56235
diff
changeset
|
1152 The function to define a new widget is called @code{define-widget}. The |
53319
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1153 first argument is the symbol we want to make a new widget type. The |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1154 second argument is a symbol representing an existing widget, the new |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1155 widget is going to be defined in terms of difference from the existing |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1156 widget. For the purpose of defining new customization types, the |
58495
a30209899fa0
(Variable Definitions): Replace show-paren-mode example with tooltip-mode.
Richard M. Stallman <rms@gnu.org>
parents:
56235
diff
changeset
|
1157 @code{lazy} widget is perfect, because it accepts a @code{:type} keyword |
53319
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1158 argument with the same syntax as the keyword argument to |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1159 @code{defcustom} with the same name. The third argument is a |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1160 documentation string for the new widget. You will be able to see that |
64301
ce506ff1d861
(Variable Definitions): Add `custom-initialize-safe-set' and
Luc Teirlinck <teirllm@auburn.edu>
parents:
63583
diff
changeset
|
1161 string with the @kbd{M-x widget-browse @key{RET} binary-tree-of-string |
ce506ff1d861
(Variable Definitions): Add `custom-initialize-safe-set' and
Luc Teirlinck <teirllm@auburn.edu>
parents:
63583
diff
changeset
|
1162 @key{RET}} command. |
53319
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1163 |
58495
a30209899fa0
(Variable Definitions): Replace show-paren-mode example with tooltip-mode.
Richard M. Stallman <rms@gnu.org>
parents:
56235
diff
changeset
|
1164 After these mandatory arguments follow the keyword arguments. The most |
a30209899fa0
(Variable Definitions): Replace show-paren-mode example with tooltip-mode.
Richard M. Stallman <rms@gnu.org>
parents:
56235
diff
changeset
|
1165 important is @code{:type}, which describes the data type we want to match |
53319
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1166 with this widget. Here a @code{binary-tree-of-string} is described as |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1167 being either a string, or a cons-cell whose car and cdr are themselves |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1168 both @code{binary-tree-of-string}. Note the reference to the widget |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1169 type we are currently in the process of defining. The @code{:tag} |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1170 attribute is a string to name the widget in the user interface, and the |
58495
a30209899fa0
(Variable Definitions): Replace show-paren-mode example with tooltip-mode.
Richard M. Stallman <rms@gnu.org>
parents:
56235
diff
changeset
|
1171 @code{:offset} argument is there to ensure that child nodes are |
a30209899fa0
(Variable Definitions): Replace show-paren-mode example with tooltip-mode.
Richard M. Stallman <rms@gnu.org>
parents:
56235
diff
changeset
|
1172 indented four spaces relative to the parent node, making the tree |
53319
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1173 structure apparent in the customization buffer. |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1174 |
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1175 The @code{defcustom} shows how the new widget can be used as an ordinary |
54299 | 1176 customization type. |
53319
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1177 |
58495
a30209899fa0
(Variable Definitions): Replace show-paren-mode example with tooltip-mode.
Richard M. Stallman <rms@gnu.org>
parents:
56235
diff
changeset
|
1178 The reason for the name @code{lazy} is that the other composite |
a30209899fa0
(Variable Definitions): Replace show-paren-mode example with tooltip-mode.
Richard M. Stallman <rms@gnu.org>
parents:
56235
diff
changeset
|
1179 widgets convert their inferior widgets to internal form when the |
a30209899fa0
(Variable Definitions): Replace show-paren-mode example with tooltip-mode.
Richard M. Stallman <rms@gnu.org>
parents:
56235
diff
changeset
|
1180 widget is instantiated in a buffer. This conversion is recursive, so |
a30209899fa0
(Variable Definitions): Replace show-paren-mode example with tooltip-mode.
Richard M. Stallman <rms@gnu.org>
parents:
56235
diff
changeset
|
1181 the inferior widgets will convert @emph{their} inferior widgets. If |
a30209899fa0
(Variable Definitions): Replace show-paren-mode example with tooltip-mode.
Richard M. Stallman <rms@gnu.org>
parents:
56235
diff
changeset
|
1182 the data structure is itself recursive, this conversion is an infinite |
a30209899fa0
(Variable Definitions): Replace show-paren-mode example with tooltip-mode.
Richard M. Stallman <rms@gnu.org>
parents:
56235
diff
changeset
|
1183 recursion. The @code{lazy} widget prevents the recursion: it convert |
a30209899fa0
(Variable Definitions): Replace show-paren-mode example with tooltip-mode.
Richard M. Stallman <rms@gnu.org>
parents:
56235
diff
changeset
|
1184 its @code{:type} argument only when needed. |
53319
36b31fc002f2
2003-12-12 Jesper Harder <harder@ifa.au.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
52978
diff
changeset
|
1185 |
52401 | 1186 @ignore |
1187 arch-tag: d1b8fad3-f48c-4ce4-a402-f73b5ef19bd2 | |
1188 @end ignore |