Monomer.Widgets.Containers.Box

Container for a single item, providing functionalities that may not be available in other widgets.

Useful in different layout situations, since it provides alignment options. This allows for the inner widget to keep its size while being positioned more explicitly, while the box takes up the complete space assigned by its parent (in particular for containers which do not follow SizeReq restrictions, such as Grid).

box_ [alignRight, alignBottom] $
  image "assets/test-image.jpg"
    `styleBasic` [width 100, height 100]

Can be used to add padding to an inner widget with a border. This is equivalent to the margin property in CSS.

-- Padding is inside the border
content = label "Message"
  `styleBasic` [padding 5, border 1 black]
-- Padding in the wrapper box acts as margin
container = box content
  `styleBasic` [padding 5]

Also useful to handle click events in complex widget structures (for example, a label with an image at its side).

content = vstack [
    label "All the content widget is clickable",
    spacer,
    image "assets/test-image.jpg"
  ]
clickableItem = box_ [onClick ItemClicked] content
  `styleBasic' [cursorHand]

Configuration

data BoxCfg s e

Configuration options for box:

• mergeRequired: function called during merge that receives the old and new model, returning True in case the child widget needs to be merged. Since by default merge is required, this function can be used to restrict merging when it would be expensive and it is not necessary. For example, a list of widgets representing search result only needs to be updated when the list of results changes, not while the user inputs new search criteria (which also triggers a model change and, hence, the merge process).
• ignoreEmptyArea: when the inner widget does not use all the available space, ignoring the unassigned space allows for mouse events to pass through. This is useful in zstack layers.
• sizeReqUpdater: allows modifying the SizeReq generated by the inner widget.
• alignLeft: aligns the inner widget to the left.
• alignCenter: aligns the inner widget to the horizontal center.
• alignRight: aligns the inner widget to the right.
• alignTop: aligns the inner widget to the top.
• alignMiddle: aligns the inner widget to the vertical middle.
• alignBottom: aligns the inner widget to the bottom.
• 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.
• onEnter: on mouse enter event.
• onEnterReq: generates a WidgetRequest on mouse enter.
• onLeave: on mouse leave event.
• onLeaveReq: generates a WidgetRequest on mouse leave.
• onClick: click event.
• onClickReq: generates a WidgetRequest on click.
• onClickEmpty: click event on empty area.
• onClickEmptyReq: generates a WidgetRequest on click in empty area.
• onBtnPressed: on button pressed event.
• onBtnPressedReq: generates a WidgetRequest when button is pressed.
• onBtnReleased: on button released event.
• onBtnReleasedReq: generates a WidgetRequest when button is released.
• expandContent: if the inner widget should use all the available space. To be able to use alignment options, this must be False (the default).
• boxFilterEvent: allows filtering or modifying a SystemEvent.

Instances

Monoid (BoxCfg s e)

Defined in Monomer.Widgets.Containers.Box

Methods

mempty :: BoxCfg s e

mappend :: BoxCfg s e -> BoxCfg s e -> BoxCfg s e

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

Semigroup (BoxCfg s e)

Defined in Monomer.Widgets.Containers.Box

Methods

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

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

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

Default (BoxCfg s e)

Defined in Monomer.Widgets.Containers.Box

Methods

def :: BoxCfg s e

CmbAlignBottom (BoxCfg s e)

Defined in Monomer.Widgets.Containers.Box

Methods

alignBottom :: BoxCfg s e

alignBottom_ :: Bool -> BoxCfg s e

CmbAlignCenter (BoxCfg s e)

Defined in Monomer.Widgets.Containers.Box

Methods

alignCenter :: BoxCfg s e

alignCenter_ :: Bool -> BoxCfg s e

CmbAlignLeft (BoxCfg s e)

Defined in Monomer.Widgets.Containers.Box

Methods

alignLeft :: BoxCfg s e

alignLeft_ :: Bool -> BoxCfg s e

CmbAlignMiddle (BoxCfg s e)

Defined in Monomer.Widgets.Containers.Box

Methods

alignMiddle :: BoxCfg s e

alignMiddle_ :: Bool -> BoxCfg s e

CmbAlignRight (BoxCfg s e)

Defined in Monomer.Widgets.Containers.Box

Methods

alignRight :: BoxCfg s e

alignRight_ :: Bool -> BoxCfg s e

CmbAlignTop (BoxCfg s e)

Defined in Monomer.Widgets.Containers.Box

Methods

alignTop :: BoxCfg s e

alignTop_ :: Bool -> BoxCfg s e

CmbIgnoreEmptyArea (BoxCfg s e)

Defined in Monomer.Widgets.Containers.Box

Methods

ignoreEmptyArea :: BoxCfg s e

ignoreEmptyArea_ :: Bool -> BoxCfg s e

CmbSizeReqUpdater (BoxCfg s e)

Defined in Monomer.Widgets.Containers.Box

Methods

sizeReqUpdater :: ((SizeReq, SizeReq) -> (SizeReq, SizeReq)) -> BoxCfg s e

WidgetEvent e => CmbOnBtnPressed (BoxCfg s e) e

Defined in Monomer.Widgets.Containers.Box

Methods

onBtnPressed :: (Button -> Int -> e) -> BoxCfg s e

WidgetEvent e => CmbOnBtnReleased (BoxCfg s e) e

Defined in Monomer.Widgets.Containers.Box

Methods

onBtnReleased :: (Button -> Int -> e) -> BoxCfg s e

WidgetEvent e => CmbOnClick (BoxCfg s e) e

Defined in Monomer.Widgets.Containers.Box

Methods

onClick :: e -> BoxCfg s e

WidgetEvent e => CmbOnClickEmpty (BoxCfg s e) e

Defined in Monomer.Widgets.Containers.Box

Methods

onClickEmpty :: e -> BoxCfg s e

WidgetEvent e => CmbOnEnter (BoxCfg s e) e

Defined in Monomer.Widgets.Containers.Box

Methods

onEnter :: e -> BoxCfg s e

WidgetEvent e => CmbOnLeave (BoxCfg s e) e

Defined in Monomer.Widgets.Containers.Box

Methods

onLeave :: e -> BoxCfg s e

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

Defined in Monomer.Widgets.Containers.Box

Methods

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

CmbOnBtnPressedReq (BoxCfg s e) s e

Defined in Monomer.Widgets.Containers.Box

Methods

onBtnPressedReq :: (Button -> Int -> WidgetRequest s e) -> BoxCfg s e

CmbOnBtnReleasedReq (BoxCfg s e) s e

Defined in Monomer.Widgets.Containers.Box

Methods

onBtnReleasedReq :: (Button -> Int -> WidgetRequest s e) -> BoxCfg s e

CmbOnClickEmptyReq (BoxCfg s e) s e

Defined in Monomer.Widgets.Containers.Box

Methods

onClickEmptyReq :: WidgetRequest s e -> BoxCfg s e

CmbOnClickReq (BoxCfg s e) s e

Defined in Monomer.Widgets.Containers.Box

Methods

onClickReq :: WidgetRequest s e -> BoxCfg s e

CmbOnEnterReq (BoxCfg s e) s e

Defined in Monomer.Widgets.Containers.Box

Methods

onEnterReq :: WidgetRequest s e -> BoxCfg s e

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

Defined in Monomer.Widgets.Containers.Box

Methods

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

CmbOnLeaveReq (BoxCfg s e) s e

Defined in Monomer.Widgets.Containers.Box

Methods

onLeaveReq :: WidgetRequest s e -> BoxCfg s e

CmbOnBlurReq (BoxCfg s e) s e Path

Defined in Monomer.Widgets.Containers.Box

Methods

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

CmbOnFocusReq (BoxCfg s e) s e Path

Defined in Monomer.Widgets.Containers.Box

Methods

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

CmbMergeRequired (BoxCfg s e) (WidgetEnv s e) s

Defined in Monomer.Widgets.Containers.Box

Methods

mergeRequired :: (WidgetEnv s e -> s -> s -> Bool) -> BoxCfg s e

expandContent :: BoxCfg s e

Assigns all the available space to its contained child.

boxFilterEvent :: ContainerFilterHandler s e -> BoxCfg s e

Receives a System event and, optionally, modifies the event, its target, or stops the event propagation by returning Nothing.

Constructors

box

Arguments

:: (WidgetModel s, WidgetEvent e)

=> WidgetNode s e

The child node.

-> WidgetNode s e

The created box container.

Creates a box widget with a single node as child.

box_

Arguments

:: (WidgetModel s, WidgetEvent e)

=> [BoxCfg s e]

The config options.

-> WidgetNode s e

The child node.

-> WidgetNode s e

The created box container.

Creates a box widget with a single node as child. Accepts config.