Variable: custom-face-attributes

custom-face-attributes is a variable defined in cus-face.el.gz.

Value

Large value
((:family
  (string :tag "Font Family" :help-echo "Font family or fontset alias name."))
 (:foundry
  (string :tag "Font Foundry" :help-echo "Font foundry name."))
 (:width
  (choice :tag "Width" :help-echo "Font width." :value normal
	  (const :tag "compressed" condensed)
	  (const :tag "condensed" condensed)
	  (const :tag "demiexpanded" semi-expanded)
	  (const :tag "expanded" expanded)
	  (const :tag "extracondensed" extra-condensed)
	  (const :tag "extraexpanded" extra-expanded)
	  (const :tag "medium" normal)
	  (const :tag "narrow" condensed)
	  (const :tag "normal" normal)
	  (const :tag "regular" normal)
	  (const :tag "semicondensed" semi-condensed)
	  (const :tag "semiexpanded" semi-expanded)
	  (const :tag "ultracondensed" ultra-condensed)
	  (const :tag "ultraexpanded" ultra-expanded)
	  (const :tag "wide" extra-expanded)))
 (:height
  (choice :tag "Height" :help-echo "Face's font height." :value 1.0
	  (integer :tag "Height in 1/10 pt")
	  (number :tag "Scale" 1.0)))
 (:weight
  (choice :tag "Weight" :help-echo "Font weight." :value normal
	  (const :tag "ultralight" ultra-light)
	  (const :tag "extralight" extra-light)
	  (const :tag "light" light)
	  (const :tag "thin" thin)
	  (const :tag "semilight" semi-light)
	  (const :tag "book" semi-light)
	  (const :tag "normal" normal)
	  (const :tag "regular" normal)
	  (const :tag "medium" normal)
	  (const :tag "semibold" semi-bold)
	  (const :tag "demibold" semi-bold)
	  (const :tag "bold" bold)
	  (const :tag "extrabold" extra-bold)
	  (const :tag "heavy" extra-bold)
	  (const :tag "ultrabold" ultra-bold)
	  (const :tag "black" ultra-bold)))
 (:slant
  (choice :tag "Slant" :help-echo "Font slant." :value normal
	  (const :tag "italic" italic)
	  (const :tag "oblique" oblique)
	  (const :tag "normal" normal)
	  (const :tag "roman" roman)))
 (:underline
  (choice :tag "Underline" :help-echo "Control text underlining."
	  (const :tag "Off" nil)
	  (list :tag "On" :value
		(:color foreground-color :style line)
		(const :format "" :value :color)
		(choice :tag "Color"
			(const :tag "Foreground Color" foreground-color)
			color)
		(const :format "" :value :style)
		(choice :tag "Style"
			(const :tag "Line" line)
			(const :tag "Wave" wave))))
  (lambda
    (real-value)
    (and real-value
	 (let
	     ((color
	       (or
		(and
		 (consp real-value)
		 (plist-get real-value :color))
		(and
		 (stringp real-value)
		 real-value)
		'foreground-color))
	      (style
	       (or
		(and
		 (consp real-value)
		 (plist-get real-value :style))
		'line)))
	   (list :color color :style style))))
  (lambda
    (cus-value)
    (and cus-value
	 (let
	     ((color
	       (plist-get cus-value :color))
	      (style
	       (plist-get cus-value :style)))
	   (cond
	    ((eq style 'line)
	     (if
		 (eq color 'foreground-color)
		 t color))
	    (t
	     `(:color ,color :style ,style)))))))
 (:overline
  (choice :tag "Overline" :help-echo "Control text overlining."
	  (const :tag "Off" nil)
	  (const :tag "On" t)
	  (color :tag "Colored")))
 (:strike-through
  (choice :tag "Strike-through" :help-echo "Control text strike-through."
	  (const :tag "Off" nil)
	  (const :tag "On" t)
	  (color :tag "Colored")))
 (:box
  (choice :tag "Box around text" :help-echo "Control box around text."
	  (const :tag "Off" nil)
	  (list :tag "Box" :value
		(:line-width
		 (2 . 2)
		 :color "grey75" :style released-button)
		(const :format "" :value :line-width)
		(cons :tag "Width" :extra-offset 2
		      (integer :tag "Vertical")
		      (integer :tag "Horizontal"))
		(const :format "" :value :color)
		(choice :tag "Color"
			(const :tag "*" nil)
			color)
		(const :format "" :value :style)
		(choice :tag "Style"
			(const :tag "Raised" released-button)
			(const :tag "Sunken" pressed-button)
			(const :tag "Flat" flat-button)
			(const :tag "None" nil))))
  (lambda
    (real-value)
    (and real-value
	 (let
	     ((lwidth
	       (or
		(and
		 (consp real-value)
		 (if
		     (listp
		      (cdr real-value))
		     (plist-get real-value :line-width)
		   real-value))
		(and
		 (integerp real-value)
		 real-value)
		'(1 . 1)))
	      (color
	       (or
		(and
		 (consp real-value)
		 (plist-get real-value :color))
		(and
		 (stringp real-value)
		 real-value)
		nil))
	      (style
	       (and
		(consp real-value)
		(plist-get real-value :style))))
	   (if
	       (integerp lwidth)
	       (setq lwidth
		     (cons
		      (abs lwidth)
		      lwidth)))
	   (list :line-width lwidth :color color :style style))))
  (lambda
    (cus-value)
    (and cus-value
	 (let
	     ((lwidth
	       (plist-get cus-value :line-width))
	      (color
	       (plist-get cus-value :color))
	      (style
	       (plist-get cus-value :style)))
	   (cond
	    ((and
	      (null color)
	      (null style))
	     lwidth)
	    ((and
	      (null lwidth)
	      (null style))
	     color)
	    (t
	     (nconc
	      (and lwidth
		   `(:line-width ,lwidth))
	      (and color
		   `(:color ,color))
	      (and style
		   `(:style ,style)))))))))
 (:inverse-video
  (choice :tag "Inverse-video" :help-echo "Control whether text should be in inverse-video."
	  (const :tag "Off" nil)
	  (const :tag "On" t)))
 (:foreground
  (color :tag "Foreground" :help-echo "Set foreground color (name or #RRGGBB hex spec)."))
 (:distant-foreground
  (color :tag "Distant Foreground" :help-echo "Set distant foreground color (name or #RRGGBB hex spec)."))
 (:background
  (color :tag "Background" :help-echo "Set background color (name or #RRGGBB hex spec)."))
 (:stipple
  (choice :tag "Stipple" :help-echo "Background bit-mask"
	  (const :tag "None" nil)
	  (file :tag "File" :help-echo "Name of bitmap file." :must-match t)))
 (:extend
  (choice :tag "Extend" :help-echo "Control whether attributes should be extended after EOL."
	  (const :tag "Off" nil)
	  (const :tag "On" t)))
 (:inherit
  (repeat :tag "Inherit" :help-echo "List of faces to inherit attributes from."
	  (face :Tag "Face" default))
  (lambda
    (real-value)
    (cond
     ((or
       (null real-value)
       (eq real-value 'unspecified))
      nil)
     ((symbolp real-value)
      (list real-value))
     (t real-value)))
  (lambda
    (cus-value)
    (if
	(and
	 (consp cus-value)
	 (null
	  (cdr cus-value)))
	(car cus-value)
      cus-value))))

Documentation

Alist of face attributes.

The elements are of the form (KEY TYPE PRE-FILTER POST-FILTER), where KEY is the name of the attribute, TYPE is a widget type for editing the attribute, PRE-FILTER is a function to make the attribute's value suitable for the customization widget, and POST-FILTER is a function to make the customized value suitable for storing. PRE-FILTER and POST-FILTER are optional.

The PRE-FILTER should take a single argument, the attribute value as stored, and should return a value for customization (using the customization type TYPE).

The POST-FILTER should also take a single argument, the value after being customized, and should return a value suitable for setting the given face attribute.

Source Code

;; Defined in /usr/src/emacs/lisp/cus-face.el.gz
;;; Face attributes.

(defconst custom-face-attributes
  '((:family
     (string :tag "Font Family"
	     :help-echo "Font family or fontset alias name."))

    (:foundry
     (string :tag "Font Foundry"
	     :help-echo "Font foundry name."))

    (:width
     (choice :tag "Width"
	     :help-echo "Font width."
	     :value normal		; default
	     (const :tag "compressed" condensed)
	     (const :tag "condensed" condensed)
	     (const :tag "demiexpanded" semi-expanded)
	     (const :tag "expanded" expanded)
	     (const :tag "extracondensed" extra-condensed)
	     (const :tag "extraexpanded" extra-expanded)
	     (const :tag "medium" normal)
	     (const :tag "narrow" condensed)
	     (const :tag "normal" normal)
	     (const :tag "regular" normal)
	     (const :tag "semicondensed" semi-condensed)
	     (const :tag "semiexpanded" semi-expanded)
	     (const :tag "ultracondensed" ultra-condensed)
	     (const :tag "ultraexpanded" ultra-expanded)
	     (const :tag "wide" extra-expanded)))

    (:height
     (choice :tag "Height"
	     :help-echo "Face's font height."
	     :value 1.0			; default
	     (integer :tag "Height in 1/10 pt")
	     (number :tag "Scale" 1.0)))

    (:weight
     (choice :tag "Weight"
	     :help-echo "Font weight."
	     :value normal		; default
	     (const :tag "ultralight" ultra-light)
	     (const :tag "extralight" extra-light)
	     (const :tag "light" light)
	     (const :tag "thin" thin)
	     (const :tag "semilight" semi-light)
	     (const :tag "book" semi-light)
	     (const :tag "normal" normal)
	     (const :tag "regular" normal)
	     (const :tag "medium" normal)
	     (const :tag "semibold" semi-bold)
	     (const :tag "demibold" semi-bold)
	     (const :tag "bold" bold)
	     (const :tag "extrabold" extra-bold)
	     (const :tag "heavy" extra-bold)
	     (const :tag "ultrabold" ultra-bold)
	     (const :tag "black" ultra-bold)))

    (:slant
     (choice :tag "Slant"
	     :help-echo "Font slant."
	     :value normal		; default
	     (const :tag "italic" italic)
	     (const :tag "oblique" oblique)
	     (const :tag "normal" normal)
	     (const :tag "roman" roman)))

    (:underline
     (choice :tag "Underline"
	     :help-echo "Control text underlining."
	     (const :tag "Off" nil)
	     (list :tag "On"
		   :value (:color foreground-color :style line)
		   (const :format "" :value :color)
		   (choice :tag "Color"
			   (const :tag "Foreground Color" foreground-color)
			   color)
		   (const :format "" :value :style)
		   (choice :tag "Style"
			   (const :tag "Line" line)
			   (const :tag "Wave" wave))))
     ;; filter to make value suitable for customize
     (lambda (real-value)
       (and real-value
	    (let ((color
		   (or (and (consp real-value) (plist-get real-value :color))
		       (and (stringp real-value) real-value)
		       'foreground-color))
		  (style
		   (or (and (consp real-value) (plist-get real-value :style))
		       'line)))
	      (list :color color :style style))))
     ;; filter to make customized-value suitable for storing
     (lambda (cus-value)
       (and cus-value
	    (let ((color (plist-get cus-value :color))
		  (style (plist-get cus-value :style)))
	      (cond ((eq style 'line)
		     ;; Use simple value for default style
		     (if (eq color 'foreground-color) t color))
		    (t
		     `(:color ,color :style ,style)))))))

    (:overline
     (choice :tag "Overline"
	     :help-echo "Control text overlining."
	     (const :tag "Off" nil)
	     (const :tag "On" t)
	     (color :tag "Colored")))

    (:strike-through
     (choice :tag "Strike-through"
	     :help-echo "Control text strike-through."
	     (const :tag "Off" nil)
	     (const :tag "On" t)
	     (color :tag "Colored")))

    (:box
     ;; Fixme: this can probably be done better.
     (choice :tag "Box around text"
	     :help-echo "Control box around text."
	     (const :tag "Off" nil)
	     (list :tag "Box"
                   :value (:line-width (2 . 2) :color "grey75" :style released-button)
                   (const :format "" :value :line-width)
                   (cons :tag "Width" :extra-offset 2
                         (integer :tag "Vertical")
                         (integer :tag "Horizontal"))
		   (const :format "" :value :color)
		   (choice :tag "Color" (const :tag "*" nil) color)
		   (const :format "" :value :style)
		   (choice :tag "Style"
			   (const :tag "Raised" released-button)
			   (const :tag "Sunken" pressed-button)
			   (const :tag "Flat"   flat-button)
			   (const :tag "None" nil))))
     ;; filter to make value suitable for customize
     (lambda (real-value)
       (and real-value
	    (let ((lwidth
		   (or (and (consp real-value)
                            (if (listp (cdr real-value))
                                (plist-get real-value :line-width)
                              real-value))
		       (and (integerp real-value) real-value)
                       '(1 . 1)))
		  (color
		   (or (and (consp real-value) (plist-get real-value :color))
		       (and (stringp real-value) real-value)
		       nil))
		  (style
		   (and (consp real-value) (plist-get real-value :style))))
              (if (integerp lwidth)
                  (setq lwidth (cons (abs lwidth) lwidth)))
	      (list :line-width lwidth :color color :style style))))
     ;; filter to make customized-value suitable for storing
     (lambda (cus-value)
       (and cus-value
	    (let ((lwidth (plist-get cus-value :line-width))
		  (color (plist-get cus-value :color))
		  (style (plist-get cus-value :style)))
	      (cond ((and (null color) (null style))
		     lwidth)
		    ((and (null lwidth) (null style))
		     ;; actually can't happen, because LWIDTH is always an int
		     color)
		    (t
		     ;; Keep as a plist, but remove null entries
		     (nconc (and lwidth `(:line-width ,lwidth))
			    (and color  `(:color ,color))
			    (and style  `(:style ,style)))))))))

    (:inverse-video
     (choice :tag "Inverse-video"
	     :help-echo "Control whether text should be in inverse-video."
	     (const :tag "Off" nil)
	     (const :tag "On" t)))

    (:foreground
     (color :tag "Foreground"
	    :help-echo "Set foreground color (name or #RRGGBB hex spec)."))

    (:distant-foreground
     (color :tag "Distant Foreground"
	    :help-echo "Set distant foreground color (name or #RRGGBB hex spec)."))

    (:background
     (color :tag "Background"
	    :help-echo "Set background color (name or #RRGGBB hex spec)."))

    (:stipple
     (choice :tag "Stipple"
	     :help-echo "Background bit-mask"
	     (const :tag "None" nil)
	     (file :tag "File"
		   :help-echo "Name of bitmap file."
		   :must-match t)))
    (:extend
     (choice :tag "Extend"
	     :help-echo "Control whether attributes should be extended after EOL."
	     (const :tag "Off" nil)
	     (const :tag "On" t)))
    (:inherit
     (repeat :tag "Inherit"
	     :help-echo "List of faces to inherit attributes from."
	     (face :Tag "Face" default))
     ;; filter to make value suitable for customize
     (lambda (real-value)
       (cond ((or (null real-value) (eq real-value 'unspecified))
	      nil)
	     ((symbolp real-value)
	      (list real-value))
	     (t
	      real-value)))
     ;; filter to make customized-value suitable for storing
     (lambda (cus-value)
       (if (and (consp cus-value) (null (cdr cus-value)))
	   (car cus-value)
	 cus-value))))

  "Alist of face attributes.

The elements are of the form (KEY TYPE PRE-FILTER POST-FILTER),
where KEY is the name of the attribute, TYPE is a widget type for
editing the attribute, PRE-FILTER is a function to make the attribute's
value suitable for the customization widget, and POST-FILTER is a
function to make the customized value suitable for storing.  PRE-FILTER
and POST-FILTER are optional.

The PRE-FILTER should take a single argument, the attribute value as
stored, and should return a value for customization (using the
customization type TYPE).

The POST-FILTER should also take a single argument, the value after
being customized, and should return a value suitable for setting the
given face attribute.")