GI.Gtk.Objects.Box

The GtkBox widget organizes child widgets into a rectangular area.

The rectangular area of a GtkBox is organized into either a single row or a single column of child widgets depending upon the orientation. Thus, all children of a GtkBox are allocated one dimension in common, which is the height of a row, or the width of a column.

GtkBox uses a notion of packing. Packing refers to adding widgets with reference to a particular position in a Container. For a GtkBox, there are two reference positions: the start and the end of the box. For a vertical Box, the start is defined as the top of the box and the end is defined as the bottom. For a horizontal Box the start is defined as the left side and the end is defined as the right side.

Use repeated calls to boxPackStart to pack widgets into a GtkBox from start to end. Use boxPackEnd to add widgets from end to start. You may intersperse these calls and add widgets from both ends of the same GtkBox.

Because GtkBox is a Container, you may also use containerAdd to insert widgets into the box, and they will be packed with the default values for expand and fill child properties. Use containerRemove to remove widgets from the GtkBox.

Use boxSetHomogeneous to specify whether or not all children of the GtkBox are forced to get the same amount of space.

Use boxSetSpacing to determine how much space will be minimally placed between all children in the GtkBox. Note that spacing is added between the children, while padding added by boxPackStart or boxPackEnd is added on either side of the widget it belongs to.

Use boxReorderChild to move a GtkBox child to a different place in the box.

Use boxSetChildPacking to reset the expand, fill and padding child properties. Use boxQueryChildPacking to query these fields.

Note that a single-row or single-column Grid provides exactly the same functionality as Box.

CSS nodes

GtkBox uses a single CSS node with name box.

In horizontal orientation, the nodes of the children are always arranged from left to right. So :first-child will always select the leftmost child, regardless of text direction.

Exported types

newtype Box

Constructors

Box (ManagedPtr Box)

Instances

GObject Box

Methods

gobjectType :: Box -> IO GType

IsImplementorIface Box

IsObject Box

IsWidget Box

IsContainer Box

IsBox Box

IsOrientable Box

IsBuildable Box

((~) * info (ResolveBoxMethod t Box), MethodInfo * info Box p) => IsLabel t (Box -> p)

Methods

fromLabel :: Proxy# Symbol t -> Box -> p

((~) * info (ResolveBoxMethod t Box), MethodInfo * info Box p) => IsLabelProxy t (Box -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> Box -> p

HasAttributeList * Box

type AttributeList Box

type AttributeList Box

type SignalList Box

type SignalList Box

class GObject o => IsBox o

Instances

(GObject a, UnknownAncestorError Constraint Box a) => IsBox a

IsBox ButtonBox

IsBox Box

IsBox ColorChooserWidget

IsBox ColorSelection

IsBox FontChooserWidget

IsBox FontSelection

IsBox HBox

IsBox HButtonBox

IsBox RecentChooserWidget

IsBox ShortcutLabel

IsBox ShortcutsGroup

IsBox ShortcutsSection

IsBox StackSwitcher

IsBox Statusbar

IsBox VBox

IsBox VButtonBox

IsBox AppChooserWidget

IsBox FileChooserButton

IsBox FileChooserWidget

IsBox InfoBar

IsBox ShortcutsShortcut

toBox :: IsBox o => o -> IO Box

noBox :: Maybe Box

Methods

getBaselinePosition

data BoxGetBaselinePositionMethodInfo

Instances

((~) * signature (m BaselinePosition), MonadIO m, IsBox a) => MethodInfo * BoxGetBaselinePositionMethodInfo a signature

Methods

overloadedMethod :: MethodProxy BoxGetBaselinePositionMethodInfo a -> signature -> s

boxGetBaselinePosition

Arguments

:: (HasCallStack, MonadIO m, IsBox a)

=> a

box: a Box

-> m BaselinePosition

Returns: the baseline position

Gets the value set by boxSetBaselinePosition.

Since: 3.10

getCenterWidget

data BoxGetCenterWidgetMethodInfo

Instances

((~) * signature (m (Maybe Widget)), MonadIO m, IsBox a) => MethodInfo * BoxGetCenterWidgetMethodInfo a signature

Methods

overloadedMethod :: MethodProxy BoxGetCenterWidgetMethodInfo a -> signature -> s

boxGetCenterWidget

Arguments

:: (HasCallStack, MonadIO m, IsBox a)

=> a

box: a Box

-> m (Maybe Widget)

Returns: the center widget or Nothing in case no center widget is set.

Retrieves the center widget of the box.

Since: 3.12

getHomogeneous

data BoxGetHomogeneousMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsBox a) => MethodInfo * BoxGetHomogeneousMethodInfo a signature

