Brick.Widgets.Dialog

This module provides a simple dialog widget. You get to pick the dialog title, if any, as well as its body and buttons.

Documentation

data Dialog a

Dialogs present a window with a title (optional), a body, and buttons (optional). They provide a HandleEvent instance that knows about Tab and Shift-Tab as well as ArrowLeft and ArrowRight for changing which button is active. Dialog buttons are labeled with strings and map to values of type a, which you choose.

Dialogs handle the following events by default:

• Tab: selecte the next button
• Shift-tab: select the previous button

dialogTitle :: Dialog a -> Maybe String

The dialog title

dialogButtons :: Dialog a -> [(String, a)]

The dialog button labels and values

dialogSelectedIndex :: Dialog a -> Maybe Int

The currently selected dialog button index (if any)

dialogWidth :: Dialog a -> Int

The maximum width of the dialog

Construction and rendering

dialog

Arguments

:: Maybe String

The dialog title

-> Maybe (Int, [(String, a)])

The currently-selected button index (starting at zero) and the button labels and values to use

-> Int

The maximum width of the dialog

-> Dialog a

Create a dialog.

renderDialog :: Dialog a -> Widget n -> Widget n

Render a dialog with the specified body widget. This renders the dialog as a layer, which makes this suitable as a top-level layer in your rendering function to be rendered on top of the rest of your interface.

Handling events

handleDialogEvent :: Event -> Dialog a -> EventM n (Dialog a)

Getting a dialog's current value

dialogSelection :: Dialog a -> Maybe a

Obtain the value associated with the dialog's currently-selected button, if any. This function is probably what you want when someone presses Enter in a dialog.

Attributes

dialogAttr :: AttrName

The default attribute of the dialog

buttonAttr :: AttrName

The default attribute for all dialog buttons

buttonSelectedAttr :: AttrName

The attribute for the selected dialog button (extends dialogAttr)

Lenses

dialogButtonsL :: forall a a. Lens (Dialog a) (Dialog a) [(String, a)] [(String, a)]

dialogSelectedIndexL :: forall a. Lens' (Dialog a) (Maybe Int)

dialogWidthL :: forall a. Lens' (Dialog a) Int

dialogTitleL :: forall a. Lens' (Dialog a) (Maybe String)