Mercurial > hg > xemacs-beta

comparison man/lispref/faces.texi @ 412:697ef44129c6 r21-2-14

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import from CVS: tag r21-2-14
author cvs
date Mon, 13 Aug 2007 11:20:41 +0200
parents 501cfd01ee6d
children
comparison
equal deleted inserted replaced
411:12e008d41344 412:697ef44129c6
244 @var{locale} is given, then this function will attempt to add 244 @var{locale} is given, then this function will attempt to add
245 @var{value} as the instantiator for the given @var{locale}, using 245 @var{value} as the instantiator for the given @var{locale}, using
246 @code{add-spec-to-specifier}. If the value of the property is not a 246 @code{add-spec-to-specifier}. If the value of the property is not a
247 specifier, it will automatically be converted into a @code{generic} 247 specifier, it will automatically be converted into a @code{generic}
248 specifier. 248 specifier.
249 @end defun
250
251 @defun remove-face-property face property &optional local tag-set exact-p
252 This function removes a property of a @var{face}.
253
254 For built-in properties, this is analogous to @code{remove-specifier}.
255 For more information, @xref{Other Specification Functions}.
256
257 When @var{property} is not a built-in property, this function will just
258 remove its value if @var{locale} is @code{nil} or @code{all}. However,
259 if @var{locale} is other than that, this function will attempt to remove
260 @var{value} as the instantiator for the given @var{locale} with
261 @code{remove-specifier}. If the value of the property is not a
262 specifier, it will be converted into a @code{generic} specifier
263 automatically.
264 @end defun 249 @end defun
265 250
266 @defun face-property face property &optional locale 251 @defun face-property face property &optional locale
267 This function returns @var{face}'s value of the given @var{property}. 252 This function returns @var{face}'s value of the given @var{property}.
268 253
474 @defun font-specifier-p object 459 @defun font-specifier-p object
475 This predicate returns @code{t} if @var{object} is a font specifier, and 460 This predicate returns @code{t} if @var{object} is a font specifier, and
476 @code{nil} otherwise. 461 @code{nil} otherwise.
477 @end defun 462 @end defun
478 463
479 @defun make-font-specifier spec-list
480
481 Return a new @code{font} specifier object with the given specification
482 list. @var{spec-list} can be a list of specifications (each of which is
483 a cons of a locale and a list of instantiators), a single instantiator,
484 or a list of instantiators. @xref{Specifiers}, for more information
485 about specifiers.
486
487 Valid instantiators for font specifiers are:
488
489 @itemize @bullet
490
491 @item
492 A string naming a font (e.g. under X this might be
493 "-*-courier-medium-r-*-*-*-140-*-*-*-*-iso8859-*" for a 14-point
494 upright medium-weight Courier font).
495 @item
496 A font instance (use that instance directly if the device matches,
497 or use the string that generated it).
498 @item
499 A vector of no elements (only on TTY's; this means to set no font
500 at all, thus using the "natural" font of the terminal's text).
501 @item
502 A vector of one element (a face to inherit from).
503 @end itemize
504 @end defun
505
506 @node Font Instances 464 @node Font Instances
507 @subsection Font Instances 465 @subsection Font Instances
508 466
509 @defun font-instance-p object 467 @defun font-instance-p object
510 This predicate returns @code{t} if @var{object} is a font instance, and 468 This predicate returns @code{t} if @var{object} is a font instance, and
659 617
660 @defun color-specifier-p object 618 @defun color-specifier-p object
661 This function returns non-@code{nil} if @var{object} is a color specifier. 619 This function returns non-@code{nil} if @var{object} is a color specifier.
662 @end defun 620 @end defun
663 621
664 @defun make-color-specifier spec-list
665
666 Return a new @code{color} specifier object with the given specification
667 list. @var{spec-list} can be a list of specifications (each of which is
668 a cons of a locale and a list of instantiators), a single instantiator,
669 or a list of instantiators. @xref{Specifiers}, for a detailed
670 description of how specifiers work.
671
672 Valid instantiators for color specifiers are:
673
674 @itemize @bullet
675 @item
676 A string naming a color (e.g. under X this might be "lightseagreen2" or
677 "#F534B2").
678
679 @item
680 A color instance (use that instance directly if the device matches,
681 or use the string that generated it).
682
683 @item
684 A vector of no elements (only on TTY's; this means to set no color at
685 all, thus using the "natural" color of the terminal's text).
686
687 @item
688 A vector of one or two elements: a face to inherit from, and optionally
689 a symbol naming which property of that face to inherit, either
690 @code{foreground} or @code{background} (if omitted, defaults to the same
691 property that this color specifier is used for; if this specifier is not
692 part of a face, the instantiator would not be valid).
693 @end itemize
694 @end defun
695
696 @defun make-face-boolean-specifier spec-list
697
698 Return a new @code{face-boolean} specifier object with the given spec
699 list. @var{spec-list} can be a list of specifications (each of which is
700 a cons of a locale and a list of instantiators), a single instantiator,
701 or a list of instantiators. @xref{Specifiers}, for a detailed
702 description of how specifiers work.
703
704 Valid instantiators for face-boolean specifiers are
705
706 @itemize @bullet
707 @item
708 t or nil.
709 @item
710 A vector of two or three elements: a face to inherit from, optionally a
711 symbol naming the property of that face to inherit from (if omitted,
712 defaults to the same property that this face-boolean specifier is used
713 for; if this specifier is not part of a face, the instantiator would not
714 be valid), and optionally a value which, if non-nil, means to invert the
715 sense of the inherited property.
716 @end itemize
717
718 @end defun
719
720
721 @node Color Instances 622 @node Color Instances
722 @subsection Color Instances 623 @subsection Color Instances
723 @cindex color instances 624 @cindex color instances
724 625
725 A @dfn{color-instance object} is an object describing the way a color 626 A @dfn{color-instance object} is an object describing the way a color
769 @code{specifier-instance} and applying @code{color-instance-name} to the 670 @code{specifier-instance} and applying @code{color-instance-name} to the
770 result. 671 result.
771 @end defun 672 @end defun
772 673
773 @defun color-rgb-components color &optional domain 674 @defun color-rgb-components color &optional domain
774 This function returns the @sc{rgb} components of the @var{color} in the 675 This function returns the @sc{RGB} components of the @var{color} in the
775 specified @var{domain}, if any. @var{color} should be a color specifier 676 specified @var{domain}, if any. @var{color} should be a color specifier
776 object and @var{domain} is normally a window and defaults to the 677 object and @var{domain} is normally a window and defaults to the
777 selected window if omitted. This is equivalent to using 678 selected window if omitted. This is equivalent to using
778 @code{specifier-instance} and applying 679 @code{specifier-instance} and applying
779 @code{color-instance-rgb-components} to the result. 680 @code{color-instance-rgb-components} to the result.