|The type of images to be displayed using update.
Can be constructed directly or using pic_for_image. Which provides an initial instance with
reasonable defaults for pic_cursor and pic_background.
|Create a picture for display for the given image. The picture will not have a displayed cursor
and the background display attribute will be current_attr.
A picture can be configured either to not show the cursor or show the cursor at the specified
There is not a 1 to 1 map from character positions to a row and column on the screen due to
characters that take more than 1 column.
todo: The Cursor can be given a (character,row) offset outside of the visible bounds of the
output region. In this case the cursor will not be shown.
Unspecified regions are filled with the picture's background pattern. The background pattern
can specify a character and a display attribute. If the display attribute used previously should
be used for a background fill then use current_attr for the background attribute. This is the
default background display attribute.
(tofix) The current attribute is always set to the default attributes at the start of updating the
screen to a picture.
(tofix) The background character *must* occupy a single column and no more.
|background_char :: Char|
|background_attr :: Attr|
An image in VTY defines:
- properties required to display the image. These are properties that effect the output image
but are independent of position
- A set of position-dependent text and attribute regions. The possible regions are:
- a point. ( char )
- a horizontal line of characters with a single attribute. (string, utf8_string,
- a fill of a single character. (char_fill)
- a fill of the picture's background. (background_fill)
todo: increase the number of encoded bytestring formats supported.
|The width of an Image. This is the number display columns the image will occupy.
|The height of an Image. This is the number of display rows the image will occupy.
Combines two images side by side.
The result image will have a width equal to the sum of the two images width. And the height will
equal the largest height of the two images. The area not defined in one image due to a height
missmatch will be filled with the background pattern.
|Combines two images vertically.
The result image will have a height equal to the sum of the heights of both images.
The width will equal the largest width of the two images.
The area not defined in one image due to a width missmatch will be filled with the background
|Compose any number of images horizontally.
|Compose any number of images vertically.
|An area of the picture's bacground (See Background) of w columns and h rows.
|an image of a single character. This is a standard Haskell 31-bit character assumed to be in
the ISO-10464 encoding.
Alias for iso_10646_string. Since the usual case is that a literal string like foo is
represented internally as a list of ISO 10646 31 bit characters.
Note: Keep in mind that GHC will compile source encoded as UTF-8 but the literal strings, while
UTF-8 encoded in the source, will be transcoded to a ISO 10646 31 bit characters runtime
A string of characters layed out on a single row with the same display attribute. The string is
assumed to be a sequence of ISO-10464 characters.
Note: depending on how the Haskell compiler represents string literals a string literal in a
UTF-8 encoded source file, for example, may be represented as a ISO-10464 string.
That is, I think, the case with GHC 6.10. This means, for the most part, you don't need to worry
about the encoding format when outputting string literals. Just provide the string literal
directly to iso_10464_string or string.
|A string of characters layed out on a single row. The string is assumed to be a sequence of
|Renders a UTF-8 encoded bytestring.
creates a fill of the specified character. The dimensions are in number of characters wide and
number of rows high.
Unlike the Background fill character this character can have double column display width.
|The possible display attributes used in constructing an Image.
|Produced by Haddock version 2.4.2|