summaryrefslogtreecommitdiff
path: root/devdocs/elisp/simple-types.html
diff options
context:
space:
mode:
authorCraig Jennings <c@cjennings.net>2024-04-07 13:41:34 -0500
committerCraig Jennings <c@cjennings.net>2024-04-07 13:41:34 -0500
commit754bbf7a25a8dda49b5d08ef0d0443bbf5af0e36 (patch)
treef1190704f78f04a2b0b4c977d20fe96a828377f1 /devdocs/elisp/simple-types.html
new repository
Diffstat (limited to 'devdocs/elisp/simple-types.html')
-rw-r--r--devdocs/elisp/simple-types.html25
1 files changed, 25 insertions, 0 deletions
diff --git a/devdocs/elisp/simple-types.html b/devdocs/elisp/simple-types.html
new file mode 100644
index 00000000..596dfbcd
--- /dev/null
+++ b/devdocs/elisp/simple-types.html
@@ -0,0 +1,25 @@
+ <h4 class="subsection">Simple Types</h4> <p>This section describes all the simple customization types. For several of these customization types, the customization widget provides inline completion with <kbd>C-M-i</kbd> or <kbd>M-<span class="key">TAB</span></kbd>. </p> <dl compact> <dt><code>sexp</code></dt> <dd>
+<p>The value may be any Lisp object that can be printed and read back. You can use <code>sexp</code> as a fall-back for any option, if you don’t want to take the time to work out a more specific type to use. </p> </dd> <dt><code>integer</code></dt> <dd>
+<p>The value must be an integer. </p> </dd> <dt><code>natnum</code></dt> <dd>
+<p>The value must be a nonnegative integer. </p> </dd> <dt><code>number</code></dt> <dd>
+<p>The value must be a number (floating point or integer). </p> </dd> <dt><code>float</code></dt> <dd>
+<p>The value must be floating point. </p> </dd> <dt><code>string</code></dt> <dd>
+<p>The value must be a string. The customization buffer shows the string without delimiting ‘<samp>"</samp>’ characters or ‘<samp>\</samp>’ quotes. </p> </dd> <dt><code>regexp</code></dt> <dd>
+<p>Like <code>string</code> except that the string must be a valid regular expression. </p> </dd> <dt><code>character</code></dt> <dd>
+<p>The value must be a character code. A character code is actually an integer, but this type shows the value by inserting the character in the buffer, rather than by showing the number. </p> </dd> <dt><code>file</code></dt> <dd>
+<p>The value must be a file name. The widget provides completion. </p> </dd> <dt><code>(file :must-match t)</code></dt> <dd>
+<p>The value must be a file name for an existing file. The widget provides completion. </p> </dd> <dt><code>directory</code></dt> <dd>
+<p>The value must be a directory. The widget provides completion. </p> </dd> <dt><code>hook</code></dt> <dd>
+<p>The value must be a list of functions. This customization type is used for hook variables. You can use the <code>:options</code> keyword in a hook variable’s <code>defcustom</code> to specify a list of functions recommended for use in the hook; See <a href="variable-definitions">Variable Definitions</a>. </p> </dd> <dt><code>symbol</code></dt> <dd>
+<p>The value must be a symbol. It appears in the customization buffer as the symbol name. The widget provides completion. </p> </dd> <dt><code>function</code></dt> <dd>
+<p>The value must be either a lambda expression or a function name. The widget provides completion for function names. </p> </dd> <dt><code>variable</code></dt> <dd>
+<p>The value must be a variable name. The widget provides completion. </p> </dd> <dt><code>face</code></dt> <dd>
+<p>The value must be a symbol which is a face name. The widget provides completion. </p> </dd> <dt><code>boolean</code></dt> <dd>
+<p>The value is boolean—either <code>nil</code> or <code>t</code>. Note that by using <code>choice</code> and <code>const</code> together (see the next section), you can specify that the value must be <code>nil</code> or <code>t</code>, but also specify the text to describe each value in a way that fits the specific meaning of the alternative. </p> </dd> <dt><code>key-sequence</code></dt> <dd>
+<p>The value is a key sequence. The customization buffer shows the key sequence using the same syntax as the <kbd>kbd</kbd> function. See <a href="key-sequences">Key Sequences</a>. </p> </dd> <dt><code>coding-system</code></dt> <dd>
+<p>The value must be a coding-system name, and you can do completion with <kbd>M-<span class="key">TAB</span></kbd>. </p> </dd> <dt><code>color</code></dt> <dd><p>The value must be a valid color name. The widget provides completion for color names, as well as a sample and a button for selecting a color name from a list of color names shown in a <samp>*Colors*</samp> buffer. </p></dd> </dl><div class="_attribution">
+ <p class="_attribution-p">
+ Copyright &copy; 1990-1996, 1998-2022 Free Software Foundation, Inc. <br>Licensed under the GNU GPL license.<br>
+ <a href="https://www.gnu.org/software/emacs/manual/html_node/elisp/Simple-Types.html" class="_attribution-link">https://www.gnu.org/software/emacs/manual/html_node/elisp/Simple-Types.html</a>
+ </p>
+</div>