Monomer.Widgets.Singles.OptionButton

Option button widget, used for choosing one value from a fixed set. Each instance of optionButton is associated with a single value.

optionButton "First option" Option1 optionLens

Its behavior is equivalent to Monomer.Widgets.Singles.Radio and Monomer.Widgets.Singles.LabeledRadio, with a different visual representation.

This widget, and the associated Monomer.Widgets.Singles.ToggleButton, uses two separate styles for the On and Off states which can be modified individually for the theme. If you use any of the the standard style functions (styleBasic, styleHover, etc) in an optionButton/toggleButton these changes will apply to both On and Off states, except for the color related styles. The reason is that, in general, the font and padding will be the same for both states, but the colors will differ. The optionButtonOffStyle option, which receives a Style instance, can be used to change the colors of the Off state. The values set with this option are higher priority than any inherited style from the theme or node text style.

Style instances can be created this way:

newStyle :: Style = def
  `styleBasic` [textSize 20]
  `styleHover` [textColor white]

Configuration

type OptionButtonValue a = (Eq a, Typeable a)

Constraints for numeric types accepted by the optionButton widget.

data OptionButtonCfg s e a

Configuration options for optionButton:

• ignoreTheme: whether to load default style from theme or start empty.
• optionButtonOffStyle: style to use when the option is not active.
• 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.
• resizeFactor: flexibility to have more or less spaced assigned.
• resizeFactorW: flexibility to have more or less horizontal spaced assigned.
• resizeFactorH: flexibility to have more or less vertical spaced 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 the value is clicked.
• onClickReq: WidgetRequest to generate when the value is clicked.
• onChange: event to raise when the value changes.
• onChangeReq: WidgetRequest to generate when the value changes.

Instances

Monoid (OptionButtonCfg s e a)

Defined in Monomer.Widgets.Singles.OptionButton

Methods

mempty :: OptionButtonCfg s e a

mappend :: OptionButtonCfg s e a -> OptionButtonCfg s e a -> OptionButtonCfg s e a

mconcat :: [OptionButtonCfg s e a] -> OptionButtonCfg s e a

Semigroup (OptionButtonCfg s e a)

Defined in Monomer.Widgets.Singles.OptionButton

Methods

(<>) :: OptionButtonCfg s e a -> OptionButtonCfg s e a -> OptionButtonCfg s e a

sconcat :: NonEmpty (OptionButtonCfg s e a) -> OptionButtonCfg s e a

stimes :: Integral b => b -> OptionButtonCfg s e a -> OptionButtonCfg s e a

Default (OptionButtonCfg s e a)

Defined in Monomer.Widgets.Singles.OptionButton

Methods

def :: OptionButtonCfg s e a

CmbEllipsis (OptionButtonCfg s e a)

Defined in Monomer.Widgets.Singles.OptionButton

Methods

ellipsis :: OptionButtonCfg s e a

ellipsis_ :: Bool -> OptionButtonCfg s e a

CmbIgnoreTheme (OptionButtonCfg s e a)

Defined in Monomer.Widgets.Singles.OptionButton

Methods

ignoreTheme :: OptionButtonCfg s e a

ignoreTheme_ :: Bool -> OptionButtonCfg s e a

CmbMaxLines (OptionButtonCfg s e a)

Defined in Monomer.Widgets.Singles.OptionButton

Methods

maxLines :: Int -> OptionButtonCfg s e a

CmbMultiline (OptionButtonCfg s e a)

Defined in Monomer.Widgets.Singles.OptionButton

Methods

multiline :: OptionButtonCfg s e a

multiline_ :: Bool -> OptionButtonCfg s e a

CmbResizeFactor (OptionButtonCfg s e a)

Defined in Monomer.Widgets.Singles.OptionButton

Methods

resizeFactor :: Double -> OptionButtonCfg s e a

CmbResizeFactorDim (OptionButtonCfg s e a)

Defined in Monomer.Widgets.Singles.OptionButton

Methods

resizeFactorW :: Double -> OptionButtonCfg s e a

resizeFactorH :: Double -> OptionButtonCfg s e a

CmbTrimSpaces (OptionButtonCfg s e a)

Defined in Monomer.Widgets.Singles.OptionButton

Methods

trimSpaces :: OptionButtonCfg s e a

trimSpaces_ :: Bool -> OptionButtonCfg s e a

WidgetEvent e => CmbOnClick (OptionButtonCfg s e a) e

Defined in Monomer.Widgets.Singles.OptionButton

Methods

onClick :: e -> OptionButtonCfg s e a

WidgetEvent e => CmbOnBlur (OptionButtonCfg s e a) e Path

Defined in Monomer.Widgets.Singles.OptionButton

Methods

onBlur :: (Path -> e) -> OptionButtonCfg s e a

WidgetEvent e => CmbOnChange (OptionButtonCfg s e a) a e

Defined in Monomer.Widgets.Singles.OptionButton

Methods

onChange :: (a -> e) -> OptionButtonCfg s e a

CmbOnClickReq (OptionButtonCfg s e a) s e

Defined in Monomer.Widgets.Singles.OptionButton

Methods

onClickReq :: WidgetRequest s e -> OptionButtonCfg s e a

WidgetEvent e => CmbOnFocus (OptionButtonCfg s e a) e Path

Defined in Monomer.Widgets.Singles.OptionButton

Methods

onFocus :: (Path -> e) -> OptionButtonCfg s e a

CmbOnBlurReq (OptionButtonCfg s e a) s e Path

Defined in Monomer.Widgets.Singles.OptionButton

Methods

onBlurReq :: (Path -> WidgetRequest s e) -> OptionButtonCfg s e a

CmbOnChangeReq (OptionButtonCfg s e a) s e a

Defined in Monomer.Widgets.Singles.OptionButton

Methods

onChangeReq :: (a -> WidgetRequest s e) -> OptionButtonCfg s e a

CmbOnFocusReq (OptionButtonCfg s e a) s e Path

Defined in Monomer.Widgets.Singles.OptionButton

Methods

onFocusReq :: (Path -> WidgetRequest s e) -> OptionButtonCfg s e a

optionButtonOffStyle :: Style -> OptionButtonCfg s e a

Sets the style for the Off state of the option button.

Constructors

optionButton :: OptionButtonValue a => Text -> a -> ALens' s a -> WidgetNode s e

Creates an optionButton using the given lens.

optionButton_ :: OptionButtonValue a => Text -> a -> ALens' s a -> [OptionButtonCfg s e a] -> WidgetNode s e

Creates an optionButton using the given lens. Accepts config.

optionButtonV :: (OptionButtonValue a, WidgetEvent e) => Text -> a -> a -> (a -> e) -> WidgetNode s e

Creates an optionButton using the given value and onChange event handler.

optionButtonV_ :: (OptionButtonValue a, WidgetEvent e) => Text -> a -> a -> (a -> e) -> [OptionButtonCfg s e a] -> WidgetNode s e

Creates an optionButton using the given value and onChange event handler. Accepts config.

optionButtonD_ :: OptionButtonValue a => Text -> a -> WidgetData s a -> [OptionButtonCfg s e a] -> WidgetNode s e

Creates an optionButton providing a WidgetData instance and config.

Internal

makeOptionButton :: OptionButtonValue a => Lens' ThemeState StyleState -> Lens' ThemeState StyleState -> WidgetData s a -> Text -> (a -> Bool) -> (a -> a) -> OptionButtonCfg s e a -> Widget s e

Helper function for creating a button associated to a value. Used by _optionButton_ and _toggleButton_.