Language-Haskell-HsColour-ANSI.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--Rendered using the Haskell Html Library v0.2-->
<HTML
><HEAD
><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"
><TITLE
>Language.Haskell.HsColour.ANSI</TITLE
><LINK HREF="haddock.css" REL="stylesheet" TYPE="text/css"
><SCRIPT SRC="haddock.js" TYPE="text/javascript"
></SCRIPT
></HEAD
><BODY
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="topbar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><IMG SRC="haskell_icon.gif" WIDTH="16" HEIGHT="16" ALT=" "
></TD
><TD CLASS="title"
>hscolour</TD
><TD CLASS="topbut"
><A HREF="Language/Haskell/HsColour/ANSI.html"
>Source code</A
></TD
><TD CLASS="topbut"
><A HREF="index.html"
>Contents</A
></TD
><TD CLASS="topbut"
><A HREF="doc-index.html"
>Index</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="modulebar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><FONT SIZE="6"
>Language.Haskell.HsColour.ANSI</FONT
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Description</TD
></TR
><TR
><TD CLASS="doc"
>Partially taken from Hugs AnsiScreen.hs library:
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Synopsis</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="#v%3Ahighlight"
>highlight</A
> :: [<A HREF="Language-Haskell-HsColour-ANSI.html#t%3AHighlight"
>Highlight</A
>] -&gt; String -&gt; String</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Acls"
>cls</A
> :: String</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Agoto"
>goto</A
> :: Int -&gt; Int -&gt; String</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
> <A HREF="#t%3AHighlight"
>Highlight</A
> </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
>= <A HREF="#v%3ANormal"
>Normal</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3ABold"
>Bold</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3ADim"
>Dim</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3AUnderscore"
>Underscore</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3ABlink"
>Blink</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3AReverseVideo"
>ReverseVideo</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3AConcealed"
>Concealed</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3AForeground"
>Foreground</A
> <A HREF="Language-Haskell-HsColour-ANSI.html#t%3AColour"
>Colour</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3ABackground"
>Background</A
> <A HREF="Language-Haskell-HsColour-ANSI.html#t%3AColour"
>Colour</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3AItalic"
>Italic</A
></TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
> <A HREF="#t%3AColour"
>Colour</A
> </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
>= <A HREF="#v%3ABlack"
>Black</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3ARed"
>Red</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3AGreen"
>Green</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3AYellow"
>Yellow</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3ABlue"
>Blue</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3AMagenta"
>Magenta</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3ACyan"
>Cyan</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3AWhite"
>White</A
></TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AcolourCycle"
>colourCycle</A
> :: [<A HREF="Language-Haskell-HsColour-ANSI.html#t%3AColour"
>Colour</A
>]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AenableScrollRegion"
>enableScrollRegion</A
> :: Int -&gt; Int -&gt; String</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Documentation</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3Ahighlight"
></A
><B
>highlight</B
> :: [<A HREF="Language-Haskell-HsColour-ANSI.html#t%3AHighlight"
>Highlight</A
>] -&gt; String -&gt; String</TD
><TD CLASS="declbut"
><A HREF="Language/Haskell/HsColour/ANSI.html#highlight"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Make the given string appear with all of the listed highlights
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3Acls"
></A
><B
>cls</B
> :: String</TD
><TD CLASS="declbut"
><A HREF="Language/Haskell/HsColour/ANSI.html#cls"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Clear the screen.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3Agoto"
></A
><B
>goto</B
> :: Int -&gt; Int -&gt; String</TD
><TD CLASS="declbut"
><A HREF="Language/Haskell/HsColour/ANSI.html#goto"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Move the screen cursor to the given position.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><SPAN CLASS="keyword"
>data</SPAN
> <A NAME="t%3AHighlight"
></A
><B
>Highlight</B
> </TD
><TD CLASS="declbut"
><A HREF="Language/Haskell/HsColour/ANSI.html#Highlight"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
>Types of highlighting supported by ANSI codes (and some extra styles).
</TD
></TR
><TR
><TD CLASS="section4"
>Constructors</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v%3ANormal"
></A
><B
>Normal</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v%3ABold"
></A
><B
>Bold</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v%3ADim"
></A
><B
>Dim</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v%3AUnderscore"
></A
><B
>Underscore</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v%3ABlink"
></A
><B
>Blink</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v%3AReverseVideo"
></A
><B
>ReverseVideo</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v%3AConcealed"
></A
><B
>Concealed</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v%3AForeground"
></A
><B
>Foreground</B
> <A HREF="Language-Haskell-HsColour-ANSI.html#t%3AColour"
>Colour</A
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v%3ABackground"
></A
><B
>Background</B
> <A HREF="Language-Haskell-HsColour-ANSI.html#t%3AColour"
>Colour</A
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v%3AItalic"
></A
><B
>Italic</B
></TD
><TD CLASS="rdoc"
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:Highlight')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:Highlight" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
>Enum <A HREF="Language-Haskell-HsColour-ANSI.html#t%3AHighlight"
>Highlight</A
></TD
></TR
><TR
><TD CLASS="decl"
>Eq <A HREF="Language-Haskell-HsColour-ANSI.html#t%3AHighlight"
>Highlight</A
></TD
></TR
><TR
><TD CLASS="decl"
>Read <A HREF="Language-Haskell-HsColour-ANSI.html#t%3AHighlight"
>Highlight</A
></TD
></TR
><TR
><TD CLASS="decl"
>Show <A HREF="Language-Haskell-HsColour-ANSI.html#t%3AHighlight"
>Highlight</A
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><SPAN CLASS="keyword"
>data</SPAN
> <A NAME="t%3AColour"
></A
><B
>Colour</B
> </TD
><TD CLASS="declbut"
><A HREF="Language/Haskell/HsColour/ANSI.html#Colour"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
>Colours supported by ANSI codes.
</TD
></TR
><TR
><TD CLASS="section4"
>Constructors</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v%3ABlack"
></A
><B
>Black</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v%3ARed"
></A
><B
>Red</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v%3AGreen"
></A
><B
>Green</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v%3AYellow"
></A
><B
>Yellow</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v%3ABlue"
></A
><B
>Blue</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v%3AMagenta"
></A
><B
>Magenta</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v%3ACyan"
></A
><B
>Cyan</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v%3AWhite"
></A
><B
>White</B
></TD
><TD CLASS="rdoc"
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:Colour')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:Colour" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
>Enum <A HREF="Language-Haskell-HsColour-ANSI.html#t%3AColour"
>Colour</A
></TD
></TR
><TR
><TD CLASS="decl"
>Eq <A HREF="Language-Haskell-HsColour-ANSI.html#t%3AColour"
>Colour</A
></TD
></TR
><TR
><TD CLASS="decl"
>Read <A HREF="Language-Haskell-HsColour-ANSI.html#t%3AColour"
>Colour</A
></TD
></TR
><TR
><TD CLASS="decl"
>Show <A HREF="Language-Haskell-HsColour-ANSI.html#t%3AColour"
>Colour</A
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AcolourCycle"
></A
><B
>colourCycle</B
> :: [<A HREF="Language-Haskell-HsColour-ANSI.html#t%3AColour"
>Colour</A
>]</TD
><TD CLASS="declbut"
><A HREF="Language/Haskell/HsColour/ANSI.html#colourCycle"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>An infinite supply of colours.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AenableScrollRegion"
></A
><B
>enableScrollRegion</B
> :: Int -&gt; Int -&gt; String</TD
><TD CLASS="declbut"
><A HREF="Language/Haskell/HsColour/ANSI.html#enableScrollRegion"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Scrolling
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="botbar"
>Produced by <A HREF="http://www.haskell.org/haddock/"
>Haddock</A
> version 0.8</TD
></TR
></TABLE
></BODY
></HTML
>