Methods

overloadedMethod :: MethodProxy BoxGetHomogeneousMethodInfo a -> signature -> s

boxGetHomogeneous

Arguments

:: (HasCallStack, MonadIO m, IsBox a)

=> a

box: a Box

-> m Bool

Returns: True if the box is homogeneous.

Returns whether the box is homogeneous (all children are the same size). See boxSetHomogeneous.

getSpacing

data BoxGetSpacingMethodInfo

Instances

((~) * signature (m Int32), MonadIO m, IsBox a) => MethodInfo * BoxGetSpacingMethodInfo a signature

Methods

overloadedMethod :: MethodProxy BoxGetSpacingMethodInfo a -> signature -> s

boxGetSpacing

Arguments

:: (HasCallStack, MonadIO m, IsBox a)

=> a

box: a Box

-> m Int32

Returns: spacing between children

Gets the value set by boxSetSpacing.

new

boxNew

Arguments

:: (HasCallStack, MonadIO m)

=> Orientation

orientation: the box’s orientation.

-> Int32

spacing: the number of pixels to place by default between children.

-> m Box

Returns: a new Box.

Creates a new Box.

Since: 3.0

packEnd

data BoxPackEndMethodInfo

Instances

((~) * signature (b -> Bool -> Bool -> Word32 -> m ()), MonadIO m, IsBox a, IsWidget b) => MethodInfo * BoxPackEndMethodInfo a signature

Methods

overloadedMethod :: MethodProxy BoxPackEndMethodInfo a -> signature -> s

boxPackEnd

Arguments

:: (HasCallStack, MonadIO m, IsBox a, IsWidget b)

=> a

box: a Box

-> b

child: the Widget to be added to box

-> Bool

expand: True if the new child is to be given extra space allocated to box. The extra space will be divided evenly between all children of box that use this option

-> Bool

fill: True if space given to child by the expand option is actually allocated to child, rather than just padding it. This parameter has no effect if expand is set to False. A child is always allocated the full height of a horizontal Box and the full width of a vertical Box. This option affects the other dimension

-> Word32

padding: extra space in pixels to put between this child and its neighbors, over and above the global amount specified by Box:spacing property. If child is a widget at one of the reference ends of box, then padding pixels are also put between child and the reference edge of box

-> m ()

Adds child to box, packed with reference to the end of box. The child is packed after (away from end of) any other child packed with reference to the end of box.

packStart

data BoxPackStartMethodInfo

Instances

((~) * signature (b -> Bool -> Bool -> Word32 -> m ()), MonadIO m, IsBox a, IsWidget b) => MethodInfo * BoxPackStartMethodInfo a signature

Methods

overloadedMethod :: MethodProxy BoxPackStartMethodInfo a -> signature -> s

boxPackStart

Arguments

:: (HasCallStack, MonadIO m, IsBox a, IsWidget b)

=> a

box: a Box

-> b

child: the Widget to be added to box

-> Bool

expand: True if the new child is to be given extra space allocated to box. The extra space will be divided evenly between all children that use this option

-> Bool

fill: True if space given to child by the expand option is actually allocated to child, rather than just padding it. This parameter has no effect if expand is set to False. A child is always allocated the full height of a horizontal Box and the full width of a vertical Box. This option affects the other dimension

-> Word32

padding: extra space in pixels to put between this child and its neighbors, over and above the global amount specified by Box:spacing property. If child is a widget at one of the reference ends of box, then padding pixels are also put between child and the reference edge of box

