diff options
| author | Craig Jennings <c@cjennings.net> | 2024-04-07 13:41:34 -0500 |
|---|---|---|
| committer | Craig Jennings <c@cjennings.net> | 2024-04-07 13:41:34 -0500 |
| commit | 754bbf7a25a8dda49b5d08ef0d0443bbf5af0e36 (patch) | |
| tree | f1190704f78f04a2b0b4c977d20fe96a828377f1 /devdocs/elisp/face-functions.html | |
new repository
Diffstat (limited to 'devdocs/elisp/face-functions.html')
| -rw-r--r-- | devdocs/elisp/face-functions.html | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/devdocs/elisp/face-functions.html b/devdocs/elisp/face-functions.html new file mode 100644 index 00000000..38ba4fac --- /dev/null +++ b/devdocs/elisp/face-functions.html @@ -0,0 +1,20 @@ + <h4 class="subsection">Functions for Working with Faces</h4> <p>Here are additional functions for creating and working with faces. </p> <dl> <dt id="face-list">Function: <strong>face-list</strong> +</dt> <dd><p>This function returns a list of all defined face names. </p></dd> +</dl> <dl> <dt id="face-id">Function: <strong>face-id</strong> <em>face</em> +</dt> <dd><p>This function returns the <em>face number</em> of face <var>face</var>. This is a number that uniquely identifies a face at low levels within Emacs. It is seldom necessary to refer to a face by its face number. However, functions that manipulate glyphs, such as <code>make-glyph-code</code> and <code>glyph-face</code> (see <a href="glyphs">Glyphs</a>) access the face numbers internally. Note that the face number is stored as the value of the <code>face</code> property of the face symbol, so we recommend not to set that property of a face to any value of your own. </p></dd> +</dl> <dl> <dt id="face-documentation">Function: <strong>face-documentation</strong> <em>face</em> +</dt> <dd><p>This function returns the documentation string of face <var>face</var>, or <code>nil</code> if none was specified for it. </p></dd> +</dl> <dl> <dt id="face-equal">Function: <strong>face-equal</strong> <em>face1 face2 &optional frame</em> +</dt> <dd><p>This returns <code>t</code> if the faces <var>face1</var> and <var>face2</var> have the same attributes for display. </p></dd> +</dl> <dl> <dt id="face-differs-from-default-p">Function: <strong>face-differs-from-default-p</strong> <em>face &optional frame</em> +</dt> <dd><p>This returns non-<code>nil</code> if the face <var>face</var> displays differently from the default face. </p></dd> +</dl> <p>A <em>face alias</em> provides an equivalent name for a face. You can define a face alias by giving the alias symbol the <code>face-alias</code> property, with a value of the target face name. The following example makes <code>modeline</code> an alias for the <code>mode-line</code> face. </p> <div class="example"> <pre class="example">(put 'modeline 'face-alias 'mode-line) +</pre> +</div> <dl> <dt id="define-obsolete-face-alias">Macro: <strong>define-obsolete-face-alias</strong> <em>obsolete-face current-face when</em> +</dt> <dd><p>This macro defines <code>obsolete-face</code> as an alias for <var>current-face</var>, and also marks it as obsolete, indicating that it may be removed in future. <var>when</var> should be a string indicating when <code>obsolete-face</code> was made obsolete (usually a version number string). </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/Face-Functions.html" class="_attribution-link">https://www.gnu.org/software/emacs/manual/html_node/elisp/Face-Functions.html</a> + </p> +</div> |