GtkHandleBox: GTK+ 3 Reference Manual

GtkHandleBox

GtkHandleBox — a widget for detachable window portions

Functions

GtkWidget *	gtk_handle_box_new ()
void	gtk_handle_box_set_shadow_type ()
void	gtk_handle_box_set_handle_position ()
void	gtk_handle_box_set_snap_edge ()
GtkPositionType	gtk_handle_box_get_handle_position ()
GtkShadowType	gtk_handle_box_get_shadow_type ()
GtkPositionType	gtk_handle_box_get_snap_edge ()
gboolean	gtk_handle_box_get_child_detached ()

Properties

gboolean	child-detached	Read
GtkPositionType	handle-position	Read / Write
GtkShadowType	shadow-type	Read / Write
GtkPositionType	snap-edge	Read / Write
gboolean	snap-edge-set	Read / Write

Signals

void	child-attached	Run First
void	child-detached	Run First

Types and Values

struct	GtkHandleBox
struct	GtkHandleBoxClass

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkContainer
                ╰── GtkBin
                    ╰── GtkHandleBox

Implemented Interfaces

GtkHandleBox implements AtkImplementorIface and GtkBuildable.

Includes

#include <gtk/gtk.h>

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

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

Functions

gtk_handle_box_new ()

GtkWidget *
gtk_handle_box_new (void);

gtk_handle_box_new has been deprecated since version 3.4 and should not be used in newly-written code.

GtkHandleBox has been deprecated.

Create a new handle box.

Returns

a new GtkHandleBox.

gtk_handle_box_set_shadow_type ()

void
gtk_handle_box_set_shadow_type (GtkHandleBox *handle_box,
                                GtkShadowType type);

gtk_handle_box_set_shadow_type has been deprecated since version 3.4 and should not be used in newly-written code.

GtkHandleBox has been deprecated.

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

Parameters

handle_box	a GtkHandleBox
type	the shadow type.

gtk_handle_box_set_handle_position ()

void
gtk_handle_box_set_handle_position (GtkHandleBox *handle_box,
                                    GtkPositionType position);

gtk_handle_box_set_handle_position has been deprecated since version 3.4 and should not be used in newly-written code.

GtkHandleBox has been deprecated.

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

Parameters

handle_box	a GtkHandleBox
position	the side of the handlebox where the handle should be drawn.

gtk_handle_box_set_snap_edge ()

void
gtk_handle_box_set_snap_edge (GtkHandleBox *handle_box,
                              GtkPositionType edge);

gtk_handle_box_set_snap_edge has been deprecated since version 3.4 and should not be used in newly-written code.

GtkHandleBox has been deprecated.

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.

Parameters

handle_box	a GtkHandleBox
edge	the snap edge, or -1 to unset the value; in which case GTK+ will try to guess an appropriate value in the future.

gtk_handle_box_get_handle_position ()

GtkPositionType
gtk_handle_box_get_handle_position (GtkHandleBox *handle_box);

gtk_handle_box_get_handle_position has been deprecated since version 3.4 and should not be used in newly-written code.

GtkHandleBox has been deprecated.

Gets the handle position of the handle box. See gtk_handle_box_set_handle_position().

Parameters

handle_box

a GtkHandleBox

Returns

the current handle position.

gtk_handle_box_get_shadow_type ()

GtkShadowType
gtk_handle_box_get_shadow_type (GtkHandleBox *handle_box);

gtk_handle_box_get_shadow_type has been deprecated since version 3.4 and should not be used in newly-written code.

GtkHandleBox has been deprecated.

Gets the type of shadow drawn around the handle box. See gtk_handle_box_set_shadow_type().

Parameters

handle_box

a GtkHandleBox

Returns

the type of shadow currently drawn around the handle box.

gtk_handle_box_get_snap_edge ()

GtkPositionType
gtk_handle_box_get_snap_edge (GtkHandleBox *handle_box);

gtk_handle_box_get_snap_edge has been deprecated since version 3.4 and should not be used in newly-written code.

GtkHandleBox has been deprecated.

Gets the edge used for determining reattachment of the handle box. See gtk_handle_box_set_snap_edge().

Parameters

handle_box

a GtkHandleBox

Returns

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

gtk_handle_box_get_child_detached ()

