Next: , Previous: GtkEventBox, Up: Top

119 GtkHandleBox

a widget for detachable window portions

119.1 Overview

The <gtk-handle-box> 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’.

119.2 Usage

— Class: <gtk-handle-box>

Derives from <gtk-bin>.

This class defines the following slots:

Deprecated property, use shadow_type instead
Appearance of the shadow that surrounds the container
Position of the handle relative to the child widget
Side of the handlebox that's lined up with the docking point to dock the handlebox
Whether to use the value from the snap_edge property or a value derived from handle_position
— Signal on <gtk-handle-box>: child-attached (arg0 <gtk-widget>)

This signal is emitted when the contents of the handlebox are reattached to the main window.

— Signal on <gtk-handle-box>: child-detached (arg0 <gtk-widget>)

This signal is emitted when the contents of the handlebox are detached from the main window.

— Function: gtk-handle-box-new ⇒  (ret <gtk-widget>)

Create a new handle box.

a new <gtk-handle-box>.
— Function: gtk-handle-box-set-shadow-type (self <gtk-handle-box>) (type <gtk-shadow-type>)
— Method: set-shadow-type

Sets the type of shadow to be drawn around the border of the handle box.

a <gtk-handle-box>
the shadow type.
— Function: gtk-handle-box-set-handle-position (self <gtk-handle-box>) (position <gtk-position-type>)
— Method: set-handle-position

Sets the side of the handlebox where the handle is drawn.

a <gtk-handle-box>
the side of the handlebox where the handle should be drawn.
— Function: gtk-handle-box-set-snap-edge (self <gtk-handle-box>) (edge <gtk-position-type>)
— Method: set-snap-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.

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

a <gtk-handle-box>
the snap edge, or -1 to unset the value; in which case GTK+ will try to guess an appropriate value in the future.
— Function: gtk-handle-box-get-handle-position (self <gtk-handle-box>) ⇒  (ret <gtk-position-type>)
— Method: get-handle-position

Gets the handle position of the handle box. See gtk-handle-box-set-handle-position.

a <gtk-handle-box>
the current handle position.
— Function: gtk-handle-box-get-shadow-type (self <gtk-handle-box>) ⇒  (ret <gtk-shadow-type>)
— Method: get-shadow-type

Gets the type of shadow drawn around the handle box. See gtk-handle-box-set-shadow-type.

a <gtk-handle-box>
the type of shadow currently drawn around the handle box.
— Function: gtk-handle-box-get-snap-edge (self <gtk-handle-box>) ⇒  (ret <gtk-position-type>)
— Method: get-snap-edge

Gets the edge used for determining reattachment of the handle box. See gtk-handle-box-set-snap-edge.

a <gtk-handle-box>
the edge used for determining reattachment, or (GtkPositionType)-1 if this is determined (as per default) from the handle position.