dzl-dock-types: Dazzle Reference Manual

## dzl-dock-types dzl-dock-types |

## Properties

DzlDockManager * | manager | Read / Write
gboolean | bottom-visible | Read / Write
gboolean | left-visible | Read / Write
gboolean | right-visible | Read / Write
gboolean | top-visible | Read / Write
GtkPositionType | edge | Read / Write
GtkPositionType | edge | Read / Write
int | position | Read / Write
GtkPositionType | edge | Read / Write
gboolean | show-pinned-button | Read / Write
DzlTabStyle | style | Read / Write
gboolean | can-close | Read / Write
GIcon * | gicon | Read / Write
char * | icon-name | Read / Write
DzlDockManager * | manager | Read / Write
char * | title | Read / Write
gboolean | active | Read / Write
gboolean | can-close | Read / Write
GtkPositionType | edge | Read / Write
DzlTabStyle | style | Read / Write
char * | title | Read / Write
GtkWidget * | widget | Read / Write
GtkPositionType | edge | Read / Write
GtkStack * | stack | Read / Write
DzlTabStyle | style | Read / Write

## Signals

void | move-to-bin-child | Action
void | manager-set | Run Last
void | needs-attention | Run Last
void | presented | Run Last
void | register-dock | Run Last
void | unregister-dock | Run Last
void | hide-edges | Action
void | clicked | Run Last

## Types and Values

#define | DZL_TYPE_DOCK
#define | DZL_TYPE_DOCK_BIN
#define | DZL_TYPE_DOCK_BIN_EDGE
#define | DZL_TYPE_DOCK_ITEM
#define | DZL_TYPE_DOCK_MANAGER
#define | DZL_TYPE_DOCK_OVERLAY
#define | DZL_TYPE_DOCK_OVERLAY_EDGE
#define | DZL_TYPE_DOCK_PANED
#define | DZL_TYPE_DOCK_STACK
#define | DZL_TYPE_DOCK_TAB_STRIP
#define | DZL_TYPE_DOCK_WIDGET
#define | DZL_TYPE_DOCK_WINDOW
#define | DZL_TYPE_TAB
#define | DZL_TYPE_TAB_STRIP
| DzlDock
| DzlDockBin
| DzlDockBinClass
| DzlDockBinEdge
| DzlDockBinEdgeClass
| DzlDockInterface
| DzlDockItem
| DzlDockItemInterface
| DzlDockManager
| DzlDockManagerClass
| DzlDockOverlay
| DzlDockOverlayClass
| DzlDockOverlayEdge
| DzlDockPaned
| DzlDockPanedClass
| DzlDockStack
| DzlDockStackClass
| DzlDockWidget
| DzlDockWidgetClass
| DzlDockWindow
| DzlDockWindowClass
| DzlTab
| DzlTabStrip
| DzlTabStripClass

## Object Hierarchy

        GFlags
        ╰── DzlTabStyle
        GInterface
        ├── DzlDock
        ╰── DzlDockItem
        GObject
        ├── DzlDockManager
        ╰── GInitiallyUnowned
            ╰── GtkWidget
                ╰── GtkContainer
                    ├── DzlMultiPaned
                    │   ╰── DzlDockPaned
                    ├── GtkBin
                    │   ├── DzlBin
                    │   │   ├── DzlDockOverlayEdge
                    │   │   ├── DzlDockRevealer
                    │   │   │   ╰── DzlDockBinEdge
                    │   │   ├── DzlDockWidget
                    │   │   ╰── DzlTab
                    │   ├── GtkEventBox
                    │   │   ╰── DzlDockOverlay
                    │   ╰── GtkWindow
                    │       ╰── DzlDockWindow
                    ├── GtkBox
                    │   ├── DzlDockStack
                    │   ╰── DzlTabStrip
                    ╰── DzlDockBin

## Prerequisites

DzlDock requires GtkContainer.

