<HTML
><HEAD
><TITLE
>GnomeDock</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.74b"><LINK
REL="HOME"
TITLE="Gnome User Interface Library Reference Manual"
HREF="book1.html"><LINK
REL="UP"
TITLE="GNOME Widgets and Objects"
HREF="gnome-objects.html"><LINK
REL="PREVIOUS"
TITLE="GnomeDockItem"
HREF="gnomedockitem.html"><LINK
REL="NEXT"
TITLE="GnomeDruid"
HREF="gnomedruid.html"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
WIDTH="100%"
BORDER="0"
BGCOLOR="#000000"
CELLPADDING="1"
CELLSPACING="0"
><TR
><TH
COLSPAN="4"
ALIGN="center"
><FONT
COLOR="#FFFFFF"
SIZE="5"
>Gnome User Interface Library Reference Manual</FONT
></TH
></TR
><TR
><TD
WIDTH="25%"
BGCOLOR="#C00000"
ALIGN="left"
><A
HREF="gnomedockitem.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
><<< Previous Page</B
></FONT
></A
></TD
><TD
WIDTH="25%"
BGCOLOR="#0000C0"
ALIGN="center"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
><A
HREF="book1.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>Home</B
></FONT
></A
></B
></FONT
></TD
><TD
WIDTH="25%"
BGCOLOR="#00C000"
ALIGN="center"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
><A
HREF="gnome-objects.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>Up</B
></FONT
></A
></B
></FONT
></TD
><TD
WIDTH="25%"
BGCOLOR="#C00000"
ALIGN="right"
><A
HREF="gnomedruid.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>Next Page >>></B
></FONT
></A
></TD
></TR
></TABLE
></DIV
><H1
><A
NAME="GNOMEDOCK"
>GnomeDock</A
></H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN15469"
></A
><H2
>Name</H2
>GnomeDock -- A widget supporting movable and detachable widgets.</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN15472"
></A
><H2
>Synopsis</H2
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="SYNOPSIS"
> #include <gnome.h>
struct <A
HREF="gnomedock.html#GNOMEDOCK-STRUCT"
>GnomeDock</A
>;
enum <A
HREF="gnomedock.html#GNOMEDOCKPLACEMENT"
>GnomeDockPlacement</A
>;
<GTKDOCLINK
HREF="GTKWIDGET"
>GtkWidget</GTKDOCLINK
>* <A
HREF="gnomedock.html#GNOME-DOCK-NEW"
>gnome_dock_new</A
> (void);
void <A
HREF="gnomedock.html#GNOME-DOCK-ALLOW-FLOATING-ITEMS"
>gnome_dock_allow_floating_items</A
> (<A
HREF="gnomedock.html"
>GnomeDock</A
> *dock,
<GTKDOCLINK
HREF="GBOOLEAN"
>gboolean</GTKDOCLINK
> enable);
void <A
HREF="gnomedock.html#GNOME-DOCK-ADD-ITEM"
>gnome_dock_add_item</A
> (<A
HREF="gnomedock.html"
>GnomeDock</A
> *dock,
<A
HREF="gnomedockitem.html"
>GnomeDockItem</A
> *item,
<A
HREF="gnomedock.html#GNOMEDOCKPLACEMENT"
>GnomeDockPlacement</A
> placement,
<GTKDOCLINK
HREF="GUINT"
>guint</GTKDOCLINK
> band_num,
<GTKDOCLINK
HREF="GINT"
>gint</GTKDOCLINK
> position,
<GTKDOCLINK
HREF="GUINT"
>guint</GTKDOCLINK
> offset,
<GTKDOCLINK
HREF="GBOOLEAN"
>gboolean</GTKDOCLINK
> in_new_band);
void <A
HREF="gnomedock.html#GNOME-DOCK-ADD-FLOATING-ITEM"
>gnome_dock_add_floating_item</A
> (<A
HREF="gnomedock.html"
>GnomeDock</A
> *dock,
<A
HREF="gnomedockitem.html"
>GnomeDockItem</A
> *widget,
<GTKDOCLINK
HREF="GINT"
>gint</GTKDOCLINK
> x,
<GTKDOCLINK
HREF="GINT"
>gint</GTKDOCLINK
> y,
<GTKDOCLINK
HREF="GTKORIENTATION"
>GtkOrientation</GTKDOCLINK
> orientation);
void <A
HREF="gnomedock.html#GNOME-DOCK-SET-CLIENT-AREA"
>gnome_dock_set_client_area</A
> (<A
HREF="gnomedock.html"
>GnomeDock</A
> *dock,
<GTKDOCLINK
HREF="GTKWIDGET"
>GtkWidget</GTKDOCLINK
> *widget);
<GTKDOCLINK
HREF="GTKWIDGET"
>GtkWidget</GTKDOCLINK
>* <A
HREF="gnomedock.html#GNOME-DOCK-GET-CLIENT-AREA"
>gnome_dock_get_client_area</A
> (<A
HREF="gnomedock.html"
>GnomeDock</A
> *dock);
<A
HREF="gnomedockitem.html"
>GnomeDockItem</A
>* <A
HREF="gnomedock.html#GNOME-DOCK-GET-ITEM-BY-NAME"
>gnome_dock_get_item_by_name</A
> (<A
HREF="gnomedock.html"
>GnomeDock</A
> *dock,
const <GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *name,
<A
HREF="gnomedock.html#GNOMEDOCKPLACEMENT"
>GnomeDockPlacement</A
> *placement_return,
<GTKDOCLINK
HREF="GUINT"
>guint</GTKDOCLINK
> *num_band_return,
<GTKDOCLINK
HREF="GUINT"
>guint</GTKDOCLINK
> *band_position_return,
<GTKDOCLINK
HREF="GUINT"
>guint</GTKDOCLINK
> *offset_return);
<A
HREF="gnomedocklayout.html"
>GnomeDockLayout</A
>* <A
HREF="gnomedock.html#GNOME-DOCK-GET-LAYOUT"
>gnome_dock_get_layout</A
> (<A
HREF="gnomedock.html"
>GnomeDock</A
> *dock);
<GTKDOCLINK
HREF="GBOOLEAN"
>gboolean</GTKDOCLINK
> <A
HREF="gnomedock.html#GNOME-DOCK-ADD-FROM-LAYOUT"
>gnome_dock_add_from_layout</A
> (<A
HREF="gnomedock.html"
>GnomeDock</A
> *dock,
<A
HREF="gnomedocklayout.html"
>GnomeDockLayout</A
> *layout); </PRE
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN15517"
></A
><H2
>Object Hierarchy</H2
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="SYNOPSIS"
> <GTKDOCLINK
HREF="GTKOBJECT"
>GtkObject</GTKDOCLINK
>
+----<GTKDOCLINK
HREF="GTKWIDGET"
>GtkWidget</GTKDOCLINK
>
+----<GTKDOCLINK
HREF="GTKCONTAINER"
>GtkContainer</GTKDOCLINK
>
+----GnomeDock</PRE
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN15523"
></A
><H2
>Description</H2
><P
><SPAN
CLASS="TYPE"
>GnomeDock</SPAN
> is a container widget designed to let users
move around widgets such as toolbars, menubars and so on.</P
><P
>Every <SPAN
CLASS="TYPE"
>GnomeDock</SPAN
> 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 <SPAN
CLASS="TYPE"
>GnomeDockItem</SPAN
>
widgets; the <SPAN
CLASS="TYPE"
>GnomeDockItem</SPAN
> widget can in turn contain
any kind of widget, and implements the dragging functionality: every
<SPAN
CLASS="TYPE"
>GnomeDockItem</SPAN
> 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".</P
><P
>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
<SPAN
CLASS="TYPE"
>GnomeDockBand</SPAN
> 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.</P
><P
>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.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN15535"
></A
><H2
>Details</H2
><DIV
CLASS="REFSECT2"
><A
NAME="AEN15537"
></A
><H3
><A
NAME="GNOMEDOCK-STRUCT"
></A
>struct GnomeDock</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>struct GnomeDock;</PRE
></TD
></TR
></TABLE
><P
></P
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN15542"
></A
><H3
><A
NAME="GNOMEDOCKPLACEMENT"
></A
>enum GnomeDockPlacement</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>typedef enum
{
GNOME_DOCK_TOP,
GNOME_DOCK_RIGHT,
GNOME_DOCK_BOTTOM,
GNOME_DOCK_LEFT,
GNOME_DOCK_FLOATING
} GnomeDockPlacement;</PRE
></TD
></TR
></TABLE
><P
>This enumeration is used to specify the position of a dock item in the
dock widget.</P
><P
><P
></P
><UL
><LI
><P
>GNOME_DOCK_TOP - The horizontal area at the top of the dock widget </P
></LI
><LI
><P
>GNOME_DOCK_RIGHT - The vertical area on the right side of the dock widget </P
></LI
><LI
><P
>GNOME_DOCK_BOTTOM - The horizontal area at the bottom of the dock widget </P
></LI
><LI
><P
>GNOME_DOCK_RIGHT - The vertical area on the right side of the dock widget </P
></LI
><LI
><P
>GNOME_DOCK_FLOATING - Used for floating (detached) items</P
></LI
></UL
></P
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN15559"
></A
><H3
><A
NAME="GNOME-DOCK-NEW"
></A
>gnome_dock_new ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><GTKDOCLINK
HREF="GTKWIDGET"
>GtkWidget</GTKDOCLINK
>* gnome_dock_new (void);</PRE
></TD
></TR
></TABLE
><P
>Creates a new <A
HREF="gnomedock.html"
>GnomeDock</A
> widget.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN15567"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Returns</I
></SPAN
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> The new widget.</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN15576"
></A
><H3
><A
NAME="GNOME-DOCK-ALLOW-FLOATING-ITEMS"
></A
>gnome_dock_allow_floating_items ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_dock_allow_floating_items (<A
HREF="gnomedock.html"
>GnomeDock</A
> *dock,
<GTKDOCLINK
HREF="GBOOLEAN"
>gboolean</GTKDOCLINK
> enable);</PRE
></TD
></TR
></TABLE
><P
>Enable or disable floating items on <TT
CLASS="PARAMETER"
><I
>dock</I
></TT
>, according
to <TT
CLASS="PARAMETER"
><I
>enable</I
></TT
>.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN15586"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>dock</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> A pointer to a <A
HREF="gnomedock.html"
>GnomeDock</A
> widget</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>enable</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Specifies whether floating items are allowed in this dock</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN15600"
></A
><H3
><A
NAME="GNOME-DOCK-ADD-ITEM"
></A
>gnome_dock_add_item ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_dock_add_item (<A
HREF="gnomedock.html"
>GnomeDock</A
> *dock,
<A
HREF="gnomedockitem.html"
>GnomeDockItem</A
> *item,
<A
HREF="gnomedock.html#GNOMEDOCKPLACEMENT"
>GnomeDockPlacement</A
> placement,
<GTKDOCLINK
HREF="GUINT"
>guint</GTKDOCLINK
> band_num,
<GTKDOCLINK
HREF="GINT"
>gint</GTKDOCLINK
> position,
<GTKDOCLINK
HREF="GUINT"
>guint</GTKDOCLINK
> offset,
<GTKDOCLINK
HREF="GBOOLEAN"
>gboolean</GTKDOCLINK
> in_new_band);</PRE
></TD
></TR
></TABLE
><P
>Add <TT
CLASS="PARAMETER"
><I
>item</I
></TT
> to <TT
CLASS="PARAMETER"
><I
>dock</I
></TT
>. <TT
CLASS="PARAMETER"
><I
>placement</I
></TT
> can be either
<TT
CLASS="LITERAL"
>GNOME_DOCK_TOP</TT
>, <TT
CLASS="LITERAL"
>GNOME_DOCK_RIGHT</TT
>, <TT
CLASS="LITERAL"
>GNOME_DOCK_BOTTOM</TT
> or
<TT
CLASS="LITERAL"
>GNOME_DOCK_LEFT</TT
>, and specifies what area of the dock should
contain the item. If <TT
CLASS="PARAMETER"
><I
>in_new_band</I
></TT
> is <TT
CLASS="LITERAL"
>TRUE</TT
>, a new dock band is
created at the position specified by <TT
CLASS="PARAMETER"
><I
>band_num</I
></TT
>; otherwise, the item
is added to the <TT
CLASS="PARAMETER"
><I
>band_num</I
></TT
>'th band.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN15624"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>dock</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> A pointer to a <A
HREF="gnomedock.html"
>GnomeDock</A
> widget</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>item</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> The item to add</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>placement</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Placement for the new item</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>band_num</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Number of the band the new item must be added to</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>position</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Position of the item in the specified band</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>offset</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Offset (in pixels) from the previous item in the same band</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>in_new_band</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Specifies whether a new band must be created for this item</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN15658"
></A
><H3
><A
NAME="GNOME-DOCK-ADD-FLOATING-ITEM"
></A
>gnome_dock_add_floating_item ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_dock_add_floating_item (<A
HREF="gnomedock.html"
>GnomeDock</A
> *dock,
<A
HREF="gnomedockitem.html"
>GnomeDockItem</A
> *widget,
<GTKDOCLINK
HREF="GINT"
>gint</GTKDOCLINK
> x,
<GTKDOCLINK
HREF="GINT"
>gint</GTKDOCLINK
> y,
<GTKDOCLINK
HREF="GTKORIENTATION"
>GtkOrientation</GTKDOCLINK
> orientation);</PRE
></TD
></TR
></TABLE
><P
>Add <TT
CLASS="PARAMETER"
><I
>item</I
></TT
> to <TT
CLASS="PARAMETER"
><I
>dock</I
></TT
> and make it floating at the
specified (<TT
CLASS="PARAMETER"
><I
>x</I
></TT
>, <TT
CLASS="PARAMETER"
><I
>y</I
></TT
>) coordinates (relative to the root window of the
screen).</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN15673"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>dock</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> A <A
HREF="gnomedock.html"
>GnomeDock</A
> widget</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>widget</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> </TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>x</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> X-coordinate for the floating item</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>y</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Y-coordinate for the floating item</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>orientation</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Orientation for the new item.</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN15699"
></A
><H3
><A
NAME="GNOME-DOCK-SET-CLIENT-AREA"
></A
>gnome_dock_set_client_area ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_dock_set_client_area (<A
HREF="gnomedock.html"
>GnomeDock</A
> *dock,
<GTKDOCLINK
HREF="GTKWIDGET"
>GtkWidget</GTKDOCLINK
> *widget);</PRE
></TD
></TR
></TABLE
><P
>Specify a widget for the dock's client area.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN15707"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>dock</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> A <A
HREF="gnomedock.html"
>GnomeDock</A
> widget</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>widget</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> The widget to be used for the client area.</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN15721"
></A
><H3
><A
NAME="GNOME-DOCK-GET-CLIENT-AREA"
></A
>gnome_dock_get_client_area ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><GTKDOCLINK
HREF="GTKWIDGET"
>GtkWidget</GTKDOCLINK
>* gnome_dock_get_client_area (<A
HREF="gnomedock.html"
>GnomeDock</A
> *dock);</PRE
></TD
></TR
></TABLE
><P
>Retrieve the widget being used as the client area in
<TT
CLASS="PARAMETER"
><I
>dock</I
></TT
>.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN15730"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>dock</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> A <A
HREF="gnomedock.html"
>GnomeDock</A
> widget.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Returns</I
></SPAN
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> The client area widget.</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN15744"
></A
><H3
><A
NAME="GNOME-DOCK-GET-ITEM-BY-NAME"
></A
>gnome_dock_get_item_by_name ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><A
HREF="gnomedockitem.html"
>GnomeDockItem</A
>* gnome_dock_get_item_by_name (<A
HREF="gnomedock.html"
>GnomeDock</A
> *dock,
const <GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *name,
<A
HREF="gnomedock.html#GNOMEDOCKPLACEMENT"
>GnomeDockPlacement</A
> *placement_return,
<GTKDOCLINK
HREF="GUINT"
>guint</GTKDOCLINK
> *num_band_return,
<GTKDOCLINK
HREF="GUINT"
>guint</GTKDOCLINK
> *band_position_return,
<GTKDOCLINK
HREF="GUINT"
>guint</GTKDOCLINK
> *offset_return);</PRE
></TD
></TR
></TABLE
><P
>Retrieve the dock item named <TT
CLASS="PARAMETER"
><I
>name</I
></TT
>; information about
its position in the dock is returned via <TT
CLASS="PARAMETER"
><I
>placement_return</I
></TT
>,
<TT
CLASS="PARAMETER"
><I
>num_band_return</I
></TT
>, <TT
CLASS="PARAMETER"
><I
>band_position_return</I
></TT
> and <TT
CLASS="PARAMETER"
><I
>offset_return</I
></TT
>. If
the placement is <TT
CLASS="LITERAL"
>GNOME_DOCK_FLOATING</TT
> *<TT
CLASS="PARAMETER"
><I
>num_band_return</I
></TT
>,
*<TT
CLASS="PARAMETER"
><I
>band_position_return</I
></TT
> and *<TT
CLASS="PARAMETER"
><I
>offset_return</I
></TT
> are not set.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN15766"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>dock</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> A <A
HREF="gnomedock.html"
>GnomeDock</A
> widget.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>name</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> The name of the dock item to retrieve</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>placement_return</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> A pointer to a variable holding the item's placement</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>num_band_return</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> A pointer to a variable holding the band number</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>band_position_return</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> A pointer to a variable holding the position
of the item within the band</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>offset_return</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> A pointer to a variable holding the offset of the item
from the previous item in the same band</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Returns</I
></SPAN
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> The named <A
HREF="gnomedockitem.html"
>GnomeDockItem</A
> widget, or <TT
CLASS="LITERAL"
>NULL</TT
> if no item with
such name exists.</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN15802"
></A
><H3
><A
NAME="GNOME-DOCK-GET-LAYOUT"
></A
>gnome_dock_get_layout ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><A
HREF="gnomedocklayout.html"
>GnomeDockLayout</A
>* gnome_dock_get_layout (<A
HREF="gnomedock.html"
>GnomeDock</A
> *dock);</PRE
></TD
></TR
></TABLE
><P
>Retrieve the layout of <TT
CLASS="PARAMETER"
><I
>dock</I
></TT
>.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN15811"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>dock</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> A <A
HREF="gnomedock.html"
>GnomeDock</A
> widget</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Returns</I
></SPAN
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> <TT
CLASS="PARAMETER"
><I
>dock</I
></TT
>'s layout as a <A
HREF="gnomedocklayout.html"
>GnomeDockLayout</A
> object.</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN15827"
></A
><H3
><A
NAME="GNOME-DOCK-ADD-FROM-LAYOUT"
></A
>gnome_dock_add_from_layout ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><GTKDOCLINK
HREF="GBOOLEAN"
>gboolean</GTKDOCLINK
> gnome_dock_add_from_layout (<A
HREF="gnomedock.html"
>GnomeDock</A
> *dock,
<A
HREF="gnomedocklayout.html"
>GnomeDockLayout</A
> *layout);</PRE
></TD
></TR
></TABLE
><P
>Add all the items in <TT
CLASS="PARAMETER"
><I
>layout</I
></TT
> to the specified <TT
CLASS="PARAMETER"
><I
>dock</I
></TT
>.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN15838"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>dock</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> The <A
HREF="gnomedock.html"
>GnomeDock</A
> widget</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>layout</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> A <A
HREF="gnomedocklayout.html"
>GnomeDockLayout</A
> widget</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Returns</I
></SPAN
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> <TT
CLASS="LITERAL"
>TRUE</TT
> if the operation succeeds, <TT
CLASS="LITERAL"
>FALSE</TT
> if it fails.</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN15859"
></A
><H2
>See Also</H2
><P
><A
HREF="gnomedockitem.html"
>GnomeDockItem</A
>
<A
HREF="gnomedockband.html"
>GnomeDockBand</A
>
<A
HREF="gnomedocklayout.html"
>GnomeDockLayout</A
></P
></DIV
><DIV
CLASS="NAVFOOTER"
><BR
CLEAR="all"><BR><TABLE
WIDTH="100%"
BORDER="0"
BGCOLOR="#000000"
CELLPADDING="1"
CELLSPACING="0"
><TR
><TD
WIDTH="25%"
BGCOLOR="#C00000"
ALIGN="left"
><A
HREF="gnomedockitem.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
><<< Previous Page</B
></FONT
></A
></TD
><TD
WIDTH="25%"
BGCOLOR="#0000C0"
ALIGN="center"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
><A
HREF="book1.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>Home</B
></FONT
></A
></B
></FONT
></TD
><TD
WIDTH="25%"
BGCOLOR="#00C000"
ALIGN="center"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
><A
HREF="gnome-objects.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>Up</B
></FONT
></A
></B
></FONT
></TD
><TD
WIDTH="25%"
BGCOLOR="#C00000"
ALIGN="right"
><A
HREF="gnomedruid.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>Next Page >>></B
></FONT
></A
></TD
></TR
><TR
><TD
COLSPAN="2"
ALIGN="left"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>GnomeDockItem</B
></FONT
></TD
><TD
COLSPAN="2"
ALIGN="right"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>GnomeDruid</B
></FONT
></TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
1bbf51ece72e40a5f40ad48678e7c5a5
>
files
>
446
