comparison lispref/display.texi @ 72208:513c469ffd50

(Face Functions): Fix explanations of FRAME=t or nil.

72207:e9f448b5a616

@end defun

@node Attribute Functions
@subsection Face Attribute Functions

  You can modify the attributes of an existing face with the following
functions.  If you specify @var{frame}, they affect just that frame;
otherwise, they affect all frames as well as the defaults that apply to
new frames.

@defun set-face-attribute face frame &rest arguments
This function sets one or more attributes of face @var{face} for frame
@var{frame}.  The attributes you specify this way override whatever
the @code{defface} says.

@noindent
sets the attributes @code{:width}, @code{:weight} and @code{:underline}
to the corresponding values.

If @var{frame} is @code{t}, this function sets the attributes for all
existing frames, and sets defaults that will apply for new frames.
Default attribute values specified this way override the
@code{defface} for newly created frames.
@end defun

@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},

@end defun

  The functions above did not exist before Emacs 21.  For compatibility
with older Emacs versions, you can use the following functions to set
and examine the face attributes which existed in those versions.

@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
of face @var{face} to @var{color}.  The argument @var{color} should be a

This function swaps the foreground and background colors of face
@var{face}.
@end defun

  These functions examine the attributes of a face.  If you don't
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 inherit
@defunx face-background face &optional frame inherit
These functions return the foreground color (or background color,
respectively) of face @var{face}, as a string.

72208:513c469ffd50

@end defun

@node Attribute Functions
@subsection Face Attribute Functions

  This section describes the functions for accessing and modifying the
attributes of an existing face.

@defun set-face-attribute face frame &rest arguments
This function sets one or more attributes of face @var{face} for frame
@var{frame}.  The attributes you specify this way override whatever
the @code{defface} says.

@noindent
sets the attributes @code{:width}, @code{:weight} and @code{:underline}
to the corresponding values.

If @var{frame} is @code{t}, this function sets the default attributes
for new frames.  Default attribute values specified this way override
the @code{defface} for newly created frames.

If @var{frame} is @code{nil}, this function sets the attributes for
all existing frames, and the default for new frames.
@end defun

@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},

@end defun

  The functions above did not exist before Emacs 21.  For compatibility
with older Emacs versions, you can use the following functions to set
and examine the face attributes which existed in those versions.
They use values of @code{t} and @code{nil} for @var{frame}
just like @code{set-face-attribute} and @code{face-attribute}.

@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
of face @var{face} to @var{color}.  The argument @var{color} should be a

This function swaps the foreground and background colors of face
@var{face}.
@end defun

  These functions examine the attributes of a face.  If you don't
specify @var{frame}, they refer to the selected frame; @code{t} refers
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 inherit
@defunx face-background face &optional frame inherit
These functions return the foreground color (or background color,
respectively) of face @var{face}, as a string.