Class gtk-handle-box

Package: gtk

Superclasses

gtk-bin, gtk-container, gtk-widget, gtk-buildable, g-object, common-lisp:standard-object, common-lisp:t

Documented Subclasses

None

Direct Slots

child-detached

The child-detached property of type :boolean (Read)
Whether the child of the handle box is attached or detached.
Default value: false

handle-position

The handle-position property of type gtk-position-type (Read / Write)
Position of the handle relative to the child widget.
Default value: :left

shadow-type

The shadow-type property of type gtk-shadow-type (Read / Write)
Appearance of the shadow that surrounds the handle box.
Default value: :out

snap-edge

The snap-edge property of type gtk-position-type (Read / Write)
Side of the handle box that is lined up with the docking point to dock the handle box.
Default value: :top

snap-edge-set

The snap-edge-set property of type :boolean (Read / Write)
Whether to use the value from the snap-edge property or a value derived from the handle-position property.
Default value: false

Details

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 handle box. 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 handle box 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 handle box is deattached. For instance, if the handle box is packed at the bottom of a vertical gtk-box widget, then when the handle box is detached, the bottom edge of the allocation of the handle box will remain fixed as the height of the handle box shrinks, so the snap edge should be set to :bottom.

Warning

The gtk-handle-box widget has been deprecated since GTK 3.4. 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.

Signal Details

The "child-attached" signal

 lambda (handlebox widget)    :run-first

The signal is emitted when the contents of the handle box are reattached to the main window.

handlebox: The gtk-handle-box widget which received the signal.
widget: The gtk-widget child widget of the handle box. This argument provides no extra information and is here only for backwards compatibility.

The "child-detached" signal

 lambda (handlebox widget)    :run-first

The signal is emitted when the contents of the handle box are detached from the main window.

handlebox: The gtk-handle-box widget which received the signal.
widget: The gtk-widget child widget of the handle box. This argument provides no extra information and is here only for backwards compatibility.