GDL_DOCK_ITEM_CANT_CLOSE()

#define GDL_DOCK_ITEM_CANT_CLOSE(item) ((gdl_dock_item_get_behavior_flags(item) & GDL_DOCK_ITEM_BEH_CANT_CLOSE) != 0)

Evaluates to TRUE the item cannot be closed.

GDL_DOCK_ITEM_CANT_ICONIFY()

#define GDL_DOCK_ITEM_CANT_ICONIFY(item) ((gdl_dock_item_get_behavior_flags(item) & GDL_DOCK_ITEM_BEH_CANT_ICONIFY) != 0)

Evaluates to TRUE the item cannot be iconifyed.

GDL_DOCK_ITEM_FLAGS()

#define GDL_DOCK_ITEM_FLAGS(item)     (GDL_DOCK_OBJECT (item)->flags)

Get all flags of GdlDockObject.

GDL_DOCK_ITEM_HAS_GRIP()

#define GDL_DOCK_ITEM_HAS_GRIP(item) ((gdl_dock_item_get_behavior_flags (item) & GDL_DOCK_ITEM_BEH_NO_GRIP) == 0)

Evaluates to TRUE the item has a handle, so it can be moved.

GDL_DOCK_ITEM_ICONIFIED()

#define             GDL_DOCK_ITEM_ICONIFIED(item)

Evaluates to TRUE if the item is iconified, appearing only as a button in the dock bar.

GDL_DOCK_ITEM_IN_DRAG()

#define             GDL_DOCK_ITEM_IN_DRAG(item)

Evaluates to TRUE if the user is dragging the item.

GDL_DOCK_ITEM_IN_PREDRAG()

#define             GDL_DOCK_ITEM_IN_PREDRAG(item)

Evaluates to TRUE if the user has clicked on the item but hasn't made a big enough move to start the drag operation.

GDL_DOCK_ITEM_NOT_LOCKED()

#define GDL_DOCK_ITEM_NOT_LOCKED(item) ((gdl_dock_item_get_behavior_flags(item) & GDL_DOCK_ITEM_BEH_LOCKED) == 0)

Evaluates to TRUE the item can be moved, closed, or iconified.

GDL_DOCK_ITEM_NO_GRIP()

#define GDL_DOCK_ITEM_NO_GRIP(item) ((gdl_dock_item_get_behavior_flags(item) & GDL_DOCK_ITEM_BEH_NO_GRIP) != 0)

Evaluates to TRUE the item has not handle, so it cannot be moved.

GDL_DOCK_ITEM_SET_FLAGS()

#define             GDL_DOCK_ITEM_SET_FLAGS(item,flag)

Set one or more flags of a dock object.

GDL_DOCK_ITEM_UNSET_FLAGS()

#define             GDL_DOCK_ITEM_UNSET_FLAGS(item,flag)

Clear one or more flags of a dock object.

GDL_DOCK_ITEM_USER_ACTION()

#define             GDL_DOCK_ITEM_USER_ACTION(item)

Evaluates to TRUE if the user currently use the item, by example dragging division of a GdlDockPaned object.

gdl_dock_item_new ()

GtkWidget *
gdl_dock_item_new (const gchar *name,
                   const gchar *long_name,
                   GdlDockItemBehavior behavior);

Creates a new dock item widget.

gdl_dock_item_new_with_pixbuf_icon ()

GtkWidget *
gdl_dock_item_new_with_pixbuf_icon (const gchar *name,
                                    const gchar *long_name,
                                    const GdkPixbuf *pixbuf_icon,
                                    GdlDockItemBehavior behavior);

Creates a new dock item grip widget with a given pixbuf icon.

Since: 3.3.2

gdl_dock_item_new_with_stock ()

GtkWidget *
gdl_dock_item_new_with_stock (const gchar *name,
                              const gchar *long_name,
                              const gchar *stock_id,
                              GdlDockItemBehavior behavior);

Creates a new dock item grip widget with a given stock id.

gdl_dock_item_bind ()

void
gdl_dock_item_bind (GdlDockItem *item,
                    GtkWidget *dock);

