Modulevty-6.5Haskell2010

Graphics.Vty.Attributes

Display attributes

Attributes have three components: a foreground color, a background color, and a style mask. The simplest attribute is the default attribute, or defAttr. Attributes can be modified with withForeColor, withBackColor, and withStyle, e.g.,

    defAttr `withForeColor` red

Image constructors often require an Attr to indicate the attributes used in the image, e.g.,

    string (defAttr `withForeColor` red) "this text will be red"

The appearance of Images using defAttr is determined by the The terminal, so this is not something VTY can control. The user is free to The define the color scheme of the terminal as they see fit.

The value currentAttr will keep the attributes of whatever was output previously.

4 types
17 values

Packagevty-6.5
Exports21
LanguageHaskell2010
LicenceBSD-3-Clause
SourceAttributes.hs

module Graphics.Vty.Attributes.Color

datadata Attr

A display attribute defines the Color and Style of all the characters rendered after the attribute is applied.

At most 256 colors, picked from a 240 and 16 color palette, are possible for the background and foreground. The 240 colors and 16 colors are points in different palettes. See Color for more information.

Constructors

Attr
- attrStyle :: !MaybeDefault Style
- attrForeColor :: !MaybeDefault Color
- attrBackColor :: !MaybeDefault Color
- attrURL :: !MaybeDefault Text

Instances6Eq, Read, Show, Generic, NFData, Rep

Eq AttrDefined in vty-6.5 · Graphics.Vty.Attributes
Read AttrDefined in vty-6.5 · Graphics.Vty.Attributes
Show AttrDefined in vty-6.5 · Graphics.Vty.Attributes
Generic AttrDefined in vty-6.5 · Graphics.Vty.Attributes
NFData AttrDefined in vty-6.5 · Graphics.Vty.Attributes
type Rep Attr = D1 ('MetaData "Attr" "Graphics.Vty.Attributes" "vty-6.5-1yup7J3nL9oBgrKksjiNXW" 'False) (C1 ('MetaCons "Attr" 'PrefixI 'True) ((S1 ('MetaSel ('Just "attrStyle") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (MaybeDefault Style)) :*: S1 ('MetaSel ('Just "attrForeColor") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (MaybeDefault Color))) :*: (S1 ('MetaSel ('Just "attrBackColor") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (MaybeDefault Color)) :*: S1 ('MetaSel ('Just "attrURL") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (MaybeDefault Text)))))Defined in vty-6.5 · Graphics.Vty.Attributes

datadata FixedAttr

Specifies the display attributes such that the final style and color values do not depend on the previously applied display attribute. The display attributes can still depend on the terminal's default colors (unfortunately).

Constructors

FixedAttr
- fixedStyle :: !Style
- fixedForeColor :: !Maybe Color
- fixedBackColor :: !Maybe Color
- fixedURL :: !Maybe Text

Instances2Eq, Show

Eq FixedAttrDefined in vty-6.5 · Graphics.Vty.Attributes
Show FixedAttrDefined in vty-6.5 · Graphics.Vty.Attributes

datadata MaybeDefault v

The style and color attributes can either be the terminal defaults. Or be equivalent to the previously applied style. Or be a specific value.

Constructors

Default
KeepCurrent
SetTo !v

Instances4Eq, Read, Show, NFData

Eq v => Eq (MaybeDefault v)Defined in vty-6.5 · Graphics.Vty.Attributes
Read v => Read (MaybeDefault v)Defined in vty-6.5 · Graphics.Vty.Attributes
Show v => Show (MaybeDefault v)Defined in vty-6.5 · Graphics.Vty.Attributes
NFData v => NFData (MaybeDefault v)Defined in vty-6.5 · Graphics.Vty.Attributes

valuedefAttr :: Attr

Sets the style, background color and foreground color to the default values for the terminal. There is no easy way to determine what the default background and foreground colors are.

valuecurrentAttr :: Attr

Keeps the style, background color and foreground color that was previously set. Used to override some part of the previous style.

EG: current_style withForeColor brightMagenta

Would be the currently applied style (be it underline, bold, etc) but with the foreground color set to brightMagenta.

Styles

13 declarations

typetype Style = Word8

Styles are represented as an 8 bit word. Each bit in the word is 1 if the style attribute assigned to that bit should be applied and 0 if the style attribute should not be applied.

valuewithStyle :: Attr -> Style -> Attr

Add the given style attribute

valuestandout :: Style

Valid style attributes include:

standout
underline
reverseVideo
blink
dim
bold/bright
italic
strikethrough (via the smxx/rmxx terminfo capabilities)