Dialog

Basic usage example

module Main where
import Dialog

main = dialog $ do
  changeTitle "Hello, World!"
  name <- askLine "What's your name?"
  displayLine ("Your name is: " ++ name)

Running dialogs

data DialogT m a

Dialog monad transformer.

Instances

MonadTrans DialogT

Monad (DialogT m)

Functor (DialogT m)

Applicative (DialogT m)

MonadIO m => MonadIO (DialogT m)

type DialogIO = DialogT IO

Dialog with IO as the base monad.

dialog :: MonadIO m => DialogIO () -> m ()

Opens a dialog window and runs the given dialog in it.

Changing title and end message

changeTitle :: String -> DialogT m ()

Changes the title of the dialog window. Default: "Dialog"

changeEndMessage :: String -> DialogT m ()

Changes the end message of the dialog. Default: "End of program."

Simple messages

displayLine :: String -> DialogT m ()

Displays a plain-text single-line message.

Asking for input

askLine :: String -> DialogT m String

Asks the user for a line of text.

Formatted messages

display :: [Paragraph] -> DialogT m ()

Displays a message.

p :: FormattedText -> Paragraph

Shorthand for TextParagraph.

(<>) :: Monoid m => m -> m -> m infixr 6

An infix synonym for mappend.

Since: 4.5.0.0

str :: String -> FormattedText

Converts a String to a FormattedText. Shorthand for Plain.

b :: FormattedText -> FormattedText

Makes a text bold. Shorthand for Bold.

i :: FormattedText -> FormattedText

Makes a text italic. Shorthand for Italic.

u :: FormattedText -> FormattedText

Makes a text underlined. Shorthand for Underline.

color :: Color -> FormattedText -> FormattedText

Changes the color of a text. Alias of Colored.

size :: FontSize -> FormattedText -> FormattedText

Changes the size of a text. Alias of Size.

url :: String -> FormattedText

Makes an unlabeled link. Shorthand for (Link url (Plain url)).

ol :: [ListItem] -> Paragraph

Makes a numbered list. Shorthand for (List NumberedList items).

ul :: [ListItem] -> Paragraph

Makes a bullet list. Shorthand for (List BulletList items).

li :: FormattedText -> ListItem

Makes a single-line list item. Shorthand for (ListItem [TextParagraph text]).

li' :: [Paragraph] -> ListItem

Makes a list item. Shorthand for ListItem.

img :: String -> Paragraph

Shorthand for (Picture (PictureFromURL url)).

table :: [TableRow] -> Paragraph

Makes a table. Alias for Table.

tr :: [TableCell] -> TableRow

Makes a table row. Shorthand for TableRow.

th :: FormattedText -> TableCell

Makes a table header cell with a single line of text in it. Shorthand for (TableCell HeaderCell [TextParagraph text]).

td :: FormattedText -> TableCell

Makes a normal table cell with a single line of text in it. Shorthand for (TableCell NormalCell [TextParagraph text]).

th' :: [Paragraph] -> TableCell

Makes a header table cell. Shorthand for (TableCell HeaderCell paragraphs).

td' :: [Paragraph] -> TableCell

Makes a normal table cell. Shorthand for (TableCell NormalCell paragraphs).

Using IO

class Monad m => MonadIO m where

Monads in which IO computations may be embedded. Any monad built by applying a sequence of monad transformers to the IO monad will be an instance of this class.

Instances should satisfy the following laws, which state that liftIO is a transformer of monads:

• liftIO . return = return

• liftIO (m >>= f) = liftIO m >>= (liftIO . f)

Methods

liftIO :: IO a -> m a

Lift a computation from the IO monad.

Instances

MonadIO IO

MonadIO m => MonadIO (DialogT m)

MonadIO m => MonadIO (ReaderT r m)

(Error e, MonadIO m) => MonadIO (ErrorT e m)

Formatted text

data Paragraph

Constructors

TextParagraph FormattedText

Picture PictureSource

List ListStyle [ListItem]

Table [TableRow]

Instances

Eq Paragraph

Ord Paragraph

Show Paragraph

data FormattedText

Constructors

Plain String

Colored Color FormattedText

Bold FormattedText

Italic FormattedText

Underline FormattedText

Size FontSize FormattedText

Link String FormattedText

CompositeText [FormattedText]

Instances

Eq FormattedText

Ord FormattedText

Show FormattedText

IsString FormattedText

Monoid FormattedText

data PictureSource

Constructors

PictureFromURL String

Instances

Eq PictureSource

Ord PictureSource

Show PictureSource

data ListStyle

Constructors

NumberedList

BulletList

Instances

Eq ListStyle

Ord ListStyle

Show ListStyle

newtype ListItem

Constructors

ListItem [Paragraph]

Instances

Eq ListItem

Ord ListItem

Show ListItem

newtype TableRow

Constructors

TableRow [TableCell]

Instances

Eq TableRow

Ord TableRow

Show TableRow

data TableCell

Constructors

TableCell CellStyle [Paragraph]

Instances

Eq TableCell

Ord TableCell

Show TableCell

data CellStyle

Constructors

NormalCell

HeaderCell

Instances

Eq CellStyle

Ord CellStyle

Show CellStyle

Font size

data FontSize

Font size (in percent of the base font size).

Instances

Eq FontSize

Num FontSize

Ord FontSize

Show FontSize

Colors

data Color

Color.

Instances

Eq Color

Ord Color

Show Color

white :: Color

Pure white (red: 255, green: 255, blue: 255).

black :: Color

Pure black (red: 0, green: 0, blue: 0).

red :: Color

Pure red (red: 255, green: 0, blue: 0).

green :: Color

Pure green (red: 0, green: 255, blue: 0).

blue :: Color

Pure blue (red: 0, green: 0, blue: 255).

rgb :: Word8 -> Word8 -> Word8 -> Color

Makes a color from red, green and blue components.

toRGB :: Color -> (Word8, Word8, Word8)

Unpacks a color into red, green and blue components.