GI.Gtk.Objects.Layout

Layout is similar to DrawingArea in that it’s a “blank slate” and doesn’t do anything but paint a blank background by default. It's different in that it supports scrolling natively (you can add it to a ScrolledWindow), and it can contain child widgets, since it’s a Container. However if you’re just going to draw, a DrawingArea is a better choice since it has lower overhead.

When handling expose events on a Layout, you must draw to GTK_LAYOUT (layout)->bin_window, rather than to GTK_WIDGET (layout)->window, as you would for a drawing area.

Exported types

newtype Layout

Constructors

Layout (ManagedPtr Layout)

Instances

GObject Layout

Methods

gobjectType :: Layout -> IO GType

IsImplementorIface Layout

IsObject Layout

IsWidget Layout

IsContainer Layout

IsScrollable Layout

IsBuildable Layout

IsLayout Layout

((~) * info (ResolveLayoutMethod t Layout), MethodInfo * info Layout p) => IsLabel t (Layout -> p)

Methods

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

((~) * info (ResolveLayoutMethod t Layout), MethodInfo * info Layout p) => IsLabelProxy t (Layout -> p)

Methods

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

HasAttributeList * Layout

type AttributeList Layout

type AttributeList Layout

type SignalList Layout

type SignalList Layout

class GObject o => IsLayout o

Instances

(GObject a, UnknownAncestorError Constraint Layout a) => IsLayout a

IsLayout Layout

toLayout :: IsLayout o => o -> IO Layout

noLayout :: Maybe Layout

Methods

getBinWindow

data LayoutGetBinWindowMethodInfo

Instances

((~) * signature (m Window), MonadIO m, IsLayout a) => MethodInfo * LayoutGetBinWindowMethodInfo a signature

Methods

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

layoutGetBinWindow

Arguments

:: (HasCallStack, MonadIO m, IsLayout a)

=> a

layout: a Layout

-> m Window

Returns: a Window

Retrieve the bin window of the layout used for drawing operations.

Since: 2.14

getHadjustment

data LayoutGetHadjustmentMethodInfo

Instances

((~) * signature (m Adjustment), MonadIO m, IsLayout a) => MethodInfo * LayoutGetHadjustmentMethodInfo a signature

Methods

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

layoutGetHadjustment

Arguments

:: (HasCallStack, MonadIO m, IsLayout a)

=> a

layout: a Layout

-> m Adjustment

Returns: horizontal scroll adjustment

Deprecated: (Since version 3.0)Use scrollableGetHadjustment

This function should only be called after the layout has been placed in a ScrolledWindow or otherwise configured for scrolling. It returns the Adjustment used for communication between the horizontal scrollbar and layout.

See ScrolledWindow, Scrollbar, Adjustment for details.

getSize

data LayoutGetSizeMethodInfo

Instances

((~) * signature (m (Word32, Word32)), MonadIO m, IsLayout a) => MethodInfo * LayoutGetSizeMethodInfo a signature

Methods

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

layoutGetSize

Arguments

:: (HasCallStack, MonadIO m, IsLayout a)

=> a

layout: a Layout

-> m (Word32, Word32)

Gets the size that has been set on the layout, and that determines the total extents of the layout’s scrollbar area. See gtk_layout_set_size ().

getVadjustment

data LayoutGetVadjustmentMethodInfo

Instances

((~) * signature (m Adjustment), MonadIO m, IsLayout a) => MethodInfo * LayoutGetVadjustmentMethodInfo a signature

Methods

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

layoutGetVadjustment

Arguments

:: (HasCallStack, MonadIO m, IsLayout a)

=> a

layout: a Layout

-> m Adjustment

Returns: vertical scroll adjustment

Deprecated: (Since version 3.0)Use scrollableGetVadjustment

This function should only be called after the layout has been placed in a ScrolledWindow or otherwise configured for scrolling. It returns the Adjustment used for communication between the vertical scrollbar and layout.

See ScrolledWindow, Scrollbar, Adjustment for details.

move

data LayoutMoveMethodInfo

Instances

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

Methods

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

layoutMove

Arguments

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

=> a

layout: a Layout

-> b

childWidget: a current child of layout

-> Int32

x: X position to move to

-> Int32

y: Y position to move to

-> m ()

Moves a current child of layout to a new position.

new

layoutNew

Arguments

:: (HasCallStack, MonadIO m, IsAdjustment a, IsAdjustment b)

=> Maybe a

hadjustment: horizontal scroll adjustment, or Nothing

-> Maybe b

vadjustment: vertical scroll adjustment, or Nothing

-> m Layout

Returns: a new Layout

Creates a new Layout. Unless you have a specific adjustment you’d like the layout to use for scrolling, pass Nothing for hadjustment and vadjustment.

put

data LayoutPutMethodInfo

Instances

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

Methods

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

layoutPut

Arguments

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

=> a

layout: a Layout

-> b

childWidget: child widget

-> Int32

x: X position of child widget

-> Int32

y: Y position of child widget

-> m ()

Adds childWidget to layout, at position (x,y). layout becomes the new parent container of childWidget.