-> m ()

Adds child to box, packed with reference to the start of box. The child is packed after any other child packed with reference to the start of box.

queryChildPacking

data BoxQueryChildPackingMethodInfo

Instances

((~) * signature (b -> m (Bool, Bool, Word32, PackType)), MonadIO m, IsBox a, IsWidget b) => MethodInfo * BoxQueryChildPackingMethodInfo a signature

Methods

overloadedMethod :: MethodProxy BoxQueryChildPackingMethodInfo a -> signature -> s

boxQueryChildPacking

Arguments

:: (HasCallStack, MonadIO m, IsBox a, IsWidget b)

=> a

box: a Box

-> b

child: the Widget of the child to query

-> m (Bool, Bool, Word32, PackType)

Obtains information about how child is packed into box.

reorderChild

data BoxReorderChildMethodInfo

Instances

((~) * signature (b -> Int32 -> m ()), MonadIO m, IsBox a, IsWidget b) => MethodInfo * BoxReorderChildMethodInfo a signature

Methods

overloadedMethod :: MethodProxy BoxReorderChildMethodInfo a -> signature -> s

boxReorderChild

Arguments

:: (HasCallStack, MonadIO m, IsBox a, IsWidget b)

=> a

box: a Box

-> b

child: the Widget to move

-> Int32

position: the new position for child in the list of children of box, starting from 0. If negative, indicates the end of the list

-> m ()

Moves child to a new position in the list of box children. The list contains widgets packed GTK_PACK_START as well as widgets packed GTK_PACK_END, in the order that these widgets were added to box.

A widget’s position in the box children list determines where the widget is packed into box. A child widget at some position in the list will be packed just after all other widgets of the same packing type that appear earlier in the list.

setBaselinePosition

data BoxSetBaselinePositionMethodInfo

Instances

((~) * signature (BaselinePosition -> m ()), MonadIO m, IsBox a) => MethodInfo * BoxSetBaselinePositionMethodInfo a signature

Methods

overloadedMethod :: MethodProxy BoxSetBaselinePositionMethodInfo a -> signature -> s

boxSetBaselinePosition

Arguments

:: (HasCallStack, MonadIO m, IsBox a)

=> a

box: a Box

-> BaselinePosition

position: a BaselinePosition

-> m ()

Sets the baseline position of a box. This affects only horizontal boxes with at least one baseline aligned child. If there is more vertical space available than requested, and the baseline is not allocated by the parent then position is used to allocate the baseline wrt the extra space available.

Since: 3.10

setCenterWidget

data BoxSetCenterWidgetMethodInfo

Instances

((~) * signature (Maybe b -> m ()), MonadIO m, IsBox a, IsWidget b) => MethodInfo * BoxSetCenterWidgetMethodInfo a signature

Methods

overloadedMethod :: MethodProxy BoxSetCenterWidgetMethodInfo a -> signature -> s

boxSetCenterWidget

Arguments

:: (HasCallStack, MonadIO m, IsBox a, IsWidget b)

=> a

box: a Box

-> Maybe b

widget: the widget to center

-> m ()

Sets a center widget; that is a child widget that will be centered with respect to the full width of the box, even if the children at either side take up different amounts of space.

Since: 3.12

setChildPacking

data BoxSetChildPackingMethodInfo

Instances

((~) * signature (b -> Bool -> Bool -> Word32 -> PackType -> m ()), MonadIO m, IsBox a, IsWidget b) => MethodInfo * BoxSetChildPackingMethodInfo a signature

Methods

overloadedMethod :: MethodProxy BoxSetChildPackingMethodInfo a -> signature -> s

boxSetChildPacking

Arguments

:: (HasCallStack, MonadIO m, IsBox a, IsWidget b)

=> a

box: a Box

-> b

child: the Widget of the child to set

-> Bool

expand: the new value of the expand child property

-> Bool

fill: the new value of the fill child property

-> Word32

padding: the new value of the padding child property

-> PackType

packType: the new value of the pack-type child property

-> m ()

Sets the way child is packed into box.

setHomogeneous

data BoxSetHomogeneousMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsBox a) => MethodInfo * BoxSetHomogeneousMethodInfo a signature

Methods

overloadedMethod :: MethodProxy BoxSetHomogeneousMethodInfo a -> signature -> s

boxSetHomogeneous

Arguments

:: (HasCallStack, MonadIO m, IsBox a)

=> a

box: a Box

-> Bool

homogeneous: a boolean value, True to create equal allotments, False for variable allotments

-> m ()

Sets the Box:homogeneous property of box, controlling whether or not all children of box are given equal space in the box.

setSpacing

data BoxSetSpacingMethodInfo

Instances

((~) * signature (Int32 -> m ()), MonadIO m, IsBox a) => MethodInfo * BoxSetSpacingMethodInfo a signature

Methods

overloadedMethod :: MethodProxy BoxSetSpacingMethodInfo a -> signature -> s

boxSetSpacing

Arguments

:: (HasCallStack, MonadIO m, IsBox a)

=> a

box: a Box

-> Int32

spacing: the number of pixels to put between children

-> m ()

Sets the Box:spacing property of box, which is the number of pixels to place between children of box.

Properties

baselinePosition

data BoxBaselinePositionPropertyInfo

Instances

AttrInfo BoxBaselinePositionPropertyInfo

Associated Types

type AttrAllowedOps BoxBaselinePositionPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint BoxBaselinePositionPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint BoxBaselinePositionPropertyInfo :: * -> Constraint

type AttrGetType BoxBaselinePositionPropertyInfo :: *

type AttrLabel BoxBaselinePositionPropertyInfo :: Symbol

type AttrOrigin BoxBaselinePositionPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint BoxBaselinePositionPropertyInfo o => Proxy * BoxBaselinePositionPropertyInfo -> o -> IO (AttrGetType BoxBaselinePositionPropertyInfo)

attrSet :: (AttrBaseTypeConstraint BoxBaselinePositionPropertyInfo o, AttrSetTypeConstraint BoxBaselinePositionPropertyInfo b) => Proxy * BoxBaselinePositionPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint BoxBaselinePositionPropertyInfo o => Proxy * BoxBaselinePositionPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint BoxBaselinePositionPropertyInfo o, AttrSetTypeConstraint BoxBaselinePositionPropertyInfo b) => Proxy * BoxBaselinePositionPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin BoxBaselinePositionPropertyInfo

type AttrOrigin BoxBaselinePositionPropertyInfo = Box

type AttrLabel BoxBaselinePositionPropertyInfo

type AttrLabel BoxBaselinePositionPropertyInfo = "baseline-position"

type AttrGetType BoxBaselinePositionPropertyInfo

type AttrGetType BoxBaselinePositionPropertyInfo = BaselinePosition

type AttrBaseTypeConstraint BoxBaselinePositionPropertyInfo

type AttrBaseTypeConstraint BoxBaselinePositionPropertyInfo = IsBox

type AttrSetTypeConstraint BoxBaselinePositionPropertyInfo

type AttrSetTypeConstraint BoxBaselinePositionPropertyInfo = * ~ BaselinePosition

type AttrAllowedOps BoxBaselinePositionPropertyInfo

type AttrAllowedOps BoxBaselinePositionPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

boxBaselinePosition :: AttrLabelProxy "baselinePosition"

constructBoxBaselinePosition :: IsBox o => BaselinePosition -> IO (GValueConstruct o)

getBoxBaselinePosition :: (MonadIO m, IsBox o) => o -> m BaselinePosition

setBoxBaselinePosition :: (MonadIO m, IsBox o) => o -> BaselinePosition -> m ()

homogeneous

data BoxHomogeneousPropertyInfo

Instances

AttrInfo BoxHomogeneousPropertyInfo

Associated Types

type AttrAllowedOps BoxHomogeneousPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint BoxHomogeneousPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint BoxHomogeneousPropertyInfo :: * -> Constraint

type AttrGetType BoxHomogeneousPropertyInfo :: *

type AttrLabel BoxHomogeneousPropertyInfo :: Symbol

