NCurses.Core.Color

Definitions

data Color : Type

  The default ncurses colors that can be used in constructing
  color pairs.

Totality: total
Visibility: public export
Constructors:

Black : Color

Red : Color

Green : Color

Yellow : Color

Blue : Color

Magenta : Color

Cyan : Color

White : Color

Hints:

Eq Color

Show Color

data ColorPair : Type

  Color pairs represent both a foreground and background
  color.

Totality: total
Visibility: export
Constructor: 

MkColorPair : Nat -> Color -> Color -> ColorPair

Hints:

Eq ColorPair

Show ColorPair

.idx : ColorPair -> Nat

  Get the index within ncurses where the given color
  pair can be referenced. In almost all situations, this
  can be left as an implementation detail.

Totality: total
Visibility: export

.foreground : ColorPair -> Color

Totality: total
Visibility: export

.background : ColorPair -> Color

Totality: total
Visibility: export

defaultColorPair : ColorPair

  Get the default color pair. Note that unlike with
  user defined colors, the `.foreground` and
  `.background` of this color pair are not guaranteed
  to be accurate in all terminal environments, but this
  color pair will definitely result in the default
  when displayed nonetheless.
  
  The meaning if this color pair is entirely
  determined by its `.idx` property.

Totality: total
Visibility: export

initColorPair : HasIO io => Nat -> Color -> Color -> io ColorPair

  Create a new color pair. You must tell it the index to create
  the color at, which should be a number starting at 0. Some
  platforms allow you to redefine a color at a given index but this
  is not universally supported.
  
  You might notice that ncurses expects color indices to start at 1 --
  this function increments the index it is given so that passing 0 to
  it will use the first available user color pair index of 1.

Totality: total
Visibility: export

startColor : HasIO io => io ()

  Begin using color mode.

Totality: total
Visibility: export