<HTML
><HEAD
><TITLE
>GnomeDockLayout</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.44"><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="GnomeSpell"
HREF="gnomespell.html"><LINK
REL="NEXT"
TITLE="GnomeProcBar"
HREF="gnomeprocbar.html"></HEAD
><BODY
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="gnomespell.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>&#60;&#60;&#60; 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="gnomeprocbar.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>Next Page &#62;&#62;&#62;</B
></FONT
></A
></TD
></TR
></TABLE
></DIV
><H1
><A
NAME="GNOMEDOCKLAYOUT"
>GnomeDockLayout</A
></H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN25934"
></A
><H2
>Name</H2
>GnomeDockLayout&nbsp;--&nbsp;A widget for saving and retrieving the layout of a
<SPAN
CLASS="TYPE"
>GnomeDock</SPAN
> widget.</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN25938"
></A
><H2
>Synopsis</H2
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="SYNOPSIS"
>&#13;#include &lt;gnome.h&gt;


struct      <A
HREF="gnomedocklayout.html#GNOMEDOCKLAYOUT-STRUCT"
>GnomeDockLayout</A
>;
struct      <A
HREF="gnomedocklayout.html#GNOMEDOCKLAYOUTITEM"
>GnomeDockLayoutItem</A
>;
<A
HREF="gnomedocklayout.html"
>GnomeDockLayout</A
>* <A
HREF="gnomedocklayout.html#GNOME-DOCK-LAYOUT-NEW"
>gnome_dock_layout_new</A
>      (void);
<GTKDOCLINK
HREF="GBOOLEAN"
>gboolean</GTKDOCLINK
>    <A
HREF="gnomedocklayout.html#GNOME-DOCK-LAYOUT-ADD-ITEM"
>gnome_dock_layout_add_item</A
>      (<A
HREF="gnomedocklayout.html"
>GnomeDockLayout</A
> *layout,
                                             <A
HREF="gnomedockitem.html"
>GnomeDockItem</A
> *item,
                                             <A
HREF="gnomedock.html#GNOMEDOCKPLACEMENT"
>GnomeDockPlacement</A
> placement,
                                             <GTKDOCLINK
HREF="GINT"
>gint</GTKDOCLINK
> band_num,
                                             <GTKDOCLINK
HREF="GINT"
>gint</GTKDOCLINK
> band_position,
                                             <GTKDOCLINK
HREF="GINT"
>gint</GTKDOCLINK
> offset);
<GTKDOCLINK
HREF="GBOOLEAN"
>gboolean</GTKDOCLINK
>    <A
HREF="gnomedocklayout.html#GNOME-DOCK-LAYOUT-ADD-FLOATING-ITEM"
>gnome_dock_layout_add_floating_item</A
>
                                            (<A
HREF="gnomedocklayout.html"
>GnomeDockLayout</A
> *layout,
                                             <A
HREF="gnomedockitem.html"
>GnomeDockItem</A
> *item,
                                             <GTKDOCLINK
HREF="GINT"
>gint</GTKDOCLINK
> x,
                                             <GTKDOCLINK
HREF="GINT"
>gint</GTKDOCLINK
> y,
                                             <GTKDOCLINK
HREF="GTKORIENTATION"
>GtkOrientation</GTKDOCLINK
> orientation);
<A
HREF="gnomedocklayout.html#GNOMEDOCKLAYOUTITEM"
>GnomeDockLayoutItem</A
>* <A
HREF="gnomedocklayout.html#GNOME-DOCK-LAYOUT-GET-ITEM"
>gnome_dock_layout_get_item</A
>
                                            (<A
HREF="gnomedocklayout.html"
>GnomeDockLayout</A
> *layout,
                                             <A
HREF="gnomedockitem.html"
>GnomeDockItem</A
> *item);
<A
HREF="gnomedocklayout.html#GNOMEDOCKLAYOUTITEM"
>GnomeDockLayoutItem</A
>* <A
HREF="gnomedocklayout.html#GNOME-DOCK-LAYOUT-GET-ITEM-BY-NAME"
>gnome_dock_layout_get_item_by_name</A
>
                                            (<A
HREF="gnomedocklayout.html"
>GnomeDockLayout</A
> *layout,
                                             const <GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *name);