setHadjustment

data LayoutSetHadjustmentMethodInfo

Instances

((~) * signature (Maybe b -> m ()), MonadIO m, IsLayout a, IsAdjustment b) => MethodInfo * LayoutSetHadjustmentMethodInfo a signature

Methods

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

layoutSetHadjustment

Arguments

:: (HasCallStack, MonadIO m, IsLayout a, IsAdjustment b)

=> a

layout: a Layout

-> Maybe b

adjustment: new scroll adjustment

-> m ()

Deprecated: (Since version 3.0)Use scrollableSetHadjustment

Sets the horizontal scroll adjustment for the layout.

See ScrolledWindow, Scrollbar, Adjustment for details.

setSize

data LayoutSetSizeMethodInfo

Instances

((~) * signature (Word32 -> Word32 -> m ()), MonadIO m, IsLayout a) => MethodInfo * LayoutSetSizeMethodInfo a signature

Methods

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

layoutSetSize

Arguments

:: (HasCallStack, MonadIO m, IsLayout a)

=> a

layout: a Layout

-> Word32

width: width of entire scrollable area

-> Word32

height: height of entire scrollable area

-> m ()

Sets the size of the scrollable area of the layout.

setVadjustment

data LayoutSetVadjustmentMethodInfo

Instances

((~) * signature (Maybe b -> m ()), MonadIO m, IsLayout a, IsAdjustment b) => MethodInfo * LayoutSetVadjustmentMethodInfo a signature

Methods

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

layoutSetVadjustment

Arguments

:: (HasCallStack, MonadIO m, IsLayout a, IsAdjustment b)

=> a

layout: a Layout

-> Maybe b

adjustment: new scroll adjustment

-> m ()

Deprecated: (Since version 3.0)Use scrollableSetVadjustment

Sets the vertical scroll adjustment for the layout.

See ScrolledWindow, Scrollbar, Adjustment for details.

Properties

height

data LayoutHeightPropertyInfo

Instances

AttrInfo LayoutHeightPropertyInfo

Associated Types

type AttrAllowedOps LayoutHeightPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint LayoutHeightPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint LayoutHeightPropertyInfo :: * -> Constraint

type AttrGetType LayoutHeightPropertyInfo :: *

type AttrLabel LayoutHeightPropertyInfo :: Symbol

type AttrOrigin LayoutHeightPropertyInfo :: *

Methods

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

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

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

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

type AttrOrigin LayoutHeightPropertyInfo

type AttrOrigin LayoutHeightPropertyInfo = Layout

type AttrLabel LayoutHeightPropertyInfo

type AttrLabel LayoutHeightPropertyInfo = "height"

type AttrGetType LayoutHeightPropertyInfo

type AttrGetType LayoutHeightPropertyInfo = Word32

type AttrBaseTypeConstraint LayoutHeightPropertyInfo

type AttrBaseTypeConstraint LayoutHeightPropertyInfo = IsLayout

type AttrSetTypeConstraint LayoutHeightPropertyInfo

type AttrSetTypeConstraint LayoutHeightPropertyInfo = * ~ Word32

type AttrAllowedOps LayoutHeightPropertyInfo

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

constructLayoutHeight :: IsLayout o => Word32 -> IO (GValueConstruct o)

getLayoutHeight :: (MonadIO m, IsLayout o) => o -> m Word32

layoutHeight :: AttrLabelProxy "height"

setLayoutHeight :: (MonadIO m, IsLayout o) => o -> Word32 -> m ()

width

data LayoutWidthPropertyInfo

Instances

AttrInfo LayoutWidthPropertyInfo

Associated Types

type AttrAllowedOps LayoutWidthPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint LayoutWidthPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint LayoutWidthPropertyInfo :: * -> Constraint

type AttrGetType LayoutWidthPropertyInfo :: *

type AttrLabel LayoutWidthPropertyInfo :: Symbol

type AttrOrigin LayoutWidthPropertyInfo :: *

Methods

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

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

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

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

type AttrOrigin LayoutWidthPropertyInfo

type AttrOrigin LayoutWidthPropertyInfo = Layout

type AttrLabel LayoutWidthPropertyInfo

type AttrLabel LayoutWidthPropertyInfo = "width"

type AttrGetType LayoutWidthPropertyInfo

type AttrGetType LayoutWidthPropertyInfo = Word32

type AttrBaseTypeConstraint LayoutWidthPropertyInfo

type AttrBaseTypeConstraint LayoutWidthPropertyInfo = IsLayout

type AttrSetTypeConstraint LayoutWidthPropertyInfo

type AttrSetTypeConstraint LayoutWidthPropertyInfo = * ~ Word32

type AttrAllowedOps LayoutWidthPropertyInfo

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

constructLayoutWidth :: IsLayout o => Word32 -> IO (GValueConstruct o)

getLayoutWidth :: (MonadIO m, IsLayout o) => o -> m Word32

layoutWidth :: AttrLabelProxy "width"

setLayoutWidth :: (MonadIO m, IsLayout o) => o -> Word32 -> m ()