diff options
Diffstat (limited to 'devdocs/elisp/standard-properties.html')
| -rw-r--r-- | devdocs/elisp/standard-properties.html | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/devdocs/elisp/standard-properties.html b/devdocs/elisp/standard-properties.html new file mode 100644 index 00000000..3de7886d --- /dev/null +++ b/devdocs/elisp/standard-properties.html @@ -0,0 +1,25 @@ + <h4 class="subsection">Standard Symbol Properties</h4> <p>Here, we list the symbol properties which are used for special purposes in Emacs. In the following table, whenever we say “the named function”, that means the function whose name is the relevant symbol; similarly for “the named variable” etc. </p> <dl compact> <dt><code>:advertised-binding</code></dt> <dd> +<p>This property value specifies the preferred key binding, when showing documentation, for the named function. See <a href="keys-in-documentation">Keys in Documentation</a>. </p> </dd> <dt><code>char-table-extra-slots</code></dt> <dd> +<p>The value, if non-<code>nil</code>, specifies the number of extra slots in the named char-table type. See <a href="char_002dtables">Char-Tables</a>. </p> </dd> <dt><code>customized-face</code></dt> <dt><code>face-defface-spec</code></dt> <dt><code>saved-face</code></dt> <dt><code>theme-face</code></dt> <dd> +<p>These properties are used to record a face’s standard, saved, customized, and themed face specs. Do not set them directly; they are managed by <code>defface</code> and related functions. See <a href="defining-faces">Defining Faces</a>. </p> </dd> <dt><code>customized-value</code></dt> <dt><code>saved-value</code></dt> <dt><code>standard-value</code></dt> <dt><code>theme-value</code></dt> <dd> +<p>These properties are used to record a customizable variable’s standard value, saved value, customized-but-unsaved value, and themed values. Do not set them directly; they are managed by <code>defcustom</code> and related functions. See <a href="variable-definitions">Variable Definitions</a>. </p> </dd> <dt><code>disabled</code></dt> <dd> +<p>If the value is non-<code>nil</code>, the named function is disabled as a command. See <a href="disabling-commands">Disabling Commands</a>. </p> </dd> <dt><code>face-documentation</code></dt> <dd> +<p>The value stores the documentation string of the named face. This is set automatically by <code>defface</code>. See <a href="defining-faces">Defining Faces</a>. </p> </dd> <dt><code>history-length</code></dt> <dd> +<p>The value, if non-<code>nil</code>, specifies the maximum minibuffer history length for the named history list variable. See <a href="minibuffer-history">Minibuffer History</a>. </p> </dd> <dt><code>interactive-form</code></dt> <dd> +<p>The value is an interactive form for the named function. Normally, you should not set this directly; use the <code>interactive</code> special form instead. See <a href="interactive-call">Interactive Call</a>. </p> </dd> <dt><code>menu-enable</code></dt> <dd> +<p>The value is an expression for determining whether the named menu item should be enabled in menus. See <a href="simple-menu-items">Simple Menu Items</a>. </p> </dd> <dt><code>mode-class</code></dt> <dd> +<p>If the value is <code>special</code>, the named major mode is special. See <a href="major-mode-conventions">Major Mode Conventions</a>. </p> </dd> <dt><code>permanent-local</code></dt> <dd> +<p>If the value is non-<code>nil</code>, the named variable is a buffer-local variable whose value should not be reset when changing major modes. See <a href="creating-buffer_002dlocal">Creating Buffer-Local</a>. </p> </dd> <dt><code>permanent-local-hook</code></dt> <dd> +<p>If the value is non-<code>nil</code>, the named function should not be deleted from the local value of a hook variable when changing major modes. See <a href="setting-hooks">Setting Hooks</a>. </p> </dd> <dt><code>pure</code></dt> <dd> + <p>If the value is non-<code>nil</code>, the named function is considered to be pure (see <a href="what-is-a-function">What Is a Function</a>). Calls with constant arguments can be evaluated at compile time. This may shift run time errors to compile time. Not to be confused with pure storage (see <a href="pure-storage">Pure Storage</a>). </p> </dd> <dt><code>risky-local-variable</code></dt> <dd> +<p>If the value is non-<code>nil</code>, the named variable is considered risky as a file-local variable. See <a href="file-local-variables">File Local Variables</a>. </p> </dd> <dt><code>safe-function</code></dt> <dd> +<p>If the value is non-<code>nil</code>, the named function is considered generally safe for evaluation. See <a href="function-safety">Function Safety</a>. </p> </dd> <dt><code>safe-local-eval-function</code></dt> <dd> +<p>If the value is non-<code>nil</code>, the named function is safe to call in file-local evaluation forms. See <a href="file-local-variables">File Local Variables</a>. </p> </dd> <dt><code>safe-local-variable</code></dt> <dd> +<p>The value specifies a function for determining safe file-local values for the named variable. See <a href="file-local-variables">File Local Variables</a>. </p> </dd> <dt><code>side-effect-free</code></dt> <dd> + <p>A non-<code>nil</code> value indicates that the named function is free of side effects (see <a href="what-is-a-function">What Is a Function</a>), so the byte compiler may ignore a call whose value is unused. If the property’s value is <code>error-free</code>, the byte compiler may even delete such unused calls. In addition to byte compiler optimizations, this property is also used for determining function safety (see <a href="function-safety">Function Safety</a>). </p> </dd> <dt><code>undo-inhibit-region</code></dt> <dd> +<p>If non-<code>nil</code>, the named function prevents the <code>undo</code> operation from being restricted to the active region, if <code>undo</code> is invoked immediately after the function. See <a href="undo">Undo</a>. </p> </dd> <dt><code>variable-documentation</code></dt> <dd><p>If non-<code>nil</code>, this specifies the named variable’s documentation string. This is set automatically by <code>defvar</code> and related functions. See <a href="defining-faces">Defining Faces</a>. </p></dd> </dl><div class="_attribution"> + <p class="_attribution-p"> + Copyright © 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/Standard-Properties.html" class="_attribution-link">https://www.gnu.org/software/emacs/manual/html_node/elisp/Standard-Properties.html</a> + </p> +</div> |