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.Overlay

Contents

Exported types
Methods
Signals
- getChildPosition

Description

GtkOverlay is a container which contains a single main child, on top of which it can place “overlay” widgets. The position of each overlay widget is determined by its Widget:halign and Widget:valign properties. E.g. a widget with both alignments set to AlignStart will be placed at the top left corner of the GtkOverlay container, whereas an overlay with halign set to AlignCenter and valign set to AlignEnd will be placed a the bottom edge of the GtkOverlay, horizontally centered. The position can be adjusted by setting the margin properties of the child to non-zero values.

More complicated placement of overlays is possible by connecting to the getChildPosition signal.

GtkOverlay as GtkBuildable

The GtkOverlay implementation of the GtkBuildable interface supports placing a child as an overlay by specifying “overlay” as the “type” attribute of a <child> element.

CSS nodes

GtkOverlay has a single CSS node with the name “overlay”. Overlay children whose alignments cause them to be positioned at an edge get the style classes “.left”, “.right”, “.top”, and/or “.bottom” according to their position.

Synopsis

newtype Overlay = Overlay (ManagedPtr Overlay)
class (GObject o, IsDescendantOf Overlay o) => IsOverlay o
toOverlay :: (MonadIO m, IsOverlay o) => o -> m Overlay
noOverlay :: Maybe Overlay
overlayAddOverlay :: (HasCallStack, MonadIO m, IsOverlay a, IsWidget b) => a -> b -> m ()
overlayGetClipOverlay :: (HasCallStack, MonadIO m, IsOverlay a, IsWidget b) => a -> b -> m Bool
overlayGetMeasureOverlay :: (HasCallStack, MonadIO m, IsOverlay a, IsWidget b) => a -> b -> m Bool
overlayNew :: (HasCallStack, MonadIO m) => m Overlay
overlaySetClipOverlay :: (HasCallStack, MonadIO m, IsOverlay a, IsWidget b) => a -> b -> Bool -> m ()
overlaySetMeasureOverlay :: (HasCallStack, MonadIO m, IsOverlay a, IsWidget b) => a -> b -> Bool -> m ()

Exported types

newtype Overlay Source #

Memory-managed wrapper type.

Constructors

Overlay (ManagedPtr Overlay)

Instances

Instances details

Eq Overlay Source #
Instance details Defined in GI.Gtk.Objects.Overlay Methods (==) :: Overlay -> Overlay -> Bool # (/=) :: Overlay -> Overlay -> Bool #
IsGValue Overlay Source #	Convert `Overlay` to and from `GValue` with `toGValue` and `fromGValue`.
Instance details Defined in GI.Gtk.Objects.Overlay Methods toGValue :: Overlay -> IO GValue # fromGValue :: GValue -> IO Overlay #
GObject Overlay Source #
Instance details Defined in GI.Gtk.Objects.Overlay Methods gobjectType :: IO GType #
HasParentTypes Overlay Source #
Instance details Defined in GI.Gtk.Objects.Overlay
type ParentTypes Overlay Source #
Instance details Defined in GI.Gtk.Objects.Overlay type ParentTypes Overlay = '[Bin, Container, Widget, Object, ImplementorIface, Buildable]

class (GObject o, IsDescendantOf Overlay o) => IsOverlay o Source #

Type class for types which can be safely cast to Overlay, for instance with toOverlay.

Instances

Instances details

(GObject o, IsDescendantOf Overlay o) => IsOverlay o Source #
Instance details Defined in GI.Gtk.Objects.Overlay

toOverlay :: (MonadIO m, IsOverlay o) => o -> m Overlay Source #

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

noOverlay :: Maybe Overlay Source #

A convenience alias for Nothing :: Maybe Overlay.

Methods

Overloaded methods

addOverlay

overlayAddOverlay Source #

Arguments

:: (HasCallStack, MonadIO m, IsOverlay a, IsWidget b)
=> a	`overlay`: a `Overlay`
-> b	`widget`: a `Widget` to be added to the container
-> m ()

Adds widget to overlay.

The widget will be stacked on top of the main widget added with containerAdd.

The position at which widget is placed is determined from its Widget:halign and Widget:valign properties.

getClipOverlay

overlayGetClipOverlay Source #

Arguments

:: (HasCallStack, MonadIO m, IsOverlay a, IsWidget b)
=> a	`overlay`: a `Overlay`
-> b	`widget`: an overlay child of `Overlay`
-> m Bool	Returns: whether the widget is clipped within the parent.

Convenience function to get the value of the Overlay:clip-overlay child property for widget.

getMeasureOverlay

overlayGetMeasureOverlay Source #

Arguments

:: (HasCallStack, MonadIO m, IsOverlay a, IsWidget b)
=> a	`overlay`: a `Overlay`
-> b	`widget`: an overlay child of `Overlay`
-> m Bool	Returns: whether the widget is measured

Gets whether widget's size is included in the measurement of overlay.

new

overlayNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> m Overlay	Returns: a new `Overlay` object.

Creates a new Overlay.

setClipOverlay

overlaySetClipOverlay Source #

Arguments

:: (HasCallStack, MonadIO m, IsOverlay a, IsWidget b)
=> a	`overlay`: a `Overlay`
-> b	`widget`: an overlay child of `Overlay`
-> Bool	`clipOverlay`: whether the child should be clipped
-> m ()

Convenience function to set the value of the Overlay:clip-overlay child property for widget.

setMeasureOverlay

overlaySetMeasureOverlay Source #

Arguments

:: (HasCallStack, MonadIO m, IsOverlay a, IsWidget b)
=> a	`overlay`: a `Overlay`
-> b	`widget`: an overlay child of `Overlay`
-> Bool	`measure`: whether the child should be measured
-> m ()

Sets whether widget is included in the measured size of overlay.

The overlay will request the size of the largest child that has this property set to True. Children who are not included may be drawn outside of overlay's allocation if they are too large.

GtkOverlay as GtkBuildable

CSS nodes

Exported types

Instances

Instances

Methods

Signals