Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | None |
Language | Haskell2010 |
GI.Gtk.Objects.Layout
Contents
Description
tLayout
is similar to tDrawingArea
in that it’s a “blank slate” and
doesn’t do anything except paint a blank background by default. It’s
different in that it supports scrolling natively due to implementing
tScrollable
, and can contain child widgets since it’s a tContainer
.
If you just want to draw, a tDrawingArea
is a better choice since it has
lower overhead. If you just need to position child widgets at specific
points, then tFixed
provides that functionality on its own.
When handling expose events on a tLayout
, you must draw to the tWindow
returned by layoutGetBinWindow
, rather than to the one returned by
widgetGetWindow
as you would for a tDrawingArea
.
Synopsis
- newtype Layout = Layout (ManagedPtr Layout)
- class (GObject o, IsDescendantOf Layout o) => IsLayout o
- toLayout :: (MonadIO m, IsLayout o) => o -> m Layout
- noLayout :: Maybe Layout
- layoutGetBinWindow :: (HasCallStack, MonadIO m, IsLayout a) => a -> m Window
- layoutGetHadjustment :: (HasCallStack, MonadIO m, IsLayout a) => a -> m Adjustment
- layoutGetSize :: (HasCallStack, MonadIO m, IsLayout a) => a -> m (Word32, Word32)
- layoutGetVadjustment :: (HasCallStack, MonadIO m, IsLayout a) => a -> m Adjustment
- layoutMove :: (HasCallStack, MonadIO m, IsLayout a, IsWidget b) => a -> b -> Int32 -> Int32 -> m ()
- layoutNew :: (HasCallStack, MonadIO m, IsAdjustment a, IsAdjustment b) => Maybe a -> Maybe b -> m Layout
- layoutPut :: (HasCallStack, MonadIO m, IsLayout a, IsWidget b) => a -> b -> Int32 -> Int32 -> m ()
- layoutSetHadjustment :: (HasCallStack, MonadIO m, IsLayout a, IsAdjustment b) => a -> Maybe b -> m ()
- layoutSetSize :: (HasCallStack, MonadIO m, IsLayout a) => a -> Word32 -> Word32 -> m ()
- layoutSetVadjustment :: (HasCallStack, MonadIO m, IsLayout a, IsAdjustment b) => a -> Maybe b -> m ()
- constructLayoutHeight :: IsLayout o => Word32 -> IO (GValueConstruct o)
- getLayoutHeight :: (MonadIO m, IsLayout o) => o -> m Word32
- setLayoutHeight :: (MonadIO m, IsLayout o) => o -> Word32 -> m ()
- constructLayoutWidth :: IsLayout o => Word32 -> IO (GValueConstruct o)
- getLayoutWidth :: (MonadIO m, IsLayout o) => o -> m Word32
- setLayoutWidth :: (MonadIO m, IsLayout o) => o -> Word32 -> m ()
Exported types
Memory-managed wrapper type.
Instances
Eq Layout Source # | |
GObject Layout Source # | |
Defined in GI.Gtk.Objects.Layout Methods gobjectType :: IO GType | |
IsGValue Layout Source # | Convert |
Defined in GI.Gtk.Objects.Layout | |
HasParentTypes Layout Source # | |
Defined in GI.Gtk.Objects.Layout | |
type ParentTypes Layout Source # | |
Defined in GI.Gtk.Objects.Layout type ParentTypes Layout = Container ': (Widget ': (Object ': (ImplementorIface ': (Buildable ': (Scrollable ': ([] :: [Type])))))) |
class (GObject o, IsDescendantOf Layout o) => IsLayout o Source #
Instances
(GObject o, IsDescendantOf Layout o) => IsLayout o Source # | |
Defined in GI.Gtk.Objects.Layout |
Methods
Overloaded methods
getBinWindow
Arguments
:: (HasCallStack, MonadIO m, IsLayout a) | |
=> a |
|
-> m Window | Returns: a t |
Retrieve the bin window of the layout used for drawing operations.
Since: 2.14
getHadjustment
Arguments
:: (HasCallStack, MonadIO m, IsLayout a) | |
=> a |
|
-> 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 tScrolledWindow
or otherwise configured for
scrolling. It returns the tAdjustment
used for communication
between the horizontal scrollbar and layout
.
See tScrolledWindow
, tScrollbar
, tAdjustment
for details.
getSize
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
Arguments
:: (HasCallStack, MonadIO m, IsLayout a) | |
=> a |
|
-> 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 tScrolledWindow
or otherwise configured for
scrolling. It returns the tAdjustment
used for communication
between the vertical scrollbar and layout
.
See tScrolledWindow
, tScrollbar
, tAdjustment
for details.
move
Arguments
:: (HasCallStack, MonadIO m, IsLayout a, IsWidget b) | |
=> a |
|
-> b |
|
-> Int32 |
|
-> Int32 |
|
-> m () |
Moves a current child of layout
to a new position.
new
Arguments
:: (HasCallStack, MonadIO m, IsAdjustment a, IsAdjustment b) | |
=> Maybe a |
|
-> Maybe b |
|
-> m Layout | Returns: a new t |
Creates a new tLayout
. Unless you have a specific adjustment
you’d like the layout to use for scrolling, pass Nothing
for
hadjustment
and vadjustment
.
put
Arguments
:: (HasCallStack, MonadIO m, IsLayout a, IsWidget b) | |
=> a |
|
-> b |
|
-> Int32 |
|
-> Int32 |
|
-> m () |
Adds childWidget
to layout
, at position (x
,y
).
layout
becomes the new parent container of childWidget
.
setHadjustment
Arguments
:: (HasCallStack, MonadIO m, IsLayout a, IsAdjustment b) | |
=> a |
|
-> Maybe b |
|
-> m () |
Deprecated: (Since version 3.0)Use scrollableSetHadjustment
Sets the horizontal scroll adjustment for the layout.
See tScrolledWindow
, tScrollbar
, tAdjustment
for details.
setSize
Arguments
:: (HasCallStack, MonadIO m, IsLayout a) | |
=> a |
|
-> Word32 |
|
-> Word32 |
|
-> m () |
Sets the size of the scrollable area of the layout.
setVadjustment
Arguments
:: (HasCallStack, MonadIO m, IsLayout a, IsAdjustment b) | |
=> a |
|
-> Maybe b |
|
-> m () |
Deprecated: (Since version 3.0)Use scrollableSetVadjustment
Sets the vertical scroll adjustment for the layout.
See tScrolledWindow
, tScrollbar
, tAdjustment
for details.
Properties
height
No description available in the introspection data.
constructLayoutHeight :: IsLayout o => Word32 -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “height
” property. This is rarely needed directly, but it is used by new
.
getLayoutHeight :: (MonadIO m, IsLayout o) => o -> m Word32 Source #
Get the value of the “height
” property.
When overloading is enabled, this is equivalent to
get
layout #height
setLayoutHeight :: (MonadIO m, IsLayout o) => o -> Word32 -> m () Source #
Set the value of the “height
” property.
When overloading is enabled, this is equivalent to
set
layout [ #height:=
value ]
width
No description available in the introspection data.
constructLayoutWidth :: IsLayout o => Word32 -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “width
” property. This is rarely needed directly, but it is used by new
.
getLayoutWidth :: (MonadIO m, IsLayout o) => o -> m Word32 Source #
Get the value of the “width
” property.
When overloading is enabled, this is equivalent to
get
layout #width
setLayoutWidth :: (MonadIO m, IsLayout o) => o -> Word32 -> m () Source #
Set the value of the “width
” property.
When overloading is enabled, this is equivalent to
set
layout [ #width:=
value ]