GI.Gtk.Objects.CenterBox

The GtkCenterBox widget arranges three children in a horizontal or vertical arrangement, keeping the middle child centered as well as possible.

To add children to GtkCenterBox, use centerBoxSetStartWidget, centerBoxSetCenterWidget and centerBoxSetEndWidget.

The sizing and positioning of children can be influenced with the align and expand properties of the children.

GtkCenterBox as GtkBuildable

The GtkCenterBox implementation of the Buildable interface supports placing children in the 3 positions by specifying “start”, “center” or “end” as the “type” attribute of a <child> element.

CSS nodes

GtkCenterBox uses a single CSS node with the name “box”,

The first child of the CenterBox will be allocated depending on the text direction, i.e. in left-to-right layouts it will be allocated on the left and in right-to-left layouts on the right.

In vertical orientation, the nodes of the children are arranged from top to bottom.

Exported types

newtype CenterBox

Memory-managed wrapper type.

Constructors

CenterBox (ManagedPtr CenterBox)

Instances

Eq CenterBox

Defined in GI.Gtk.Objects.CenterBox

Methods

(==) :: CenterBox -> CenterBox -> Bool

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

IsGValue CenterBox

Convert CenterBox to and from GValue with toGValue and fromGValue.

Defined in GI.Gtk.Objects.CenterBox

Methods

toGValue :: CenterBox -> IO GValue

fromGValue :: GValue -> IO CenterBox

GObject CenterBox

Defined in GI.Gtk.Objects.CenterBox

Methods

gobjectType :: IO GType

HasParentTypes CenterBox

Defined in GI.Gtk.Objects.CenterBox

type ParentTypes CenterBox

Defined in GI.Gtk.Objects.CenterBox

type ParentTypes CenterBox = '[Widget, Object, ImplementorIface, Buildable, Orientable]

class (GObject o, IsDescendantOf CenterBox o) => IsCenterBox o

Type class for types which can be safely cast to CenterBox, for instance with toCenterBox.

Instances

(GObject o, IsDescendantOf CenterBox o) => IsCenterBox o

Defined in GI.Gtk.Objects.CenterBox

toCenterBox :: (MonadIO m, IsCenterBox o) => o -> m CenterBox

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

noCenterBox :: Maybe CenterBox

A convenience alias for Nothing :: Maybe CenterBox.

Methods

Overloaded methods

getBaselinePosition

centerBoxGetBaselinePosition

Arguments

:: (HasCallStack, MonadIO m, IsCenterBox a)

=> a

self: a CenterBox

-> m BaselinePosition

Returns: the baseline position

Gets the value set by centerBoxSetBaselinePosition.

getCenterWidget

centerBoxGetCenterWidget

Arguments

:: (HasCallStack, MonadIO m, IsCenterBox a)

=> a

self: a CenterBox

-> m (Maybe Widget)

Returns: the center widget.

Gets the center widget, or Nothing if there is none.

getEndWidget

centerBoxGetEndWidget

Arguments

:: (HasCallStack, MonadIO m, IsCenterBox a)

=> a

self: a CenterBox

-> m (Maybe Widget)

Returns: the end widget.

Gets the end widget, or Nothing if there is none.

getStartWidget

centerBoxGetStartWidget

Arguments

:: (HasCallStack, MonadIO m, IsCenterBox a)

=> a

self: a CenterBox

-> m (Maybe Widget)

Returns: the start widget.

Gets the start widget, or Nothing if there is none.

new

centerBoxNew

Arguments

:: (HasCallStack, MonadIO m)

=> m CenterBox

Returns: the new CenterBox.

Creates a new CenterBox.

setBaselinePosition

centerBoxSetBaselinePosition

Arguments

:: (HasCallStack, MonadIO m, IsCenterBox a)

=> a

self: a CenterBox

-> BaselinePosition

position: a BaselinePosition

-> m ()

Sets the baseline position of a center 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.

setCenterWidget

centerBoxSetCenterWidget

Arguments

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

=> a

self: a CenterBox

-> Maybe b

child: the new center widget, or Nothing

-> m ()

Sets the center widget. To remove the existing center widget, pas Nothing.

setEndWidget

centerBoxSetEndWidget

Arguments

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

=> a

self: a CenterBox

-> Maybe b

child: the new end widget, or Nothing

-> m ()

Sets the end widget. To remove the existing end widget, pass Nothing.

setStartWidget

centerBoxSetStartWidget

Arguments

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

=> a

self: a CenterBox

-> Maybe b

child: the new start widget, or Nothing

-> m ()

Sets the start widget. To remove the existing start widget, pass Nothing.

Properties

baselinePosition

No description available in the introspection data.

constructCenterBoxBaselinePosition :: IsCenterBox o => BaselinePosition -> IO (GValueConstruct o)

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

getCenterBoxBaselinePosition :: (MonadIO m, IsCenterBox o) => o -> m BaselinePosition

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

get centerBox #baselinePosition

setCenterBoxBaselinePosition :: (MonadIO m, IsCenterBox o) => o -> BaselinePosition -> m ()

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

set centerBox [ #baselinePosition := value ]