DzlDockItem requires GtkWidget.

## Implemented Interfaces

DzlDockBin implements AtkImplementorIface, GtkBuildable, DzlDockItem and DzlDock.

DzlDockBinEdge implements AtkImplementorIface, GtkBuildable and DzlDockItem.

DzlDockOverlay implements AtkImplementorIface, GtkBuildable, DzlDockItem and DzlDock.

DzlDockOverlayEdge implements AtkImplementorIface, GtkBuildable and DzlDockItem.

DzlDockPaned implements AtkImplementorIface, GtkBuildable, GtkOrientable and DzlDockItem.

DzlDockStack implements AtkImplementorIface, GtkBuildable, GtkOrientable and DzlDockItem.

DzlDockWidget implements AtkImplementorIface, GtkBuildable and DzlDockItem.

DzlDockWindow implements AtkImplementorIface, GtkBuildable, DzlDockItem and DzlDock.

DzlTab implements AtkImplementorIface, GtkBuildable and GtkActionable.

DzlTabStrip implements AtkImplementorIface, GtkBuildable and GtkOrientable.

## Known Implementations

DzlDock is implemented by DzlDockBin, DzlDockOverlay and DzlDockWindow.

DzlDockItem is implemented by DzlDockBin, DzlDockBinEdge, DzlDockOverlay, DzlDockOverlayEdge, DzlDockPaned, DzlDockStack, DzlDockWidget and DzlDockWindow.

## Description

## Functions

## Types and Values

### DZL_TYPE_DOCK

    #define DZL_TYPE_DOCK                   (dzl_dock_get_type ())

### DZL_TYPE_DOCK_BIN

    #define DZL_TYPE_DOCK_BIN               (dzl_dock_bin_get_type())

### DZL_TYPE_DOCK_BIN_EDGE

    #define DZL_TYPE_DOCK_BIN_EDGE          (dzl_dock_bin_edge_get_type())

### DZL_TYPE_DOCK_ITEM

    #define DZL_TYPE_DOCK_ITEM              (dzl_dock_item_get_type())

### DZL_TYPE_DOCK_MANAGER

    #define DZL_TYPE_DOCK_MANAGER           (dzl_dock_manager_get_type())

### DZL_TYPE_DOCK_OVERLAY

    #define DZL_TYPE_DOCK_OVERLAY           (dzl_dock_overlay_get_type())

### DZL_TYPE_DOCK_OVERLAY_EDGE

    #define DZL_TYPE_DOCK_OVERLAY_EDGE      (dzl_dock_overlay_edge_get_type())

### DZL_TYPE_DOCK_PANED

    #define DZL_TYPE_DOCK_PANED             (dzl_dock_paned_get_type())

### DZL_TYPE_DOCK_STACK

    #define DZL_TYPE_DOCK_STACK             (dzl_dock_stack_get_type())

### DZL_TYPE_DOCK_TAB_STRIP

    #define DZL_TYPE_DOCK_TAB_STRIP         (dzl_dock_tab_strip_get_type())

### DZL_TYPE_DOCK_WIDGET

    #define DZL_TYPE_DOCK_WIDGET            (dzl_dock_widget_get_type())

### DZL_TYPE_DOCK_WINDOW

    #define DZL_TYPE_DOCK_WINDOW            (dzl_dock_window_get_type())

### DZL_TYPE_TAB

    #define DZL_TYPE_TAB                    (dzl_tab_get_type())

### DZL_TYPE_TAB_STRIP

    #define DZL_TYPE_TAB_STRIP              (dzl_tab_strip_get_type())

### DzlDock

    typedef struct _DzlDock DzlDock;

### DzlDockBin

    typedef struct _DzlDockBin DzlDockBin;

