diff options
| author | Eli Zaretskii | 2023-06-29 10:47:26 +0300 |
|---|---|---|
| committer | Eli Zaretskii | 2023-06-29 10:47:26 +0300 |
| commit | 042f0d6a14cd99eb9d33cfccc6239534bc40e712 (patch) | |
| tree | 02aae374e8fb8fe57639f3b9f4733d3c24777a28 | |
| parent | d5cff340b3b4ab616bf4549150754cb99549afe3 (diff) | |
| download | emacs-042f0d6a14cd99eb9d33cfccc6239534bc40e712.tar.gz emacs-042f0d6a14cd99eb9d33cfccc6239534bc40e712.zip | |
; Fix documentation of ':box' face attribute
* lisp/faces.el (set-face-attribute): Update the documentation of
WIDTH in the :box face attribute. (Bug#64344)
| -rw-r--r-- | lisp/faces.el | 32 |
1 files changed, 19 insertions, 13 deletions
diff --git a/lisp/faces.el b/lisp/faces.el index 8bf7e4429d9..696634b4ef7 100644 --- a/lisp/faces.el +++ b/lisp/faces.el | |||
| @@ -794,19 +794,25 @@ around them. If VALUE is nil, explicitly don't draw boxes. If | |||
| 794 | VALUE is t, draw a box with lines of width 1 in the foreground color | 794 | VALUE is t, draw a box with lines of width 1 in the foreground color |
| 795 | of the face. If VALUE is a string, the string must be a color name, | 795 | of the face. If VALUE is a string, the string must be a color name, |
| 796 | and the box is drawn in that color with a line width of 1. Otherwise, | 796 | and the box is drawn in that color with a line width of 1. Otherwise, |
| 797 | VALUE must be a property list of the form `(:line-width WIDTH | 797 | VALUE must be a property list of the following form: |
| 798 | :color COLOR :style STYLE)'. If a keyword/value pair is missing from | 798 | |
| 799 | the property list, a default value will be used for the value, as | 799 | (:line-width WIDTH :color COLOR :style STYLE) |
| 800 | specified below. WIDTH specifies the width of the lines to draw; it | 800 | |
| 801 | defaults to 1. If WIDTH is negative, the absolute value is the width | 801 | If a keyword/value pair is missing from the property list, a default |
| 802 | of the lines, and draw top/bottom lines inside the characters area, | 802 | value will be used for the value, as specified below. |
| 803 | not around it. COLOR is the name of the color to draw in, default is | 803 | |
| 804 | the background color of the face for 3D boxes and `flat-button', and | 804 | WIDTH specifies the width of the lines to draw; it defaults to 1. |
| 805 | the foreground color of the face for other boxes. STYLE specifies | 805 | If WIDTH is negative, the absolute value is the width of the lines, |
| 806 | whether a 3D box should be draw. If STYLE is `released-button', draw | 806 | and draw top/bottom lines inside the characters area, not around it. |
| 807 | a box looking like a released 3D button. If STYLE is `pressed-button' | 807 | WIDTH can also be a cons (VWIDTH . HWIDTH), which specifies different |
| 808 | draw a box that appears like a pressed button. If STYLE is nil, | 808 | values for the vertical and the horizontal line width. |
| 809 | `flat-button' or omitted, draw a 2D box. | 809 | COLOR is the name of the color to use for the box lines, default is |
| 810 | the background color of the face for 3D and `flat-button' boxes, and | ||
| 811 | the foreground color of the face for the other boxes. | ||
| 812 | STYLE specifies whether a 3D box should be drawn. If STYLE | ||
| 813 | is `released-button', draw a box looking like a released 3D button. | ||
| 814 | If STYLE is `pressed-button', draw a box that looks like a pressed | ||
| 815 | button. If STYLE is nil, `flat-button', or omitted, draw a 2D box. | ||
| 810 | 816 | ||
| 811 | `:inverse-video' | 817 | `:inverse-video' |
| 812 | 818 | ||