<GTKDOCLINK
HREF="GBOOLEAN"
>gboolean</GTKDOCLINK
>    <A
HREF="gnomedocklayout.html#GNOME-DOCK-LAYOUT-REMOVE-ITEM"
>gnome_dock_layout_remove_item</A
>   (<A
HREF="gnomedocklayout.html"
>GnomeDockLayout</A
> *layout,
                                             <A
HREF="gnomedockitem.html"
>GnomeDockItem</A
> *item);
<GTKDOCLINK
HREF="GBOOLEAN"
>gboolean</GTKDOCLINK
>    <A
HREF="gnomedocklayout.html#GNOME-DOCK-LAYOUT-REMOVE-ITEM-BY-NAME"
>gnome_dock_layout_remove_item_by_name</A
>
                                            (<A
HREF="gnomedocklayout.html"
>GnomeDockLayout</A
> *layout,
                                             const <GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *name);
<GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
>*      <A
HREF="gnomedocklayout.html#GNOME-DOCK-LAYOUT-CREATE-STRING"
>gnome_dock_layout_create_string</A
> (<A
HREF="gnomedocklayout.html"
>GnomeDockLayout</A
> *layout);
<GTKDOCLINK
HREF="GBOOLEAN"
>gboolean</GTKDOCLINK
>    <A
HREF="gnomedocklayout.html#GNOME-DOCK-LAYOUT-PARSE-STRING"
>gnome_dock_layout_parse_string</A
>  (<A
HREF="gnomedocklayout.html"
>GnomeDockLayout</A
> *layout,
                                             const <GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *string);