### DzlDockBinClass

    typedef struct {
      GtkContainerClass parent;

      GtkWidget *(*create_edge) (DzlDockBin      *self,
                                 GtkPositionType  edge);

      gpointer _reserved1;
      gpointer _reserved2;
      gpointer _reserved3;
      gpointer _reserved4;
      gpointer _reserved5;
      gpointer _reserved6;
      gpointer _reserved7;
      gpointer _reserved8;
    } DzlDockBinClass;

### DzlDockBinEdge

    typedef struct _DzlDockBinEdge DzlDockBinEdge;

### DzlDockBinEdgeClass

    typedef struct {
      DzlDockRevealerClass parent;

      void (*move_to_bin_child) (DzlDockBinEdge *self);

      gpointer _reserved1;
      gpointer _reserved2;
      gpointer _reserved3;
      gpointer _reserved4;
      gpointer _reserved5;
      gpointer _reserved6;
      gpointer _reserved7;
      gpointer _reserved8;
    } DzlDockBinEdgeClass;

### DzlDockInterface

    typedef struct {
      GTypeInterface parent;
    } DzlDockInterface;

### DzlDockItem

    typedef struct _DzlDockItem DzlDockItem;

### DzlDockItemInterface

    typedef struct {
      GTypeInterface parent;

      void            (*set_manager)        (DzlDockItem     *self,
                                             DzlDockManager  *manager);
      DzlDockManager *(*get_manager)        (DzlDockItem     *self);
      void            (*manager_set)        (DzlDockItem     *self,
                                             DzlDockManager  *old_manager);
      void            (*present_child)      (DzlDockItem     *self,
                                             DzlDockItem     *child);
      void            (*update_visibility)  (DzlDockItem     *self);
      gboolean        (*get_child_visible)  (DzlDockItem     *self,
                                             DzlDockItem     *child);
      void            (*set_child_visible)  (DzlDockItem     *self,
                                             DzlDockItem     *child,
                                             gboolean         child_visible);
      gchar          *(*get_title)          (DzlDockItem     *self);
      gchar          *(*get_icon_name)      (DzlDockItem     *self);
      gboolean        (*get_can_close)      (DzlDockItem     *self);
      gboolean        (*can_minimize)       (DzlDockItem     *self,
                                             DzlDockItem     *descendant);
      gboolean        (*close)              (DzlDockItem     *self);
      gboolean        (*minimize)           (DzlDockItem     *self,
                                             DzlDockItem     *child,
                                             GtkPositionType *position);
      void            (*release)            (DzlDockItem     *self,
                                             DzlDockItem     *child);
      void            (*presented)          (DzlDockItem     *self);
      GIcon          *(*ref_gicon)          (DzlDockItem     *self);
      void            (*needs_attention)    (DzlDockItem     *self);
    } DzlDockItemInterface;

### DzlDockManager

    typedef struct _DzlDockManager DzlDockManager;

### DzlDockManagerClass

    typedef struct {
      GObjectClass parent;

      void (*register_dock)   (DzlDockManager *self,
                               DzlDock        *dock);
      void (*unregister_dock) (DzlDockManager *self,
                               DzlDock        *dock);

      gpointer _reserved1;
      gpointer _reserved2;
      gpointer _reserved3;
      gpointer _reserved4;
      gpointer _reserved5;
      gpointer _reserved6;
      gpointer _reserved7;
      gpointer _reserved8;
    } DzlDockManagerClass;

### DzlDockOverlay

    typedef struct _DzlDockOverlay DzlDockOverlay;

### DzlDockOverlayClass

    typedef struct {
      GtkEventBoxClass parent;

      void (*hide_edges) (DzlDockOverlay *self);

      gpointer _reserved1;
      gpointer _reserved2;
      gpointer _reserved3;
      gpointer _reserved4;
      gpointer _reserved5;
      gpointer _reserved6;
      gpointer _reserved7;
      gpointer _reserved8;
    } DzlDockOverlayClass;

### DzlDockOverlayEdge

    typedef struct _DzlDockOverlayEdge DzlDockOverlayEdge;

