1
2@c %start of fragment
3
4@node GtkHandleBox
5@chapter GtkHandleBox
6a widget for detachable window portions
7
8@section Overview
9The @code{<gtk-handle-box>} widget allows a portion of a window to be "torn
10off". It is a bin widget which displays its child and a handle that the user can
11drag to tear off a separate window (the @dfn{float window}) containing the child
12widget. A thin @dfn{ghost} is drawn in the original location of the handlebox.
13By dragging the separate window back to its original location, it can be
14reattached.
15
16When reattaching, the ghost and float window, must be aligned along one of the
17edges, the @dfn{snap edge}. This either can be specified by the application
18programmer explicitely, or GTK+ will pick a reasonable default based on the
19handle position.
20
21To make detaching and reattaching the handlebox as minimally confusing as
22possible to the user, it is important to set the snap edge so that the snap edge
23does not move when the handlebox is deattached. For instance, if the handlebox
24is packed at the bottom of a VBox, then when the handlebox is detached, the
25bottom edge of the handlebox's allocation will remain fixed as the height of the
26handlebox shrinks, so the snap edge should be set to @samp{GTK_POS_BOTTOM}.
27
28@section Usage
29@include defuns-gtkhandlebox.xml.texi
30
31@c %end of fragment
32