Binds this dock item to a new dock master.

gdl_dock_item_unbind ()

void
gdl_dock_item_unbind (GdlDockItem *item);

Unbinds this dock item from it's dock master.

gdl_dock_item_show_grip ()

void
gdl_dock_item_show_grip (GdlDockItem *item);

This function shows the dock item's grip widget.

gdl_dock_item_hide_grip ()

void
gdl_dock_item_hide_grip (GdlDockItem *item);

This function hides the dock item's grip widget.

gdl_dock_item_show_item ()

void
gdl_dock_item_show_item (GdlDockItem *item);

This function shows the dock item. When dock items are shown, they are displayed in their normal layout position.

gdl_dock_item_hide_item ()

void
gdl_dock_item_hide_item (GdlDockItem *item);

This function hides the dock item. Since version 3.6, when dock items are hidden they are not removed from the layout.

The dock item close button causes the panel to be hidden.

gdl_dock_item_iconify_item ()

void
gdl_dock_item_iconify_item (GdlDockItem *item);

This function iconifies the dock item. When dock items are iconified they are hidden, and appear only as icons in dock bars.

The dock item iconify button causes the panel to be iconified.

gdl_dock_item_dock_to ()

void
gdl_dock_item_dock_to (GdlDockItem *item,
                       GdlDockItem *target,
                       GdlDockPlacement position,
                       gint docking_param);

Relocates a dock item to a new location relative to another dock item.

gdl_dock_item_lock ()

void
gdl_dock_item_lock (GdlDockItem *item);

This function locks the dock item. When locked the dock item cannot be dragged around and it doesn't show a grip.

gdl_dock_item_unlock ()

void
gdl_dock_item_unlock (GdlDockItem *item);

This function unlocks the dock item. When unlocked the dock item can be dragged around and can show a grip.

gdl_dock_item_notify_deselected ()

void
gdl_dock_item_notify_deselected (GdlDockItem *item);

This function emits the deselected signal. It is used by GdlSwitcher to let clients know that this item has been deselected.

gdl_dock_item_notify_selected ()

void
gdl_dock_item_notify_selected (GdlDockItem *item);

This function emits the selected signal. It is to be used by GdlSwitcher to let clients know that this item has been switched to.

gdl_dock_item_get_grip ()

GtkWidget *
gdl_dock_item_get_grip (GdlDockItem *item);

This function returns the dock item's grip label widget.

gdl_dock_item_get_tablabel ()

GtkWidget *
gdl_dock_item_get_tablabel (GdlDockItem *item);

Gets the current tab label widget. Note that this label widget is only visible when the "switcher-style" property of the GdlDockMaster is set to GDL_SWITCHER_STYLE_TABS

gdl_dock_item_or_child_has_focus ()

gboolean
gdl_dock_item_or_child_has_focus (GdlDockItem *item);

Checks whether a given GdlDockItem or its child widget has focus. This check is performed recursively on child widgets.

Since: 3.3.2

gdl_dock_item_preferred_size ()

void
gdl_dock_item_preferred_size (GdlDockItem *item,
                              GtkRequisition *req);

Gets the preferred size of the dock item in pixels.

gdl_dock_item_set_default_position ()

void
gdl_dock_item_set_default_position (GdlDockItem *item,
                                    GdlDockObject *reference);

This method has only an effect when you add you dock_item with GDL_DOCK_ITEM_BEH_NEVER_FLOATING. In this case you have to assign it a default position.*

Deprecated 3.6: This function is doing nothing now.

gdl_dock_item_set_orientation ()

void
gdl_dock_item_set_orientation (GdlDockItem *item,
                               GtkOrientation orientation);

This function sets the layout of the dock item.

gdl_dock_item_set_tablabel ()

void
gdl_dock_item_set_tablabel (GdlDockItem *item,
                            GtkWidget *tablabel);

Replaces the current tab label widget with another widget. Note that this label widget is only visible when the "switcher-style" property of the GdlDockMaster is set to GDL_SWITCHER_STYLE_TABS

struct GdlDockItem

struct GdlDockItem;