### DzlDockPaned

    typedef struct _DzlDockPaned DzlDockPaned;

### DzlDockPanedClass

    typedef struct {
      DzlMultiPanedClass parent;

      gpointer _reserved1;
      gpointer _reserved2;
      gpointer _reserved3;
      gpointer _reserved4;
      gpointer _reserved5;
      gpointer _reserved6;
      gpointer _reserved7;
      gpointer _reserved8;
    } DzlDockPanedClass;

### DzlDockStack

    typedef struct _DzlDockStack DzlDockStack;

### DzlDockStackClass

    typedef struct {
      GtkBoxClass parent;

      gpointer _reserved1;
      gpointer _reserved2;
      gpointer _reserved3;
      gpointer _reserved4;
    } DzlDockStackClass;

### DzlDockWidget

    typedef struct _DzlDockWidget DzlDockWidget;

### DzlDockWidgetClass

    typedef struct {
      DzlBinClass parent;

      gpointer _reserved1;
      gpointer _reserved2;
      gpointer _reserved3;
      gpointer _reserved4;
      gpointer _reserved5;
      gpointer _reserved6;
      gpointer _reserved7;
      gpointer _reserved8;
    } DzlDockWidgetClass;

### DzlDockWindow

    typedef struct _DzlDockWindow DzlDockWindow;

### DzlDockWindowClass

    typedef struct {
      GtkWindowClass parent;

      gpointer _reserved1;
      gpointer _reserved2;
      gpointer _reserved3;
      gpointer _reserved4;
      gpointer _reserved5;
      gpointer _reserved6;
      gpointer _reserved7;
      gpointer _reserved8;
    } DzlDockWindowClass;

### DzlTab

    typedef struct _DzlTab DzlTab;

### DzlTabStrip

    typedef struct _DzlTabStrip DzlTabStrip;

### DzlTabStripClass

    typedef struct {
      GtkBoxClass parent;

      gpointer _reserved1;
      gpointer _reserved2;
      gpointer _reserved3;
      gpointer _reserved4;
      gpointer _reserved5;
      gpointer _reserved6;
      gpointer _reserved7;
      gpointer _reserved8;
    } DzlTabStripClass;

## Property Details

### The `“manager”` property

      “manager”                  DzlDockManager *

Manager.

Owner: DzlDock

Flags: Read / Write

### The `“bottom-visible”` property

      “bottom-visible”           gboolean

If the bottom panel is visible.

Owner: DzlDockBin

Flags: Read / Write

Default value: FALSE

### The `“left-visible”` property

      “left-visible”             gboolean

If the left panel is visible.

Owner: DzlDockBin

Flags: Read / Write

Default value: FALSE

### The `“right-visible”` property

      “right-visible”            gboolean

If the right panel is visible.

Owner: DzlDockBin

Flags: Read / Write

Default value: FALSE

### The `“top-visible”` property

      “top-visible”              gboolean

If the top panel is visible.

Owner: DzlDockBin

Flags: Read / Write

Default value: FALSE

### The `“edge”` property

      “edge”                     GtkPositionType

The edge of the dock this widget is attached to.

Owner: DzlDockBinEdge

Flags: Read / Write

Default value: GTK_POS_LEFT

### The `“edge”` property

      “edge”                     GtkPositionType

Edge.

Owner: DzlDockOverlayEdge

Flags: Read / Write

Default value: GTK_POS_LEFT

### The `“position”` property

      “position”                 int

The size of the edge.

Owner: DzlDockOverlayEdge

Flags: Read / Write

Allowed values: >= 0

Default value: 0

### The `“edge”` property

      “edge”                     GtkPositionType

The edge for the tab strip.

Owner: DzlDockStack

Flags: Read / Write

Default value: GTK_POS_TOP

### The `“show-pinned-button”` property

      “show-pinned-button”       gboolean

