<!-- ##### SECTION Title ##### -->
GnomeDock

<!-- ##### SECTION Short_Description ##### -->
A widget supporting movable and detachable widgets.

<!-- ##### SECTION Long_Description ##### -->
<para>
<type>GnomeDock</type> is a container widget designed to let users
move around widgets such as toolbars, menubars and so on.
</para>

<para>
Every <type>GnomeDock</type> contains a widget called the "client
area".  On the four sides of the client area, there are four "dock
areas", which can contain an arbitrary number of dockable widgets.
All the dockable widgets should be <type>GnomeDockItem</type>
widgets; the <type>GnomeDockItem</type> widget can in turn contain
any kind of widget, and implements the dragging functionality: every
<type>GnomeDockItem</type> has a handle that users can use to move
them within the dock, or even move them outside it, so that they
become "floating items".
</para>

<para>
Every "dock area" is implemented by means of zero or more "dock
bands": a dock band is a horizontal or vertical stripe containing one
or more dock items, and is implemented by the
<type>GnomeDockBand</type> widget.  Items are ordered from top to
bottom in vertical bands, and from left to right in horizontal bands.
Every dock item in a band is given an offset value that defines the
distance, in pixels, from the previous item in the same band; if the
item is first in the band, the offset defines the distance from the
start of the band.
</para>

<para>
As a consequence, the position of an item in the dock can be specified
by means of the following values: a "placement" specifying what area
is being used (top, bottom, left, right), a "band number" specifying
the number of the band within the specified area, a "position" within
the band and a "offset" from the previous item in the same band.
</para>

<!-- ##### SECTION See_Also ##### -->
<para>
#GnomeDockItem
#GnomeDockBand
#GnomeDockLayout
</para>

<!-- ##### STRUCT GnomeDock ##### -->
<para>

</para>


<!-- ##### ENUM GnomeDockPlacement ##### -->
<para>
This enumeration is used to specify the position of a dock item in the
dock widget.
</para>

<para>
<itemizedlist>
<listitem><para>GNOME_DOCK_TOP - The horizontal area at the top of the dock widget </para></listitem>
<listitem><para>GNOME_DOCK_RIGHT - The vertical area on the right side of the dock widget </para></listitem>
<listitem><para>GNOME_DOCK_BOTTOM - The horizontal area at the bottom of the dock widget </para></listitem>
<listitem><para>GNOME_DOCK_RIGHT - The vertical area on the right side of the dock widget </para></listitem>
<listitem><para>GNOME_DOCK_FLOATING - Used for floating (detached) items</para></listitem>
</itemizedlist>
</para>

<!-- ##### FUNCTION gnome_dock_new ##### -->
<para>

</para>

@Returns: 


<!-- ##### FUNCTION gnome_dock_allow_floating_items ##### -->
<para>

</para>

@dock: 
@enable: 


<!-- ##### FUNCTION gnome_dock_add_item ##### -->
<para>

</para>

@dock: 
@item: 
@placement: 
@band_num: 
@position: 
@offset: 
@in_new_band: 


<!-- ##### FUNCTION gnome_dock_add_floating_item ##### -->
<para>

</para>

@dock: 
@widget: 
@x: 
@y: 
@orientation: 


<!-- ##### FUNCTION gnome_dock_set_client_area ##### -->
<para>

</para>

@dock: 
@widget: 


<!-- ##### FUNCTION gnome_dock_get_client_area ##### -->
<para>

</para>

@dock: 
@Returns: 


<!-- ##### FUNCTION gnome_dock_get_item_by_name ##### -->
<para>

</para>

@dock: 
@name: 
@placement_return: 
@num_band_return: 
@band_position_return: 
@offset_return: 
@Returns: 


<!-- ##### FUNCTION gnome_dock_get_layout ##### -->
<para>

</para>

@dock: 
@Returns: 


<!-- ##### FUNCTION gnome_dock_add_from_layout ##### -->
<para>

</para>

@dock: 
@layout: 
@Returns: 


<!-- ##### SIGNAL GnomeDock::layout-changed ##### -->
<para>
This signal is emitted after any of the dock items has been
dragged, thus changing the dock configuration.
</para>

@dock: the object which received the signal.

