gtk.handle_box

Module for [HandleBox] class

class HandleBox HandleBoxGidBuilder HandleBoxGidBuilderImpl

Types 3

The #GtkHandleBox widget allows a portion of a window to be "torn off". It is a bin widget which displays its child and a handle that the user can drag to tear off a separate window (the “float window”) containing the child widget. A thin “ghost” is drawn in the original location of the handlebox. By dragging the separate window back to its original location, it can be reattached.

When reattaching, the ghost and float window, must be aligned along one of the edges, the “snap edge”. This either can be specified by the application programmer explicitly, or GTK+ will pick a reasonable default based on the handle position.

To make detaching and reattaching the handlebox as minimally confusing as possible to the user, it is important to set the snap edge so that the snap edge does not move when the handlebox is deattached. For instance, if the handlebox is packed at the bottom of a VBox, then when the handlebox is detached, the bottom edge of the handlebox's allocation will remain fixed as the height of the handlebox shrinks, so the snap edge should be set to [gtk.types.PositionType.Bottom].

#GtkHandleBox has been deprecated. It is very specialized, lacks features
to make it useful and most importantly does not fit well into modern application design. Do not use it. There is no replacement.

Methods

GType _getGType()

GType _gType() @property

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

HandleBoxGidBuilder builder()Get builder for [gtk.handle_box.HandleBox] Returns: New builder object

bool childDetached() @property

gtk.types.PositionType handlePosition() @property

void handlePosition(gtk.types.PositionType propval) @property

gtk.types.ShadowType shadowType() @property

void shadowType(gtk.types.ShadowType propval) @property

gtk.types.PositionType snapEdge() @property

void snapEdge(gtk.types.PositionType propval) @property

bool snapEdgeSet() @property

void snapEdgeSet(bool propval) @property

bool getChildDetached()Whether the handlebox’s child is currently detached. Returns: true if the child is currently detached, otherwise false

gtk.types.PositionType getHandlePosition()Gets the handle position of the handle box. See [gtk.handle_box.HandleBox.setHandlePosition]. Returns: the current handle position.

gtk.types.ShadowType getShadowType()Gets the type of shadow drawn around the handle box. See [gtk.handle_box.HandleBox.setShadowType]. Returns: the type of shadow currently drawn around the handle box.

gtk.types.PositionType getSnapEdge()Gets the edge used for determining reattachment of the handle box. See [gtk.handle_box.HandleBox.setSnapEdge]. Returns: the edge used for determining reattachment, or (GtkPositionType)-1 if this is...

void setHandlePosition(gtk.types.PositionType position)Sets the side of the handlebox where the handle is drawn.

void setShadowType(gtk.types.ShadowType type)Sets the type of shadow to be drawn around the border of the handle box.

void setSnapEdge(gtk.types.PositionType edge)Sets the snap edge of a handlebox. The snap edge is the edge of the detached child that must be aligned with the corresponding edge of the “ghost” left behind when the child was detached to rea...

gulong connectChildAttached(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  gtk.widget.Widget)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1] :  gtk.handle_box.HandleBox)))
   &&  Parameters!T.length <  3)

Connect to `ChildAttached` signal.

gulong connectChildDetached(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  gtk.widget.Widget)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1] :  gtk.handle_box.HandleBox)))
   &&  Parameters!T.length <  3)

Connect to `ChildDetached` signal.

Constructors

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

this()Create a new handle box. Returns: a new #GtkHandleBox.

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

Methods

T handlePosition(gtk.types.PositionType propval)

T shadowType(gtk.types.ShadowType propval)

T snapEdge(gtk.types.PositionType propval)

T snapEdgeSet(bool propval)

classHandleBoxGidBuilder : HandleBoxGidBuilderImpl!HandleBoxGidBuilder

Fluent builder for [gtk.handle_box.HandleBox]

Methods

HandleBox build()