# HG changeset patch # User Miles Bader # Date 1026086311 0 # Node ID fb42c0446cbfd4debf0f47e0a07737d6a1cb78c1 # Parent c31280155efa0e7d2f4946ac189006215ea37b45 Update face-foreground and face-background to mention INHERIT parameter. diff -r c31280155efa -r fb42c0446cbf lispref/display.texi --- a/lispref/display.texi Sun Jul 07 23:48:41 2002 +0000 +++ b/lispref/display.texi Sun Jul 07 23:58:31 2002 +0000 @@ -1767,15 +1767,29 @@ They return the symbol @code{unspecified} if the face doesn't define any value for that attribute. -@defun face-foreground face &optional frame +@defun face-foreground face &optional frame inherit @defunx face-background face &optional frame These functions return the foreground color (or background color, respectively) of face @var{face}, as a string. + +If @var{inherit} is nil, only a color directly defined by the face is +returned. If @var{inherit} is non-nil, any faces specified by its +@code{:inherit} attribute are considered as well, and if @var{inherit} +is a face or a list of faces, then they are also considered, until a +specified color is found. To ensure that the return value is always +specified, use a value of @code{default} for @var{inherit}. @end defun -@defun face-stipple face &optional frame +@defun face-stipple face &optional frame inherit This function returns the name of the background stipple pattern of face @var{face}, or @code{nil} if it doesn't have one. + +If @var{inherit} is nil, only a stipple directly defined by the face +is returned. If @var{inherit} is non-nil, any faces specified by its +@code{:inherit} attribute are considered as well, and if @var{inherit} +is a face or a list of faces, then they are also considered, until a +specified stipple is found. To ensure that the return value is always +specified, use a value of @code{default} for @var{inherit}. @end defun @defun face-font face &optional frame