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 explicitely, 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.

Note

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();

void* getStruct();

this(GtkHandleBox* gtkHandleBox);

void setStruct(GObject* obj);

int[string] connectedSignals;

void delegate(GtkWidget*, HandleBox)[] onChildAttachedListeners;

void addOnChildAttached(void delegate(GtkWidget*, HandleBox) dlg, ConnectFlags connectFlags);

static void callBackChildAttached(GtkHandleBox* handleboxStruct, GtkWidget* widget, HandleBox _handleBox);

void delegate(GtkWidget*, HandleBox)[] onChildDetachedListeners;

void addOnChildDetached(void delegate(GtkWidget*, HandleBox) dlg, ConnectFlags connectFlags);

static void callBackChildDetached(GtkHandleBox* handleboxStruct, GtkWidget* widget, HandleBox _handleBox);

this();

void setShadowType(GtkShadowType type);

void setHandlePosition(GtkPositionType position);

void setSnapEdge(GtkPositionType edge);

GtkPositionType getHandlePosition();

GtkShadowType getShadowType();

GtkPositionType getSnapEdge();

int getChildDetached();

}

Constructors

this this(GtkHandleBox* gtkHandleBox): Sets our main struct and passes it to the parent class
this this(): Warning gtk_handle_box_new has been deprecated since version 3.4 and should not be used in newly-written code. GtkHandleBox has been deprecated. Create a new handle box.

Members

Functions

addOnChildAttached void addOnChildAttached(void delegate(GtkWidget*, HandleBox) dlg, ConnectFlags connectFlags): Warning GtkHandleBox::child-attached has been deprecated since version 3.4 and should not be used in newly-written code. GtkHandleBox has been deprecated. This signal is emitted when the contents of the handlebox are reattached to the main window.
addOnChildDetached void addOnChildDetached(void delegate(GtkWidget*, HandleBox) dlg, ConnectFlags connectFlags): Warning GtkHandleBox::child-detached has been deprecated since version 3.4 and should not be used in newly-written code. GtkHandleBox has been deprecated. This signal is emitted when the contents of the handlebox are detached from the main window.
getChildDetached int getChildDetached(): Warning gtk_handle_box_get_child_detached has been deprecated since version 3.4 and should not be used in newly-written code. GtkHandleBox has been deprecated. Whether the handlebox's child is currently detached. Since 2.14
getHandleBoxStruct GtkHandleBox* getHandleBoxStruct(): Undocumented in source. Be warned that the author may not have intended to support it.
getHandlePosition GtkPositionType getHandlePosition(): Warning gtk_handle_box_get_handle_position has been deprecated since version 3.4 and should not be used in newly-written code. GtkHandleBox has been deprecated. Gets the handle position of the handle box. See gtk_handle_box_set_handle_position().
getShadowType GtkShadowType getShadowType(): Warning gtk_handle_box_get_shadow_type has been deprecated since version 3.4 and should not be used in newly-written code. GtkHandleBox has been deprecated. Gets the type of shadow drawn around the handle box. See gtk_handle_box_set_shadow_type().
getSnapEdge GtkPositionType getSnapEdge(): Warning gtk_handle_box_get_snap_edge has been deprecated since version 3.4 and should not be used in newly-written code. GtkHandleBox has been deprecated. 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): Warning gtk_handle_box_set_handle_position has been deprecated since version 3.4 and should not be used in newly-written code. GtkHandleBox has been deprecated. Sets the side of the handlebox where the handle is drawn.
setShadowType void setShadowType(GtkShadowType type): Warning gtk_handle_box_set_shadow_type has been deprecated since version 3.4 and should not be used in newly-written code. GtkHandleBox has been deprecated. Sets the type of shadow to be drawn around the border of the handle box.
setSnapEdge void setSnapEdge(GtkPositionType edge): Warning gtk_handle_box_set_snap_edge has been deprecated since version 3.4 and should not be used in newly-written code. GtkHandleBox has been deprecated. 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. If the snap edge is not set, then an appropriate value will be guessed from the handle position. If the handle position is GTK_POS_RIGHT or GTK_POS_LEFT, then the snap edge will be GTK_POS_TOP, otherwise it will be GTK_POS_LEFT.
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, HandleBox _handleBox): Undocumented in source. Be warned that the author may not have intended to support it.
callBackChildDetached void callBackChildDetached(GtkHandleBox* handleboxStruct, GtkWidget* widget, HandleBox _handleBox): Undocumented in source. Be warned that the author may not have intended to support it.

Variables

connectedSignals int[string] connectedSignals;
gtkHandleBox GtkHandleBox* gtkHandleBox;: the main Gtk struct
onChildAttachedListeners void delegate(GtkWidget*, HandleBox)[] onChildAttachedListeners;: Undocumented in source.
onChildDetachedListeners void delegate(GtkWidget*, HandleBox)[] onChildDetachedListeners;: Undocumented in source.

Inherited Members

From Bin

gtkBin GtkBin* gtkBin;: the main Gtk struct
getBinStruct GtkBin* getBinStruct(): Undocumented in source. Be warned that the author may not have intended to support it.
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.
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.