enum GdlDockItemBehavior

Described the behaviour of a doc item. The item can have multiple flags set.

struct GdlDockItemClass

struct GdlDockItemClass {
    GdlDockObjectClass  parent_class;

    GdlDockItemClassPrivate *priv;

    /* virtuals */
    void     (* set_orientation)  (GdlDockItem    *item,
                                   GtkOrientation  orientation);

    /* signals */
    void     (* dock_drag_begin)  (GdlDockItem    *item);
    void     (* dock_drag_motion) (GdlDockItem    *item,
                                   GdkDevice      *device,
                                   gint            x,
                                   gint            y);
    void     (* dock_drag_end)    (GdlDockItem    *item,
                                   gboolean        cancelled);
    void     (* move_focus_child) (GdlDockItem      *item,
                                   GtkDirectionType  direction);
};

enum GdlDockItemFlags

Status flag of a GdlDockItem. Don't use unless you derive a widget from GdlDockItem

The “behavior” property

  “behavior”                 GdlDockItemBehavior

General behavior for the dock item (i.e. whether it can float, if it's locked, etc.).

Owner: GdlDockItem

Flags: Read / Write

The “closed” property

  “closed”                   gboolean

If set, the dock item is closed.

Owner: GdlDockItem

Flags: Read / Write

Default value: FALSE

Since: 3.6

The “iconified” property

  “iconified”                gboolean

If set, the dock item is hidden but it has a corresponding icon in the dock bar allowing to show it again.

Owner: GdlDockItem

Flags: Read / Write

Default value: FALSE

Since: 3.6

The “locked” property

  “locked”                   gboolean

If set, the dock item cannot be dragged around and it doesn't show a grip.

Owner: GdlDockItem

Flags: Read / Write

Default value: FALSE

The “orientation” property

  “orientation”              GtkOrientation

The orientation of the docking item. If the orientation is set to GTK_ORIENTATION_VERTICAL, the grip widget will be shown along the top of the edge of item (if it is not hidden). If the orientation is set to GTK_ORIENTATION_HORIZONTAL, the grip widget will be shown down the left edge of the item (even if the widget text direction is set to RTL).

Owner: GdlDockItem

Flags: Read / Write / Construct

Default value: GTK_ORIENTATION_VERTICAL

The “preferred-height” property

  “preferred-height”         int

Preferred height for the dock item.

Owner: GdlDockItem

Flags: Read / Write

Allowed values: >= -1

Default value: -1

The “preferred-width” property

  “preferred-width”          int

Preferred width for the dock item.

Owner: GdlDockItem

Flags: Read / Write

Allowed values: >= -1

Default value: -1

The “resize” property

  “resize”                   gboolean

If set, the dock item can be resized when docked in a GtkPanel widget.

Owner: GdlDockItem

Flags: Read / Write

Default value: TRUE

The “deselected” signal

void
user_function (GdlDockItem *gdldockitem,
               gpointer     user_data)

Signals that this dock has been deselected in a switcher.

Flags: Run First

The “dock-drag-begin” signal

void
user_function (GdlDockItem *item,
               gpointer     user_data)

Signals that the dock item has begun to be dragged.

Flags: Run First

The “dock-drag-end” signal

void
user_function (GdlDockItem *item,
               gboolean     cancel,
               gpointer     user_data)

Signals that the dock item dragging has ended.

Flags: Run First

The “dock-drag-motion” signal

void
user_function (GdlDockItem *item,
               GdkDevice   *device,
               int          x,
               int          y,
               gpointer     user_data)

Signals that a dock item dragging motion event has occured.

Flags: Run First

The “move-focus-child” signal

void
user_function (GdlDockItem     *gdldockitem,
               GtkDirectionType dir,
               gpointer         user_data)

The ::move-focus-child signal is emitted when a change of focus is requested for the child widget of a dock item. The dir parameter specifies the direction in which focus is to be shifted.

Flags: Action

Since: 3.3.2

The “selected” signal

void
user_function (GdlDockItem *gdldockitem,
               gpointer     user_data)

Signals that this dock has been selected from a switcher.

Flags: Run First