mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-01-06 11:50:51 -08:00
Code Issues Projects Releases Wiki Activity

Add entries for face-attribute-relative-p, merge-face-attribute.

Browse source 
Describe INHERIT argument to face-attribute function.
This commit is contained in:
Miles Bader 2002-07-07 23:43:25 +00:00
parent ed1b7d5eda
commit 35f23bbf82
1 changed files with 30 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

31
lispref/display.texi
View file

@ -1654,7 +1654,7 @@ to the corresponding values.
@end defun
@tindex face-attribute
@defun face-attribute face attribute &optional frame
@defun face-attribute face attribute &optional frame inherit
This returns the value of the @var{attribute} attribute of face
@var{face} on @var{frame}. If @var{frame} is @code{nil},
that means the selected frame (@pxref{Input Focus}).
@ -1662,6 +1662,20 @@ that means the selected frame (@pxref{Input Focus}).
If @var{frame} is @code{t}, the value is the default for
@var{face} for new frames.
If @var{inherit} is nil, only attributes directly defined by
@var{face} are considered, so the return value may be
@code{unspecified}, or a relative value. If @var{inherit} is non-nil,
@var{face}'s definition of @var{attribute} is merged with the faces
specified by its @code{:inherit} attribute; however the return value
may still be @code{unspecified} or relative. If @var{inherit} is a
face or a list of faces, then the result is further merged with that
face (or faces), until it becomes specified and absolute.
To ensure that the return value is always specified and absolute, use
a value of @code{default} for @var{inherit}; this will resolve any
unspecified or relative values by merging with the @code{default} face
(which is always completely specified).
For example,
@example
@ -1674,6 +1688,21 @@ For example,
with older Emacs versions, you can use the following functions to set
and examine the face attributes which existed in those versions.
@tindex face-attribute-relative-p
@defun face-attribute-relative-p attribute value
This function returns non-@code{nil} if @var{value}, when used as a
the value of the face attribute @var{attribute}, is relative (that is,
if it modifies an underlying or inherited value of @var{attribute}).
@end defun
@tindex merge-face-attribute
@defun merge-face-attribute attribute value1 value2
If @var{value1} is a relative value for the face attribute
@var{attribute}, returns it merged with the underlying value
@var{value2}; otherwise, if @var{value1} is an absolute value for the
face a attribute @var{attribute}, returns @var{value1} unchanged.
@end defun
@defun set-face-foreground face color &optional frame
@defunx set-face-background face color &optional frame
These functions set the foreground (or background, respectively) color