CtkHandleBox

CtkHandleBox — a widget for detachable window portions

Functions

CtkWidget * ctk_handle_box_new ()
void ctk_handle_box_set_shadow_type ()
void ctk_handle_box_set_handle_position ()
void ctk_handle_box_set_snap_edge ()
CtkPositionType ctk_handle_box_get_handle_position ()
CtkShadowType ctk_handle_box_get_shadow_type ()
CtkPositionType ctk_handle_box_get_snap_edge ()
gboolean ctk_handle_box_get_child_detached ()

Properties

gboolean child-detached Read
CtkPositionType handle-position Read / Write
CtkShadowType shadow-type Read / Write
CtkPositionType 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 CtkHandleBox
struct CtkHandleBoxClass

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── CtkWidget
            ╰── CtkContainer
                ╰── CtkBin
                    ╰── CtkHandleBox

Implemented Interfaces

CtkHandleBox implements AtkImplementorIface and CtkBuildable.

Includes

#include <ctk/ctk.h>

Description

The CtkHandleBox 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 CTK+ 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 CTK_POS_BOTTOM.

CtkHandleBox 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

ctk_handle_box_new ()

CtkWidget *
ctk_handle_box_new (void);

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

CtkHandleBox has been deprecated.

Create a new handle box.

Returns

a new CtkHandleBox.

ctk_handle_box_set_shadow_type ()

void
ctk_handle_box_set_shadow_type (CtkHandleBox *handle_box,
                                CtkShadowType type);

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

CtkHandleBox has been deprecated.

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

Parameters

handle_box

a CtkHandleBox

  

type

the shadow type.

  

ctk_handle_box_set_handle_position ()

void
ctk_handle_box_set_handle_position (CtkHandleBox *handle_box,
                                    CtkPositionType position);

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

CtkHandleBox has been deprecated.

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

Parameters

handle_box

a CtkHandleBox

  

position

the side of the handlebox where the handle should be drawn.

  

ctk_handle_box_set_snap_edge ()

void
ctk_handle_box_set_snap_edge (CtkHandleBox *handle_box,
                              CtkPositionType edge);

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

CtkHandleBox 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 CTK_POS_RIGHT or CTK_POS_LEFT, then the snap edge will be CTK_POS_TOP, otherwise it will be CTK_POS_LEFT.

Parameters

handle_box

a CtkHandleBox

  

edge

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

  

ctk_handle_box_get_handle_position ()

CtkPositionType
ctk_handle_box_get_handle_position (CtkHandleBox *handle_box);

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

CtkHandleBox has been deprecated.

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

Parameters

handle_box

a CtkHandleBox

  

Returns

the current handle position.

ctk_handle_box_get_shadow_type ()

CtkShadowType
ctk_handle_box_get_shadow_type (CtkHandleBox *handle_box);

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

CtkHandleBox has been deprecated.

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

Parameters

handle_box

a CtkHandleBox

  

Returns

the type of shadow currently drawn around the handle box.

ctk_handle_box_get_snap_edge ()

CtkPositionType
ctk_handle_box_get_snap_edge (CtkHandleBox *handle_box);

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

CtkHandleBox has been deprecated.

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

Parameters

handle_box

a CtkHandleBox

  

Returns

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

ctk_handle_box_get_child_detached ()

gboolean
ctk_handle_box_get_child_detached (CtkHandleBox *handle_box);

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

CtkHandleBox has been deprecated.

Whether the handlebox’s child is currently detached.

Parameters

handle_box

a CtkHandleBox

  

Returns

TRUE if the child is currently detached, otherwise FALSE

Since: 2.14

Types and Values

struct CtkHandleBox

struct CtkHandleBox;

struct CtkHandleBoxClass

struct CtkHandleBoxClass {
  CtkBinClass parent_class;

  void (*child_attached) (CtkHandleBox *handle_box,
				 CtkWidget *child);
  void (*child_detached) (CtkHandleBox *handle_box,
				 CtkWidget *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: CtkHandleBox

Flags: Read

Default value: FALSE

The “handle-position” property

  “handle-position”          CtkPositionType

Position of the handle relative to the child widget.

Owner: CtkHandleBox

Flags: Read / Write

Default value: CTK_POS_LEFT

The “shadow-type” property

  “shadow-type”              CtkShadowType

Appearance of the shadow that surrounds the container.

Owner: CtkHandleBox

Flags: Read / Write

Default value: CTK_SHADOW_OUT

The “snap-edge” property

  “snap-edge”                CtkPositionType

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

Owner: CtkHandleBox

Flags: Read / Write

Default value: CTK_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: CtkHandleBox

Flags: Read / Write

Default value: FALSE

Signal Details

The “child-attached” signal

void
user_function (CtkHandleBox *handlebox,
               CtkWidget    *widget,
               gpointer      user_data)

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

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

CtkHandleBox 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 (CtkHandleBox *handlebox,
               CtkWidget    *widget,
               gpointer      user_data)

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

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

CtkHandleBox 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

Generated by GTK-Doc V1.36.1