From: Miles Bader <miles@gnu.org>
Date: Sun, 7 Jul 2002 23:58:31 +0000 (+0000)
Subject: Update face-foreground and face-background to mention INHERIT parameter.
X-Git-Tag: ttn-vms-21-2-B4~14243
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=69137def9b55701e11fb0e2ea0d88fff9e02098c;p=emacs.git

Update face-foreground and face-background to mention INHERIT parameter.
---

diff --git a/lispref/display.texi b/lispref/display.texi
index 370f7f3e23c..c9237bd7983 100644
--- a/lispref/display.texi
+++ b/lispref/display.texi
@@ -1767,15 +1767,29 @@ specify @var{frame}, they refer to the default data for new frames.
 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