GtkHandleBox

A container for creating detachable window elements.

Object Hierarchy

GObject
`-- GtkObject
       `-- GtkWidget
              `-- GtkContainer
                     `-- GtkBin
                            `-- GtkHandleBox

Description

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.

Constructors

-- Creates a new handle box.

Methods

get_handle_position()
  Gets the handle position of the handle box.
get_shadow_type()
  Gets the type of shadow drawn around the handle box.
get_snap_edge()
  Gets the edge used for determining reattachment of the handle box.
set_handle_position()
  Sets the side of the handlebox where the handle is drawn.
set_shadow_type()
  Sets the type of shadow to be drawn around the border of the handle box.
set_snap_edge()
  Sets the snap edge of a handlebox.

Properties

Use get_property and set_property methods to access these.

handle-position:
  Position of the handle relative to the child widget.
shadow-type:
  Appearance of the shadow that surrounds the container.
snap-edge:
  Side of the handlebox that's lined up with the docking point to dock the handlebox.
snap-edge-set:
  Whether to use the value from the snap_edge property.

Signals

"child-attached"
  The contents of the box are reattached to the main window.
"child-detached"
  The widget is detached from the main window.