Show the pinned button to pin the dock edge.

Owner: DzlDockStack

Flags: Read / Write

Default value: FALSE

### The `“style”` property

      “style”                    DzlTabStyle

Style.

Owner: DzlDockStack

Flags: Read / Write

Default value: DZL_TAB_ICONS | DZL_TAB_TEXT

### The `“can-close”` property

      “can-close”                gboolean

If the dock widget can be closed by the user.

Owner: DzlDockWidget

Flags: Read / Write

Default value: FALSE

### The `“gicon”` property

      “gicon”                    GIcon *

The GIcon to be displayed.

Owner: DzlDockWidget

Flags: Read / Write

### The `“icon-name”` property

      “icon-name”                char *

Icon Name.

Owner: DzlDockWidget

Flags: Read / Write

Default value: NULL

### The `“manager”` property

      “manager”                  DzlDockManager *

The panel manager.

Owner: DzlDockWidget

Flags: Read / Write

### The `“title”` property

      “title”                    char *

Title.

Owner: DzlDockWidget

Flags: Read / Write

Default value: NULL

### The `“active”` property

      “active”                   gboolean

If the tab is currently active.

Owner: DzlTab

Flags: Read / Write

Default value: FALSE

### The `“can-close”` property

      “can-close”                gboolean

If the tab widget can be closed.

Owner: DzlTab

Flags: Read / Write

Default value: FALSE

### The `“edge”` property

      “edge”                     GtkPositionType

Edge.

Owner: DzlTab

Flags: Read / Write

Default value: GTK_POS_TOP

### The `“style”` property

      “style”                    DzlTabStyle

The style for the tab.

Owner: DzlTab

Flags: Read / Write

Default value: DZL_TAB_ICONS | DZL_TAB_TEXT

### The `“title”` property

      “title”                    char *

Title.

Owner: DzlTab

Flags: Read / Write

Default value: NULL

### The `“widget”` property

      “widget”                   GtkWidget *

The widget the tab represents.

Owner: DzlTab

Flags: Read / Write

### The `“edge”` property

      “edge”                     GtkPositionType

The edge for the tab-strip.

Owner: DzlTabStrip

Flags: Read / Write

Default value: GTK_POS_TOP

### The `“stack”` property

      “stack”                    GtkStack *

The stack of items to manage.

Owner: DzlTabStrip

Flags: Read / Write

### The `“style”` property

      “style”                    DzlTabStyle

The tab style.

Owner: DzlTabStrip

Flags: Read / Write

Default value: DZL_TAB_ICONS | DZL_TAB_TEXT

## Signal Details

### The `“move-to-bin-child”` signal

    void
    user_function (DzlDockBinEdge *dzldockbinedge,
                   gpointer        user_data)

Flags: Action

### The `“manager-set”` signal

    void
    user_function (DzlDockItem    *dzldockitem,
                   DzlDockManager *arg1,
                   gpointer        user_data)

Flags: Run Last

### The `“needs-attention”` signal

    void
    user_function (DzlDockItem *dzldockitem,
                   gpointer     user_data)

Flags: Run Last

### The `“presented”` signal

    void
    user_function (DzlDockItem *dzldockitem,
                   gpointer     user_data)

Flags: Run Last

### The `“register-dock”` signal

    void
    user_function (DzlDockManager *dzldockmanager,
                   DzlDock        *arg1,
                   gpointer        user_data)

Flags: Run Last

### The `“unregister-dock”` signal

    void
    user_function (DzlDockManager *dzldockmanager,
                   DzlDock        *arg1,
                   gpointer        user_data)

Flags: Run Last

### The `“hide-edges”` signal

    void
    user_function (DzlDockOverlay *dzldockoverlay,
                   gpointer        user_data)

Flags: Action

### The `“clicked”` signal

    void
    user_function (DzlTab  *dzltab,
                   gpointer user_data)

Flags: Run Last