gboolean
gtk_handle_box_get_child_detached (GtkHandleBox *handle_box);

gtk_handle_box_get_child_detached has been deprecated since version 3.4 and should not be used in newly-written code.

GtkHandleBox has been deprecated.

Whether the handlebox’s child is currently detached.

Parameters

handle_box

a GtkHandleBox

Returns

TRUE if the child is currently detached, otherwise FALSE

Since: 2.14

Types and Values

struct GtkHandleBox

struct GtkHandleBox;

struct GtkHandleBoxClass

struct GtkHandleBoxClass {
  GtkBinClass parent_class;

  void (*child_attached) (GtkHandleBox *handle_box,
				 GtkWidget *child);
  void (*child_detached) (GtkHandleBox *handle_box,
				 GtkWidget *child);
};

Members

`child_attached` ()	Signal emitted when the contents of the handlebox are reattached to the main window. Deprecated: 3.4.
`child_detached` ()	Signal emitted when the contents of the handlebox are detached from the main window. Deprecated: 3.4.

Property Details

The `“child-detached”` property

  “child-detached”           gboolean

A boolean value indicating whether the handlebox's child is attached or detached.

Owner: GtkHandleBox

Flags: Read

Default value: FALSE

The `“handle-position”` property

  “handle-position”          GtkPositionType

Position of the handle relative to the child widget.

Owner: GtkHandleBox

Flags: Read / Write

Default value: GTK_POS_LEFT

The `“shadow-type”` property

  “shadow-type”              GtkShadowType

Appearance of the shadow that surrounds the container.

Owner: GtkHandleBox

Flags: Read / Write

Default value: GTK_SHADOW_OUT

The `“snap-edge”` property

  “snap-edge”                GtkPositionType

Side of the handlebox that's lined up with the docking point to dock the handlebox.

Owner: GtkHandleBox

Flags: Read / Write

Default value: GTK_POS_TOP

The `“snap-edge-set”` property

  “snap-edge-set”            gboolean

Whether to use the value from the snap_edge property or a value derived from handle_position.

Owner: GtkHandleBox

Flags: Read / Write

Default value: FALSE

Signal Details

The `“child-attached”` signal

void
user_function (GtkHandleBox *handlebox,
               GtkWidget    *widget,
               gpointer      user_data)

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

GtkHandleBox::child-attached has been deprecated since version 3.4 and should not be used in newly-written code.

GtkHandleBox has been deprecated.

Parameters

handlebox	the object which received the signal.
widget	the child widget of the handlebox. (this argument provides no extra information and is here only for backwards-compatibility)
user_data	user data set when the signal handler was connected.

Flags: Run First

The `“child-detached”` signal

void
user_function (GtkHandleBox *handlebox,
               GtkWidget    *widget,
               gpointer      user_data)

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

GtkHandleBox::child-detached has been deprecated since version 3.4 and should not be used in newly-written code.

GtkHandleBox has been deprecated.

Parameters

handlebox	the object which received the signal.
widget	the child widget of the handlebox. (this argument provides no extra information and is here only for backwards-compatibility)
user_data	user data set when the signal handler was connected.

Flags: Run First

GtkHandleBox

Functions

Properties

Signals

Types and Values

Object Hierarchy

Implemented Interfaces

Includes

Description

Functions

gtk_handle_box_new ()

Returns

gtk_handle_box_set_shadow_type ()

Parameters

gtk_handle_box_set_handle_position ()

Parameters

gtk_handle_box_set_snap_edge ()

Parameters

gtk_handle_box_get_handle_position ()

Parameters

Returns

gtk_handle_box_get_shadow_type ()

Parameters

Returns

gtk_handle_box_get_snap_edge ()

Parameters

Returns

gtk_handle_box_get_child_detached ()

Parameters

Returns

Types and Values

struct GtkHandleBox

struct GtkHandleBoxClass

Members

Property Details

The “child-detached” property

The “handle-position” property

The “shadow-type” property

The “snap-edge” property

The “snap-edge-set” property

Signal Details

The “child-attached” signal

Parameters

The “child-detached” signal

Parameters

The `“child-detached”` property

The `“handle-position”` property

The `“shadow-type”` property

The `“snap-edge”` property

The `“snap-edge-set”` property

The `“child-attached”` signal

The `“child-detached”` signal