# HG changeset patch # User Miles Bader # Date 1026085405 0 # Node ID df64f9f41c5fd0e642acaab1c7dac3dd419a8804 # Parent 6d4eadedbff108250767d96691b844e0bc6f8f64 Add entries for face-attribute-relative-p, merge-face-attribute. Describe INHERIT argument to face-attribute function. diff -r 6d4eadedbff1 -r df64f9f41c5f lispref/display.texi --- a/lispref/display.texi Sun Jul 07 23:42:46 2002 +0000 +++ b/lispref/display.texi Sun Jul 07 23:43:25 2002 +0000 @@ -1654,7 +1654,7 @@ @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 @@ 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 @@ 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