Graphics.Vty.Widgets.Text

This module provides functionality for rendering Strings as Widgets, including functionality to make structural and/or visual changes at rendering time. To get started, turn your ordinary String into a Widget with plainText; for more control, use textWidget.

Documentation

data FormattedText

The type of formatted text widget state. Stores the text itself and the formatter used to apply attributes to the text.

Instances

Show FormattedText

Constructing Text Widgets

plainText :: String -> IO (Widget FormattedText)

Construct a Widget directly from a String. This is recommended if you don't need to use a Formatter.

plainTextWithAttrs :: [(String, Attr)] -> IO (Widget FormattedText)

Construct a Widget directly from a list of strings and their attributes.

textWidget :: Formatter -> String -> IO (Widget FormattedText)

Construct a text widget formatted with the specified formatters and initial content. The formatters will be applied in the order given here (and, depending on the formatter, order might matter).

Setting Widget Contents

setText :: Widget FormattedText -> String -> IO ()

Set the text value of a FormattedText widget. The specified string will be tokenized.

setTextWithAttrs :: Widget FormattedText -> [(String, Attr)] -> IO ()

Set the text value of a FormattedText widget directly, in case you have done formatting elsewhere and already have text with attributes. The specified strings will each be tokenized, and tokens resulting from each tokenize operation will be given the specified attribute in the tuple.

setTextFormatter :: Widget FormattedText -> Formatter -> IO ()

Set the formatter for the text.

setTextAppearFocused :: Widget FormattedText -> Bool -> IO ()

Set whether a text widget can appear focused by using the context-specific focus attribute when the widget has the focus. This setting defaults to False; some widgets which embed text widgets may need to turn this on.

Formatting

newtype Formatter

A formatter makes changes to text at rendering time. Some formatting use cases involve knowing the size of the rendering area, which is not known until render time (e.g., text wrapping). Thus, a formatter takes a DisplayRegion which indicates the size of screen area available for formatting.

Constructors

Formatter (DisplayRegion -> TextStream Attr -> IO (TextStream Attr))

Instances

Monoid Formatter

applyFormatter :: Formatter -> DisplayRegion -> TextStream Attr -> IO (TextStream Attr)

getTextFormatter :: Widget FormattedText -> IO Formatter

Get the formatter for the text.

nullFormatter :: Formatter

The null formatter which has no effect on text streams.

wrap :: Formatter

A formatter for wrapping text into the available space. This formatter will insert line breaks where appropriate so if you want to use other structure-sensitive formatters, run this formatter last.