type AttrOrigin BoxHomogeneousPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint BoxHomogeneousPropertyInfo o => Proxy * BoxHomogeneousPropertyInfo -> o -> IO (AttrGetType BoxHomogeneousPropertyInfo)

attrSet :: (AttrBaseTypeConstraint BoxHomogeneousPropertyInfo o, AttrSetTypeConstraint BoxHomogeneousPropertyInfo b) => Proxy * BoxHomogeneousPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint BoxHomogeneousPropertyInfo o => Proxy * BoxHomogeneousPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint BoxHomogeneousPropertyInfo o, AttrSetTypeConstraint BoxHomogeneousPropertyInfo b) => Proxy * BoxHomogeneousPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin BoxHomogeneousPropertyInfo

type AttrOrigin BoxHomogeneousPropertyInfo = Box

type AttrLabel BoxHomogeneousPropertyInfo

type AttrLabel BoxHomogeneousPropertyInfo = "homogeneous"

type AttrGetType BoxHomogeneousPropertyInfo

type AttrGetType BoxHomogeneousPropertyInfo = Bool

type AttrBaseTypeConstraint BoxHomogeneousPropertyInfo

type AttrBaseTypeConstraint BoxHomogeneousPropertyInfo = IsBox

type AttrSetTypeConstraint BoxHomogeneousPropertyInfo

type AttrSetTypeConstraint BoxHomogeneousPropertyInfo = * ~ Bool

type AttrAllowedOps BoxHomogeneousPropertyInfo

type AttrAllowedOps BoxHomogeneousPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

boxHomogeneous :: AttrLabelProxy "homogeneous"

constructBoxHomogeneous :: IsBox o => Bool -> IO (GValueConstruct o)

getBoxHomogeneous :: (MonadIO m, IsBox o) => o -> m Bool

setBoxHomogeneous :: (MonadIO m, IsBox o) => o -> Bool -> m ()

spacing

data BoxSpacingPropertyInfo

Instances

AttrInfo BoxSpacingPropertyInfo

Associated Types

type AttrAllowedOps BoxSpacingPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint BoxSpacingPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint BoxSpacingPropertyInfo :: * -> Constraint

type AttrGetType BoxSpacingPropertyInfo :: *

type AttrLabel BoxSpacingPropertyInfo :: Symbol

type AttrOrigin BoxSpacingPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint BoxSpacingPropertyInfo o => Proxy * BoxSpacingPropertyInfo -> o -> IO (AttrGetType BoxSpacingPropertyInfo)

attrSet :: (AttrBaseTypeConstraint BoxSpacingPropertyInfo o, AttrSetTypeConstraint BoxSpacingPropertyInfo b) => Proxy * BoxSpacingPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint BoxSpacingPropertyInfo o => Proxy * BoxSpacingPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint BoxSpacingPropertyInfo o, AttrSetTypeConstraint BoxSpacingPropertyInfo b) => Proxy * BoxSpacingPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin BoxSpacingPropertyInfo

type AttrOrigin BoxSpacingPropertyInfo = Box

type AttrLabel BoxSpacingPropertyInfo

type AttrLabel BoxSpacingPropertyInfo = "spacing"

type AttrGetType BoxSpacingPropertyInfo

type AttrGetType BoxSpacingPropertyInfo = Int32

type AttrBaseTypeConstraint BoxSpacingPropertyInfo

type AttrBaseTypeConstraint BoxSpacingPropertyInfo = IsBox

type AttrSetTypeConstraint BoxSpacingPropertyInfo

type AttrSetTypeConstraint BoxSpacingPropertyInfo = * ~ Int32

type AttrAllowedOps BoxSpacingPropertyInfo

type AttrAllowedOps BoxSpacingPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

boxSpacing :: AttrLabelProxy "spacing"

constructBoxSpacing :: IsBox o => Int32 -> IO (GValueConstruct o)

getBoxSpacing :: (MonadIO m, IsBox o) => o -> m Int32

setBoxSpacing :: (MonadIO m, IsBox o) => o -> Int32 -> m ()