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

class GObject o => IsLayout o

Instances

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

IsLayout Layout

toLayout :: (MonadIO m, IsLayout o) => o -> m Layout

noLayout :: Maybe Layout

Methods

getBinWindow

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

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

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

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

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

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

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

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

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

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

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

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

width

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

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

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