mirror of
https://github.com/masscollaborationlabs/emacs.git
synced 2025-07-08 21:29:37 +00:00
Improve documentation of face numbers
* doc/lispref/display.texi (Face Functions): Mention where the face number is used and that it depends on the 'face' property of the face symbol. Improve indexing.
This commit is contained in:
parent
bf235ce339
commit
73508e6245
1 changed files with 7 additions and 0 deletions
|
@ -3038,10 +3038,17 @@ value, which inherits from @var{face}'s global definition.
|
||||||
This function returns a list of all defined face names.
|
This function returns a list of all defined face names.
|
||||||
@end defun
|
@end defun
|
||||||
|
|
||||||
|
@cindex face number
|
||||||
|
@cindex face property of face symbols
|
||||||
@defun face-id face
|
@defun face-id face
|
||||||
This function returns the @dfn{face number} of face @var{face}. This
|
This function returns the @dfn{face number} of face @var{face}. This
|
||||||
is a number that uniquely identifies a face at low levels within
|
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.
|
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} and @code{glyph-face} (@pxref{Glyphs}) access
|
||||||
|
the face numbers internally. Note that the face number is stored as
|
||||||
|
the value of the @code{face} property of the face symbol, so we
|
||||||
|
recommend not to set that property of a face to any value of your own.
|
||||||
@end defun
|
@end defun
|
||||||
|
|
||||||
@defun face-documentation face
|
@defun face-documentation face
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue