GdlDockBar

## GdlDockBar GdlDockBar — A docking bar |

## Stability Level

Unstable, unless otherwise indicated

## Synopsis

    struct              GdlDockBar;
    enum                GdlDockBarStyle;
    GtkWidget *         gdl_dock_bar_new                    (GObject *master);
    void                gdl_dock_bar_set_orientation        (GdlDockBar *dockbar,
                                                             GtkOrientation orientation);
    GtkOrientation      gdl_dock_bar_get_orientation        (GdlDockBar *dockbar);
    void                gdl_dock_bar_set_style              (GdlDockBar *dockbar,
                                                             GdlDockBarStyle style);
    GdlDockBarStyle     gdl_dock_bar_get_style              (GdlDockBar *dockbar);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----GtkWidget
                   +----GtkContainer
                         +----GtkBox
                               +----GdlDockBar

## Implemented Interfaces

GdlDockBar implements AtkImplementorIface, GtkBuildable and GtkOrientable.

## Properties

      "dockbar-style"            GdlDockBarStyle       : Read / Write / Construct
      "master"                   GObject*              : Read / Write

## Description

This docking bar is a widget containing a button for each iconified GdlDockItem widget. The widget can be re-opened by clicking on it.

A dock bar is associated with one GdlDockMaster and will get all iconified widgets of this master. This can includes widgets from several GdlDock objects.

## Details

### struct GdlDockBar

    struct GdlDockBar;

### enum GdlDockBarStyle

    typedef enum {
        GDL_DOCK_BAR_ICONS,
        GDL_DOCK_BAR_TEXT,
        GDL_DOCK_BAR_BOTH,
        GDL_DOCK_BAR_AUTO
    } GdlDockBarStyle;

Used to customize the appearance of a GdlDockBar.

`GDL_DOCK_BAR_ICONS` | Buttons display only icons in the dockbar.
`GDL_DOCK_BAR_TEXT` | Buttons display only text labels in the dockbar.
`GDL_DOCK_BAR_BOTH` | Buttons display text and icons in the dockbar.
`GDL_DOCK_BAR_AUTO` | identical to `GDL_DOCK_BAR_BOTH`.

### gdl_dock_bar_new ()

    GtkWidget *         gdl_dock_bar_new                    (GObject *master);

Creates a new GDL dock bar. If a GdlDockObject is used, the dock bar will be associated with the master of this object.

`master` : | The associated GdlDockMaster or GdlDockObject object. [allow-none]
Returns : | The newly created dock bar.

### gdl_dock_bar_set_orientation ()

    void                gdl_dock_bar_set_orientation        (GdlDockBar *dockbar,
                                                             GtkOrientation orientation);

### Warning

`gdl_dock_bar_set_orientation` has been deprecated since version 3.6 and should not be used in newly-written code. Use `gtk_orientable_set_orientation()` instead.

Set the orientation of the `dockbar`.

`dockbar` : | a GdlDockBar
`orientation` : | the new orientation

### gdl_dock_bar_get_orientation ()

    GtkOrientation      gdl_dock_bar_get_orientation        (GdlDockBar *dockbar);

### Warning

`gdl_dock_bar_get_orientation` has been deprecated since version 3.6 and should not be used in newly-written code. Use `gtk_orientable_get_orientation()` instead.

Retrieves the orientation of the `dockbar`.

`dockbar` : | a GdlDockBar
Returns : | the orientation of the `docbar`

### gdl_dock_bar_set_style ()

    void                gdl_dock_bar_set_style              (GdlDockBar *dockbar,
                                                             GdlDockBarStyle style);

Set the style of the `dockbar`.

`dockbar` : | a GdlDockBar
`style` : | the new style

### gdl_dock_bar_get_style ()

    GdlDockBarStyle     gdl_dock_bar_get_style              (GdlDockBar *dockbar);

Retrieves the style of the `dockbar`.

`dockbar` : | a GdlDockBar
Returns : | the style of the `docbar`

## Property Details

### The `"dockbar-style"` property

      "dockbar-style"            GdlDockBarStyle       : Read / Write / Construct

Dockbar style to show items on it.

Default value: GDL_DOCK_BAR_BOTH

### The `"master"` property

      "master"                   GObject*              : Read / Write

The GdlDockMaster object attached to the dockbar.

## See Also

GdlDockMaster