Monomer.Widgets.Singles.Button

Button widget, with support for multiline text. At the most basic level, a button consists of a caption and an event to raise when clicked.

button "Increase count" AppIncrease

Configuration

data ButtonCfg s e

Configuration options for button:

• ignoreParentEvts: whether to ignore all other responses to the click or keypress that triggered the button, and only keep this button's response. Useful when the button is child of a _keystroke_ widget.
• trimSpaces: whether to remove leading/trailing spaces in the caption.
• ellipsis: if ellipsis should be used for overflown text.
• multiline: if text may be split in multiple lines.
• maxLines: maximum number of text lines to show.
• ignoreTheme: whether to load default style from theme or start empty.
• resizeFactor: flexibility to have more or less space assigned.
• resizeFactorW: flexibility to have more or less horizontal space assigned.
• resizeFactorH: flexibility to have more or less vertical space assigned.
• onFocus: event to raise when focus is received.
• onFocusReq: WidgetRequest to generate when focus is received.
• onBlur: event to raise when focus is lost.
• onBlurReq: WidgetRequest to generate when focus is lost.
• onClick: event to raise when button is clicked.
• onClickReq: WidgetRequest to generate when button is clicked.

Instances

Monoid (ButtonCfg s e)

Defined in Monomer.Widgets.Singles.Button

Methods

mempty :: ButtonCfg s e

mappend :: ButtonCfg s e -> ButtonCfg s e -> ButtonCfg s e

mconcat :: [ButtonCfg s e] -> ButtonCfg s e

Semigroup (ButtonCfg s e)

Defined in Monomer.Widgets.Singles.Button

Methods

(<>) :: ButtonCfg s e -> ButtonCfg s e -> ButtonCfg s e

sconcat :: NonEmpty (ButtonCfg s e) -> ButtonCfg s e

stimes :: Integral b => b -> ButtonCfg s e -> ButtonCfg s e

Default (ButtonCfg s e)

Defined in Monomer.Widgets.Singles.Button

Methods

def :: ButtonCfg s e

CmbEllipsis (ButtonCfg s e)

Defined in Monomer.Widgets.Singles.Button

Methods

ellipsis :: ButtonCfg s e

ellipsis_ :: Bool -> ButtonCfg s e

CmbIgnoreParentEvts (ButtonCfg s e)

Defined in Monomer.Widgets.Singles.Button

Methods

ignoreParentEvts :: ButtonCfg s e

ignoreParentEvts_ :: Bool -> ButtonCfg s e

CmbIgnoreTheme (ButtonCfg s e)

Defined in Monomer.Widgets.Singles.Button

Methods

ignoreTheme :: ButtonCfg s e

ignoreTheme_ :: Bool -> ButtonCfg s e

CmbMaxLines (ButtonCfg s e)

Defined in Monomer.Widgets.Singles.Button

Methods

maxLines :: Int -> ButtonCfg s e

CmbMultiline (ButtonCfg s e)

Defined in Monomer.Widgets.Singles.Button

Methods

multiline :: ButtonCfg s e

multiline_ :: Bool -> ButtonCfg s e

CmbResizeFactor (ButtonCfg s e)

Defined in Monomer.Widgets.Singles.Button

Methods

resizeFactor :: Double -> ButtonCfg s e

CmbResizeFactorDim (ButtonCfg s e)

Defined in Monomer.Widgets.Singles.Button

Methods

resizeFactorW :: Double -> ButtonCfg s e

resizeFactorH :: Double -> ButtonCfg s e

CmbTrimSpaces (ButtonCfg s e)

Defined in Monomer.Widgets.Singles.Button

Methods

trimSpaces :: ButtonCfg s e

trimSpaces_ :: Bool -> ButtonCfg s e

WidgetEvent e => CmbOnClick (ButtonCfg s e) e

Defined in Monomer.Widgets.Singles.Button

Methods

onClick :: e -> ButtonCfg s e

WidgetEvent e => CmbOnBlur (ButtonCfg s e) e Path

Defined in Monomer.Widgets.Singles.Button

Methods

onBlur :: (Path -> e) -> ButtonCfg s e

CmbOnClickReq (ButtonCfg s e) s e

Defined in Monomer.Widgets.Singles.Button

Methods

onClickReq :: WidgetRequest s e -> ButtonCfg s e

WidgetEvent e => CmbOnFocus (ButtonCfg s e) e Path

Defined in Monomer.Widgets.Singles.Button

Methods

onFocus :: (Path -> e) -> ButtonCfg s e

CmbOnBlurReq (ButtonCfg s e) s e Path

Defined in Monomer.Widgets.Singles.Button

Methods

onBlurReq :: (Path -> WidgetRequest s e) -> ButtonCfg s e

CmbOnFocusReq (ButtonCfg s e) s e Path

Defined in Monomer.Widgets.Singles.Button

Methods

onFocusReq :: (Path -> WidgetRequest s e) -> ButtonCfg s e

Constructors

mainButton

Arguments

:: WidgetEvent e

=> Text

The caption.

-> e

The event to raise on click.

-> WidgetNode s e

The created button.

Creates a button with main styling. Useful to highlight an option, such as "Accept", when multiple buttons are available.

mainButton_

Arguments

:: WidgetEvent e

=> Text

The caption.

-> e

The event to raise on click.

-> [ButtonCfg s e]

The config options.

-> WidgetNode s e

The created button.

Creates a button with main styling. Useful to highlight an option, such as "Accept", when multiple buttons are available. Accepts config.

mainButtonD_

Arguments

:: WidgetEvent e

=> Text

The caption.

-> [ButtonCfg s e]

The config options.

-> WidgetNode s e

The created button.

Creates a button with main styling. Useful to highlight an option, such as "Accept", when multiple buttons are available. Accepts config but does not require an event. See buttonD_.

button

Arguments

:: WidgetEvent e

=> Text

The caption.

-> e

The event to raise on click.

-> WidgetNode s e

The created button.

Creates a button with normal styling.

button_

Arguments

:: WidgetEvent e

=> Text

The caption.

-> e

The event to raise on click.

-> [ButtonCfg s e]

The config options.

-> WidgetNode s e

The created button.

Creates a button with normal styling. Accepts config.

buttonD_

Arguments

:: WidgetEvent e

=> Text

The caption.

-> [ButtonCfg s e]

The config options.

-> WidgetNode s e

The created button.

Creates a button without forcing an event to be provided. The other constructors use this version, adding an onClick handler in configs.

Using this constructor directly can be helpful in cases where the event to be raised belongs in a Monomer.Widgets.Composite above in the widget tree, outside the scope of the Composite that contains the button. This parent Composite can be reached by sending a message (SendMessage) to its WidgetId using onClickReq.