HandleBox

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

class HandleBox : Bin {

protected

GtkHandleBox* gtkHandleBox;

GtkHandleBox* getHandleBoxStruct(bool transferOwnership);

void* getStruct();

void setStruct(GObject* obj);

this(GtkHandleBox* gtkHandleBox, bool ownedRef);

static GType getType();

this();

bool getChildDetached();

GtkPositionType getHandlePosition();

GtkShadowType getShadowType();

GtkPositionType getSnapEdge();

void setHandlePosition(GtkPositionType position);

void setShadowType(GtkShadowType type);

void setSnapEdge(GtkPositionType edge);

class OnChildAttachedDelegateWrapper;

OnChildAttachedDelegateWrapper[] onChildAttachedListeners;

gulong addOnChildAttached(void delegate(Widget, HandleBox) dlg, ConnectFlags connectFlags);

static void callBackChildAttached(GtkHandleBox* handleboxStruct, GtkWidget* widget, OnChildAttachedDelegateWrapper wrapper);

static void callBackChildAttachedDestroy(OnChildAttachedDelegateWrapper wrapper, GClosure* closure);

class OnChildDetachedDelegateWrapper;

OnChildDetachedDelegateWrapper[] onChildDetachedListeners;

gulong addOnChildDetached(void delegate(Widget, HandleBox) dlg, ConnectFlags connectFlags);

static void callBackChildDetached(GtkHandleBox* handleboxStruct, GtkWidget* widget, OnChildDetachedDelegateWrapper wrapper);

static void callBackChildDetachedDestroy(OnChildDetachedDelegateWrapper wrapper, GClosure* closure);

}

Constructors

this this(GtkHandleBox* gtkHandleBox, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(): Create a new handle box.

Members

Classes

OnChildAttachedDelegateWrapper class OnChildAttachedDelegateWrapper: Undocumented in source.
OnChildDetachedDelegateWrapper class OnChildDetachedDelegateWrapper: Undocumented in source.

Functions

addOnChildAttached gulong addOnChildAttached(void delegate(Widget, HandleBox) dlg, ConnectFlags connectFlags): This signal is emitted when the contents of the handlebox are reattached to the main window.
addOnChildDetached gulong addOnChildDetached(void delegate(Widget, HandleBox) dlg, ConnectFlags connectFlags): This signal is emitted when the contents of the handlebox are detached from the main window.
getChildDetached bool getChildDetached(): Whether the handlebox’s child is currently detached.
getHandleBoxStruct GtkHandleBox* getHandleBoxStruct(bool transferOwnership): Get the main Gtk struct
getHandlePosition GtkPositionType getHandlePosition(): Gets the handle position of the handle box. See gtk_handle_box_set_handle_position().
getShadowType GtkShadowType getShadowType(): Gets the type of shadow drawn around the handle box. See gtk_handle_box_set_shadow_type().
getSnapEdge GtkPositionType getSnapEdge(): Gets the edge used for determining reattachment of the handle box. See gtk_handle_box_set_snap_edge().
getStruct void* getStruct(): the main Gtk struct as a void*
setHandlePosition void setHandlePosition(GtkPositionType position): Sets the side of the handlebox where the handle is drawn.
setShadowType void setShadowType(GtkShadowType type): Sets the type of shadow to be drawn around the border of the handle box.
setSnapEdge void setSnapEdge(GtkPositionType 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 reattach the torn-off window. Usually, the snap edge should be chosen so that it stays in the same place on the screen when the handlebox is torn off.
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

callBackChildAttached void callBackChildAttached(GtkHandleBox* handleboxStruct, GtkWidget* widget, OnChildAttachedDelegateWrapper wrapper): Undocumented in source. Be warned that the author may not have intended to support it.
callBackChildAttachedDestroy void callBackChildAttachedDestroy(OnChildAttachedDelegateWrapper wrapper, GClosure* closure): Undocumented in source. Be warned that the author may not have intended to support it.
callBackChildDetached void callBackChildDetached(GtkHandleBox* handleboxStruct, GtkWidget* widget, OnChildDetachedDelegateWrapper wrapper): Undocumented in source. Be warned that the author may not have intended to support it.
callBackChildDetachedDestroy void callBackChildDetachedDestroy(OnChildDetachedDelegateWrapper wrapper, GClosure* closure): Undocumented in source. Be warned that the author may not have intended to support it.
getType GType getType()

Variables

gtkHandleBox GtkHandleBox* gtkHandleBox;: the main Gtk struct
onChildAttachedListeners OnChildAttachedDelegateWrapper[] onChildAttachedListeners;: Undocumented in source.
onChildDetachedListeners OnChildDetachedDelegateWrapper[] onChildDetachedListeners;: Undocumented in source.

Inherited Members

From Bin

gtkBin GtkBin* gtkBin;: the main Gtk struct
getBinStruct GtkBin* getBinStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.
getType GType getType()
getChild Widget getChild(): Gets the child of the #GtkBin, or %NULL if the bin contains no child widget. The returned widget does not have a reference added, so you do not need to unref it.