@@ -4,32 +4,53 @@
44
55-- | Display attributes
66--
7−-- Typically the values 'defAttr' or 'currentAttr' are modified to form
8−-- attributes:
7+-- Attributes have three components: a foreground color, a background
8+-- color, and a style mask. The simplest attribute is the default
9+-- attribute, or 'defAttr'. Attributes can be modified with
10+-- 'withForeColor', 'withBackColor', and 'withStyle', e.g.,
911--
1012-- @
1113-- defAttr `withForeColor` red
1214-- @
1315--
14−-- Is the attribute that will set the foreground color to red and the
15−-- background color to the default.
16−--
17−-- This can then be used to build an image with a red foreground like
18−-- so:
16+-- 'Image' constructors often require an 'Attr' to indicate the
17+-- attributes used in the image, e.g.,
1918--
2019-- @
21−-- string (defAttr `withForeColor` red) "this text will be red"
20+-- string (defAttr `withForeColor` red) "this text will be red"
2221-- @
2322--
24−-- The default attributes set by 'defAttr' have a presentation
25−-- determined by the terminal. This is not something VTY can control.
26−-- The user is free to define the color scheme of the terminal as they
27−-- see fit. Up to the limits of the terminal anyways.
23+-- The appearance of 'Image's using 'defAttr' is determined by the The
24+-- terminal, so this is not something VTY can control. The user is free
25+-- to The define the color scheme of the terminal as they see fit.
2826--
2927-- The value 'currentAttr' will keep the attributes of whatever was
3028-- output previously.
3129module Graphics.Vty.Attributes
32− ( module Graphics.Vty.Attributes
30+ ( Attr(..)
31+ , FixedAttr(..)
32+ , MaybeDefault(..)
33+ , defAttr
34+ , currentAttr
35+
36+ -- * Styles
37+ , Style
38+ , withStyle
39+ , standout
40+ , underline
41+ , reverseVideo
42+ , blink
43+ , dim
44+ , bold
45+ , defaultStyleMask
46+ , styleMask
47+ , hasStyle
48+
49+ -- * Setting attribute colors
50+ , withForeColor
51+ , withBackColor
52+
53+ -- * Colors
3354 , module Graphics.Vty.Attributes.Color
3455 , module Graphics.Vty.Attributes.Color240
3556 )