<GTKDOCLINK
HREF="GBOOLEAN"
>gboolean</GTKDOCLINK
>    <A
HREF="gnomedocklayout.html#GNOME-DOCK-LAYOUT-ADD-TO-DOCK"
>gnome_dock_layout_add_to_dock</A
>   (<A
HREF="gnomedocklayout.html"
>GnomeDockLayout</A
> *layout,
                                             <A
HREF="gnomedock.html"
>GnomeDock</A
> *dock);&#13;</PRE
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN25987"
></A
><H2
>Object Hierarchy</H2
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="SYNOPSIS"
>&#13;  <GTKDOCLINK
HREF="GTKOBJECT"
>GtkObject</GTKDOCLINK
>
   +----GnomeDockLayout</PRE
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN25991"
></A
><H2
>Description</H2
><P
>The <SPAN
CLASS="TYPE"
>GnomeDockLayout</SPAN
> widget is meant to make it simple for
programmers to handle the layout of a <SPAN
CLASS="TYPE"
>GnomeDock</SPAN
> widget.</P
><P
><SPAN
CLASS="TYPE"
>GnomeDockLayout</SPAN
> can contain an arbitrary number of
<SPAN
CLASS="TYPE"
>GnomeDockItem</SPAN
> widgets, each of them with its own
placement information.  It is possible to "extract" a layout from an
existing <SPAN
CLASS="TYPE"
>GnomeDock</SPAN
> widget, as well as adding the items
present in a <SPAN
CLASS="TYPE"
>GnomeDockLayout</SPAN
> to it.  Moreover,
<SPAN
CLASS="TYPE"
>GnomeDockLayout</SPAN
> is able to create a layout configuration
string that can be later used to re-construct the layout on a brand
new <SPAN
CLASS="TYPE"
>GnomeDockLayout</SPAN
> widget.</P
><P
>As a consequence, <SPAN
CLASS="TYPE"
>GnomeDockLayout</SPAN
> is very useful to save
and retrieve <SPAN
CLASS="TYPE"
>GnomeDock</SPAN
> configurations into files.  For
example, <SPAN
CLASS="TYPE"
>GnomeApp</SPAN
> uses <SPAN
CLASS="TYPE"
>GnomeDockLayout</SPAN
> to
create a default layout configuration, override it with the
user-specific configuration file, and finally apply it to it
<SPAN
CLASS="TYPE"
>GnomeDock</SPAN
>.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN26009"
></A
><H2
>Details</H2
><DIV
CLASS="REFSECT2"
><A
NAME="AEN26011"
></A
><H3
><A
NAME="GNOMEDOCKLAYOUT-STRUCT"
></A
>struct GnomeDockLayout</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>struct GnomeDockLayout;</PRE
></TD
></TR
></TABLE
><P
></P
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN26016"
></A
><H3
><A
NAME="GNOMEDOCKLAYOUTITEM"
></A
>struct GnomeDockLayoutItem</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>struct GnomeDockLayoutItem
{
  GnomeDockItem *item;

  GnomeDockPlacement placement;

  union
  {
    struct
    {
      gint x;
      gint y;
      GtkOrientation orientation;
    } floating;

    struct
    {
      gint band_num;
      gint band_position;
      gint offset;
    } docked;

  } position;
};</PRE
></TD
></TR
></TABLE
><P
></P
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN26021"
></A
><H3
><A
NAME="GNOME-DOCK-LAYOUT-NEW"
></A
>gnome_dock_layout_new ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><A
HREF="gnomedocklayout.html"
>GnomeDockLayout</A
>* gnome_dock_layout_new      (void);</PRE
></TD
></TR
></TABLE
><P
>Create a new <A
HREF="gnomedocklayout.html"
>GnomeDockLayout</A
> widget.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><I
CLASS="EMPHASIS"
>Returns</I
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> The new <A
HREF="gnomedocklayout.html"
>GnomeDockLayout</A
> widget.</TD
></TR
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN26039"
></A
><H3
><A
NAME="GNOME-DOCK-LAYOUT-ADD-ITEM"
></A
>gnome_dock_layout_add_item ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><GTKDOCLINK
HREF="GBOOLEAN"
>gboolean</GTKDOCLINK
>    gnome_dock_layout_add_item      (<A
HREF="gnomedocklayout.html"
>GnomeDockLayout</A
> *layout,
                                             <A
HREF="gnomedockitem.html"
>GnomeDockItem</A
> *item,
                                             <A
HREF="gnomedock.html#GNOMEDOCKPLACEMENT"
>GnomeDockPlacement</A
> placement,
                                             <GTKDOCLINK
HREF="GINT"
>gint</GTKDOCLINK
> band_num,
                                             <GTKDOCLINK
HREF="GINT"
>gint</GTKDOCLINK
> band_position,
                                             <GTKDOCLINK
HREF="GINT"
>gint</GTKDOCLINK
> offset);</PRE
></TD
></TR
></TABLE
><P
>Add <TT
CLASS="PARAMETER"
><I
>item</I
></TT
> to <TT
CLASS="PARAMETER"
><I
>layout</I
></TT
> with the specified parameters.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>layout</I
></TT
>&nbsp;:</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"
><TT
CLASS="PARAMETER"
><I
>item</I
></TT
>&nbsp;:</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> The dock item to be added to <TT
CLASS="PARAMETER"
><I
>layout</I
></TT
></TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>placement</I
></TT
>&nbsp;:</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Placement of <TT
CLASS="PARAMETER"
><I
>item</I
></TT
> in <TT
CLASS="PARAMETER"
><I
>layout</I
></TT
></TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>band_num</I
></TT
>&nbsp;:</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Band number</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>band_position</I
></TT
>&nbsp;:</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Position within the band</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>offset</I
></TT
>&nbsp;:</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Distance from the previous element in the band</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><I
CLASS="EMPHASIS"
>Returns</I
> :</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
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN26093"
></A
><H3
><A
NAME="GNOME-DOCK-LAYOUT-ADD-FLOATING-ITEM"
></A
>gnome_dock_layout_add_floating_item ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><GTKDOCLINK
HREF="GBOOLEAN"
>gboolean</GTKDOCLINK
>    gnome_dock_layout_add_floating_item
                                            (<A
HREF="gnomedocklayout.html"
>GnomeDockLayout</A
> *layout,
                                             <A
HREF="gnomedockitem.html"
>GnomeDockItem</A
> *item,
                                             <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
>layout</I
></TT
> as a floating item with the
specified (<TT
CLASS="PARAMETER"
><I
>x</I
></TT
>, <TT
CLASS="PARAMETER"
><I
>y</I
></TT
>) position and <TT
CLASS="PARAMETER"
><I
>orientation</I
></TT
>.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>layout</I
></TT
>&nbsp;:</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"
><TT
CLASS="PARAMETER"
><I
>item</I
></TT
>&nbsp;:</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> The dock item to be added to <TT
CLASS="PARAMETER"
><I
>layout</I
></TT
></TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>x</I
></TT
>&nbsp;:</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
>&nbsp;:</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
>&nbsp;:</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Orientation for the floating item</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><I
CLASS="EMPHASIS"
>Returns</I
> :</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
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN26143"
></A
><H3
><A
NAME="GNOME-DOCK-LAYOUT-GET-ITEM"
></A
>gnome_dock_layout_get_item ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><A
HREF="gnomedocklayout.html#GNOMEDOCKLAYOUTITEM"
>GnomeDockLayoutItem</A
>* gnome_dock_layout_get_item
                                            (<A
HREF="gnomedocklayout.html"
>GnomeDockLayout</A
> *layout,
                                             <A
HREF="gnomedockitem.html"
>GnomeDockItem</A
> *item);</PRE
></TD
></TR
></TABLE
><P
>Retrieve a layout item.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>layout</I
></TT
>&nbsp;:</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"
><TT
CLASS="PARAMETER"
><I
>item</I
></TT
>&nbsp;:</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> The <A
HREF="gnomedockitem.html"
>GnomeDockItem</A
> to be retrieved</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><I
CLASS="EMPHASIS"
>Returns</I
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> The retrieved <A
HREF="gnomedocklayout.html#GNOMEDOCKLAYOUTITEM"
>GnomeDockLayoutItem</A
> widget.</TD
></TR
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN26172"
></A
><H3
><A
NAME="GNOME-DOCK-LAYOUT-GET-ITEM-BY-NAME"
></A
>gnome_dock_layout_get_item_by_name ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><A
HREF="gnomedocklayout.html#GNOMEDOCKLAYOUTITEM"
>GnomeDockLayoutItem</A
>* gnome_dock_layout_get_item_by_name
                                            (<A
HREF="gnomedocklayout.html"
>GnomeDockLayout</A
> *layout,
                                             const <GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *name);</PRE
></TD
></TR
></TABLE
><P
>Retrieve the dock item named <TT
CLASS="PARAMETER"
><I
>name</I
></TT
>.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>layout</I
></TT
>&nbsp;:</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"
><TT
CLASS="PARAMETER"
><I
>name</I
></TT
>&nbsp;:</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Name of the item to be retrieved</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><I
CLASS="EMPHASIS"
>Returns</I
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> The named <A
HREF="gnomedocklayout.html#GNOMEDOCKLAYOUTITEM"
>GnomeDockLayoutItem</A
> widget.</TD
></TR
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN26201"
></A
><H3
><A
NAME="GNOME-DOCK-LAYOUT-REMOVE-ITEM"
></A
>gnome_dock_layout_remove_item ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><GTKDOCLINK
HREF="GBOOLEAN"
>gboolean</GTKDOCLINK
>    gnome_dock_layout_remove_item   (<A
HREF="gnomedocklayout.html"
>GnomeDockLayout</A
> *layout,
                                             <A
HREF="gnomedockitem.html"
>GnomeDockItem</A
> *item);</PRE
></TD
></TR
></TABLE
><P
>Remove the specified <TT
CLASS="PARAMETER"
><I
>item</I
></TT
> from <TT
CLASS="PARAMETER"
><I
>layout</I
></TT
>.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>layout</I
></TT
>&nbsp;:</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"
><TT
CLASS="PARAMETER"
><I
>item</I
></TT
>&nbsp;:</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> The <A
HREF="gnomedockitem.html"
>GnomeDockItem</A
> to be removed</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><I
CLASS="EMPHASIS"
>Returns</I
> :</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
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN26233"
></A
><H3
><A
NAME="GNOME-DOCK-LAYOUT-REMOVE-ITEM-BY-NAME"
></A
>gnome_dock_layout_remove_item_by_name ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><GTKDOCLINK
HREF="GBOOLEAN"
>gboolean</GTKDOCLINK
>    gnome_dock_layout_remove_item_by_name
                                            (<A
HREF="gnomedocklayout.html"
>GnomeDockLayout</A
> *layout,
                                             const <GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *name);</PRE
></TD
></TR
></TABLE
><P
>Remove the item named <TT
CLASS="PARAMETER"
><I
>name</I
></TT
> from <TT
CLASS="PARAMETER"
><I
>layout</I
></TT
>.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>layout</I
></TT
>&nbsp;:</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"
><TT
CLASS="PARAMETER"
><I
>name</I
></TT
>&nbsp;:</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Name of the <A
HREF="gnomedockitem.html"
>GnomeDockItem</A
> to be removed</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><I
CLASS="EMPHASIS"
>Returns</I
> :</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
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN26265"
></A
><H3
><A
NAME="GNOME-DOCK-LAYOUT-CREATE-STRING"
></A
>gnome_dock_layout_create_string ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
>*      gnome_dock_layout_create_string (<A
HREF="gnomedocklayout.html"
>GnomeDockLayout</A
> *layout);</PRE
></TD
></TR
></TABLE
><P
>Generate a string describing the layout in <TT
CLASS="PARAMETER"
><I
>layout</I
></TT
>.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>layout</I
></TT
>&nbsp;:</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"
><I
CLASS="EMPHASIS"
>Returns</I
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> The (malloced) layout string for <TT
CLASS="PARAMETER"
><I
>layout</I
></TT
>.</TD
></TR
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN26289"
></A
><H3
><A
NAME="GNOME-DOCK-LAYOUT-PARSE-STRING"
></A
>gnome_dock_layout_parse_string ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><GTKDOCLINK
HREF="GBOOLEAN"
>gboolean</GTKDOCLINK
>    gnome_dock_layout_parse_string  (<A
HREF="gnomedocklayout.html"
>GnomeDockLayout</A
> *layout,
                                             const <GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *string);</PRE
></TD
></TR
></TABLE
><P
>Parse the layout string <TT
CLASS="PARAMETER"
><I
>string</I
></TT
>, and move around the
items in <TT
CLASS="PARAMETER"
><I
>layout</I
></TT
> accordingly.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>layout</I
></TT
>&nbsp;:</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"
><TT
CLASS="PARAMETER"
><I
>string</I
></TT
>&nbsp;:</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> A layout string to be parsed</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><I
CLASS="EMPHASIS"
>Returns</I
> :</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
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN26320"
></A
><H3
><A
NAME="GNOME-DOCK-LAYOUT-ADD-TO-DOCK"
></A
>gnome_dock_layout_add_to_dock ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><GTKDOCLINK
HREF="GBOOLEAN"
>gboolean</GTKDOCLINK
>    gnome_dock_layout_add_to_dock   (<A
HREF="gnomedocklayout.html"
>GnomeDockLayout</A
> *layout,
                                             <A
HREF="gnomedock.html"
>GnomeDock</A
> *dock);</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"
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>layout</I
></TT
>&nbsp;:</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"
><TT
CLASS="PARAMETER"
><I
>dock</I
></TT
>&nbsp;:</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> The <A
HREF="gnomedock.html"
>GnomeDock</A
> widget the layout items must be added to</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><I
CLASS="EMPHASIS"
>Returns</I
> :</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
></TABLE
><P
></P
></DIV
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN26352"
></A
><H2
>See Also</H2
><P
><A
HREF="gnomedock.html"
>GnomeDock</A
>
<A
HREF="gnomedockitem.html"
>GnomeDockItem</A
>
<A
HREF="gnomedockband.html"
>GnomeDockBand</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="gnomespell.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>&#60;&#60;&#60; 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="gnomeprocbar.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>Next Page &#62;&#62;&#62;</B
></FONT
></A
></TD
></TR
><TR
><TD
COLSPAN="2"
ALIGN="left"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>GnomeSpell</B
></FONT
></TD
><TD
COLSPAN="2"
ALIGN="right"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>GnomeProcBar</B
></FONT
></TD
></TR
></TABLE
></DIV
></BODY
></HTML
>