kakoune/doc/pages/faces.asciidoc

121 lines
2.9 KiB
Plaintext
Raw Normal View History

= Faces
== Declaration
2016-02-10 22:03:49 +01:00
A 'face' refers how the specified text is displayed, it has a foreground
color, a background color, and some attributes. The value of a face has the
following format:
--------------------------------
fg_color[,bg_color][+attributes]
--------------------------------
'fg_color', 'bg_color'::
2017-11-02 10:37:39 +01:00
a color whose value can be expressed in the following formats:
*black*, *red*, *green*, *yellow*, *blue*, *magenta*, *cyan*, *white*:::
a named color
*default*:::
keep the existing color
*rgb:RRGGBB*:::
hexadecimal value
'attributes'::
2017-11-02 10:37:39 +01:00
string whose individual letters set an attribute:
*u*:::
underline
*r*:::
reverse
*b*:::
bold
*B*:::
blink
*d*:::
dim
*i*:::
italic
*e*:::
exclusive, override previous faces instead of merging
with them
== Builtin faces
2016-04-08 18:00:24 +02:00
The following default faces are used by color schemes to highlight certain
2016-02-10 22:03:49 +01:00
areas of the user interface:
*Default*::
2017-11-02 10:37:39 +01:00
default colors
*PrimarySelection*::
2017-11-02 10:37:39 +01:00
main selection face for every selected character except the cursor
*SecondarySelection*::
2017-11-02 10:37:39 +01:00
secondary selection face for every selected character except the cursor
*PrimaryCursor*::
2017-11-02 10:37:39 +01:00
cursor of the primary selection
*SecondaryCursor*::
2017-11-02 10:37:39 +01:00
cursor of the secondary selection
*PrimaryCursorEol*::
cursor of the primary selection when it lies on and end of line character
*SecondaryCursorEol*::
cursor of the secondary selection when it lies on and end of line character
*MenuForeground*::
2017-11-02 10:37:39 +01:00
face for the selected element in menus
*MenuBackground*::
2017-11-02 10:37:39 +01:00
face for the not selected elements in menus
*MenuInfo*::
2017-11-02 10:37:39 +01:00
face for additional information for elements in menus
*Information*::
2017-11-02 10:37:39 +01:00
face for the informations windows and information messages
*Error*::
2017-11-02 10:37:39 +01:00
face of error messages
*StatusLine*::
2017-11-02 10:37:39 +01:00
face used for the status line
*StatusLineMode*::
2017-11-02 10:37:39 +01:00
face used for the current mode except the normal mode
*StatusLineInfo*::
2017-11-02 10:37:39 +01:00
face used for special information
*StatusLineValue*::
2017-11-02 10:37:39 +01:00
face used for special values (numeric prefixes, registers, etc.)
*StatusCursor*::
2017-11-02 10:37:39 +01:00
face used for the status line cursor
*Prompt*::
2017-11-02 10:37:39 +01:00
face used prompt displayed on the status line
2016-02-17 14:55:19 +01:00
*BufferPadding*::
2017-11-02 10:37:39 +01:00
face applied on the characters that follow the last line of a buffer
=== Builtin highlighters faces
The following faces are used by builtin highlighters if enabled.
(See <<highlighters#,`:doc highlighters`>>.
*LineNumbers*::
face used by the `number-lines` highlighter
*LineNumberCursor*::
face used to highlight the line number of the main selection
*LineNumbersWrapped*::
face used to highlight the line number of wrapped lines
*MatchingChar*::
face used by the `show-matching` highlighter
*Whitespace*::
face used by the `show-whitespaces` highlighter