gtk.overlay

Module for [Overlay] class

class Overlay OverlayGidBuilder OverlayGidBuilderImpl

Types 3

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 #GtkWidget:halign and #GtkWidget:valign properties. E.g. a widget with both alignments set to [gtk.types.Align.Start] will be placed at the top left corner of the GtkOverlay container, whereas an overlay with halign set to [gtk.types.Align.Center] and valign set to [gtk.types.Align.End] 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 #GtkOverlay::get-child-position signal.

An overlay’s minimum and natural sizes are those of its main child. The sizes of overlay children are not considered when measuring these preferred sizes.

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.

Methods

GType _getGType()

GType _gType() @property

Overlay self()Returns `this`, for use in `with` statements.

OverlayGidBuilder builder()Get builder for [gtk.overlay.Overlay] Returns: New builder object

void addOverlay(gtk.widget.Widget widget)Adds widget to overlay.

bool getOverlayPassThrough(gtk.widget.Widget widget)Convenience function to get the value of the #GtkOverlay:pass-through child property for widget.

void reorderOverlay(gtk.widget.Widget child, int index)Moves child to a new index in the list of overlay children. The list contains overlays in the order that these were added to overlay by default. See also #GtkOverlay:index.

void setOverlayPassThrough(gtk.widget.Widget widget, bool passThrough)Convenience function to set the value of the #GtkOverlay:pass-through child property for widget.

gulong connectGetChildPosition(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  bool)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  gtk.widget.Widget)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.out_ &&  is(Parameters!T[1]  ==  gdk.rectangle.Rectangle)))
   && (Parameters!T.length <  3 || (ParameterStorageClassTuple!T[2]  ==  ParameterStorageClass.none &&  is(Parameters!T[2] :  gtk.overlay.Overlay)))
   &&  Parameters!T.length <  4)

Connect to `GetChildPosition` signal.

Constructors

this(void * ptr, Flag!"Take" take)

this()Creates a new #GtkOverlay. Returns: a new #GtkOverlay object.

classOverlayGidBuilderImpl(T) : gtk.bin.BinGidBuilderImpl!T

classOverlayGidBuilder : OverlayGidBuilderImpl!OverlayGidBuilder

Fluent builder for [gtk.overlay.Overlay]

Methods

Overlay build()