GI.Gtk.Objects.BoxLayout

GtkBoxLayout is a layout manager that arranges children in a single row or column.

Whether it is a row or column depends on the value of its Orientable:orientation property. Within the other dimension all children all allocated the same size. The GtkBoxLayout will respect the Widget:halign and Widget:valign properties of each child widget.

If you want all children to be assigned the same size, you can use the BoxLayout:homogeneous property.

If you want to specify the amount of space placed between each child, you can use the BoxLayout:spacing property.

Exported types

newtype BoxLayout

Memory-managed wrapper type.

Constructors

BoxLayout (ManagedPtr BoxLayout)

Instances

Eq BoxLayout

Defined in GI.Gtk.Objects.BoxLayout

Methods

(==) :: BoxLayout -> BoxLayout -> Bool

(/=) :: BoxLayout -> BoxLayout -> Bool

GObject BoxLayout

Defined in GI.Gtk.Objects.BoxLayout

ManagedPtrNewtype BoxLayout

Defined in GI.Gtk.Objects.BoxLayout

Methods

toManagedPtr :: BoxLayout -> ManagedPtr BoxLayout

TypedObject BoxLayout

Defined in GI.Gtk.Objects.BoxLayout

Methods

glibType :: IO GType

HasParentTypes BoxLayout

Defined in GI.Gtk.Objects.BoxLayout

IsGValue (Maybe BoxLayout)

Convert BoxLayout to and from GValue. See toGValue and fromGValue.

Defined in GI.Gtk.Objects.BoxLayout

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe BoxLayout -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe BoxLayout)

type ParentTypes BoxLayout

Defined in GI.Gtk.Objects.BoxLayout

type ParentTypes BoxLayout = '[LayoutManager, Object, Orientable]

class (GObject o, IsDescendantOf BoxLayout o) => IsBoxLayout o

Type class for types which can be safely cast to BoxLayout, for instance with toBoxLayout.

Instances

(GObject o, IsDescendantOf BoxLayout o) => IsBoxLayout o

Defined in GI.Gtk.Objects.BoxLayout

toBoxLayout :: (MonadIO m, IsBoxLayout o) => o -> m BoxLayout

Cast to BoxLayout, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

allocate, bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, layoutChanged, measure, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getBaselinePosition, getData, getHomogeneous, getLayoutChild, getOrientation, getProperty, getQdata, getRequestMode, getSpacing, getWidget.

Setters

setBaselinePosition, setData, setDataFull, setHomogeneous, setOrientation, setProperty, setSpacing.

getBaselinePosition

boxLayoutGetBaselinePosition

Arguments

:: (HasCallStack, MonadIO m, IsBoxLayout a)

=> a

boxLayout: a GtkBoxLayout

-> m BaselinePosition

Returns: the baseline position

Gets the value set by boxLayoutSetBaselinePosition.

getHomogeneous

boxLayoutGetHomogeneous

Arguments

:: (HasCallStack, MonadIO m, IsBoxLayout a)

=> a

boxLayout: a GtkBoxLayout

-> m Bool

Returns: True if the layout is homogeneous

Returns whether the layout is set to be homogeneous.

getSpacing

boxLayoutGetSpacing

Arguments

:: (HasCallStack, MonadIO m, IsBoxLayout a)

=> a

boxLayout: a GtkBoxLayout

-> m Word32

Returns: the spacing of the layout

Returns the space that boxLayout puts between children.

new

boxLayoutNew

Arguments

:: (HasCallStack, MonadIO m)

=> Orientation

orientation: the orientation for the new layout

-> m BoxLayout

Returns: a new box layout

Creates a new GtkBoxLayout.

setBaselinePosition

boxLayoutSetBaselinePosition

Arguments

:: (HasCallStack, MonadIO m, IsBoxLayout a)

=> a

boxLayout: a GtkBoxLayout

-> BaselinePosition

position: a GtkBaselinePosition

-> m ()

Sets the baseline position of a box layout.

The baseline position 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 the given position is used to allocate the baseline within the extra space available.

setHomogeneous

boxLayoutSetHomogeneous

Arguments

:: (HasCallStack, MonadIO m, IsBoxLayout a)

=> a

boxLayout: a GtkBoxLayout

-> Bool

homogeneous: True to set the box layout as homogeneous

-> m ()

Sets whether the box layout will allocate the same size to all children.

setSpacing

boxLayoutSetSpacing

Arguments

:: (HasCallStack, MonadIO m, IsBoxLayout a)

=> a

boxLayout: a GtkBoxLayout

-> Word32

spacing: the spacing to apply between children

-> m ()

Sets how much spacing to put between children.

Properties

baselinePosition

The position of the allocated baseline within the extra space allocated to each child.

This property is only relevant for horizontal layouts containing at least one child with a baseline alignment.

constructBoxLayoutBaselinePosition :: (IsBoxLayout o, MonadIO m) => BaselinePosition -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “baseline-position” property. This is rarely needed directly, but it is used by new.

getBoxLayoutBaselinePosition :: (MonadIO m, IsBoxLayout o) => o -> m BaselinePosition

Get the value of the “baseline-position” property. When overloading is enabled, this is equivalent to

get boxLayout #baselinePosition

setBoxLayoutBaselinePosition :: (MonadIO m, IsBoxLayout o) => o -> BaselinePosition -> m ()

Set the value of the “baseline-position” property. When overloading is enabled, this is equivalent to

set boxLayout [ #baselinePosition := value ]

homogeneous

Whether the box layout should distribute the available space equally among the children.

constructBoxLayoutHomogeneous :: (IsBoxLayout o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “homogeneous” property. This is rarely needed directly, but it is used by new.

getBoxLayoutHomogeneous :: (MonadIO m, IsBoxLayout o) => o -> m Bool

Get the value of the “homogeneous” property. When overloading is enabled, this is equivalent to

get boxLayout #homogeneous

setBoxLayoutHomogeneous :: (MonadIO m, IsBoxLayout o) => o -> Bool -> m ()

Set the value of the “homogeneous” property. When overloading is enabled, this is equivalent to

set boxLayout [ #homogeneous := value ]

spacing

The space to put between the children.

constructBoxLayoutSpacing :: (IsBoxLayout o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “spacing” property. This is rarely needed directly, but it is used by new.

getBoxLayoutSpacing :: (MonadIO m, IsBoxLayout o) => o -> m Int32

Get the value of the “spacing” property. When overloading is enabled, this is equivalent to

get boxLayout #spacing

setBoxLayoutSpacing :: (MonadIO m, IsBoxLayout o) => o -> Int32 -> m ()

Set the value of the “spacing” property. When overloading is enabled, this is equivalent to

set boxLayout [ #spacing := value ]