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