HandleBox

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_handle_box_get_type ()" ) ]
[ Version ( deprecated = true , deprecated_since = "3.4" ) ]
public class HandleBox : Bin, Implementor, Buildable

Warning: HandleBox is deprecated since 3.4.

The HandleBox 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 explicitly, 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:

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

Namespace: Gtk

Package: gtk+-3.0

Content:

Properties:

public virtual bool child_detached { get; }
public PositionType handle_position { get; set; }
public ShadowType shadow_type { get; set; }
public PositionType snap_edge { get; set; }
public bool snap_edge_set { get; set; }

Creation methods:

public HandleBox ()
Create a new handle box.

Methods:

public bool get_child_detached ()
Whether the handlebox’s child is currently detached.
public PositionType get_handle_position ()
Gets the handle position of the handle box.
public ShadowType get_shadow_type ()
Gets the type of shadow drawn around the handle box.
public PositionType get_snap_edge ()
Gets the edge used for determining reattachment of the handle box.
public void set_handle_position (PositionType position)
Sets the side of the handlebox where the handle is drawn.
public void set_shadow_type (ShadowType type)
Sets the type of shadow to be drawn around the border of the handle box.
public void set_snap_edge (PositionType edge)
Sets the snap edge of a handlebox.

Signals:

public virtual signal void child_attached (Widget child)
This signal is emitted when the contents of the handlebox are reattached to the main window.
public signal void on_child_detached (Widget widget)
This signal is emitted when the contents of the handlebox are detached from the main window.

Inherited Members:

All known members inherited from class Gtk.Bin

get_child

All known members inherited from class Gtk.Container

All known members inherited from class Gtk.Widget

All known members inherited from class GLib.Object

All known members inherited from interface Atk.Implementor

ref_accessible

All known members inherited from interface Gtk.Buildable