<refentry id="GnomeDruidPage" revision="6 May 2000">
<refmeta>
<refentrytitle>GnomeDruidPage</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GNOMEUI Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GnomeDruidPage</refname><refpurpose>A virtual widget defining the druid page.</refpurpose>
</refnamediv>

<refsynopsisdiv><title>Synopsis</title>
<synopsis>

#include &lt;gnome.h&gt;


<link linkend="gboolean">gboolean</link>    <link linkend="gnome-druid-page-next">gnome_druid_page_next</link>           (<link linkend="GnomeDruidPage">GnomeDruidPage</link> *druid_page);
void        <link linkend="gnome-druid-page-prepare">gnome_druid_page_prepare</link>        (<link linkend="GnomeDruidPage">GnomeDruidPage</link> *druid_page);
<link linkend="gboolean">gboolean</link>    <link linkend="gnome-druid-page-back">gnome_druid_page_back</link>           (<link linkend="GnomeDruidPage">GnomeDruidPage</link> *druid_page);
<link linkend="gboolean">gboolean</link>    <link linkend="gnome-druid-page-cancel">gnome_druid_page_cancel</link>         (<link linkend="GnomeDruidPage">GnomeDruidPage</link> *druid_page);
void        <link linkend="gnome-druid-page-finish">gnome_druid_page_finish</link>         (<link linkend="GnomeDruidPage">GnomeDruidPage</link> *druid_page);

</synopsis>
</refsynopsisdiv>

<refsect1>
<title>Object Hierarchy</title>
<synopsis>

  <link linkend="GtkObject">GtkObject</link>
   +----<link linkend="GtkWidget">GtkWidget</link>
         +----<link linkend="GtkContainer">GtkContainer</link>
               +----<link linkend="GtkBin">GtkBin</link>
                     +----GnomeDruidPage
</synopsis>

</refsect1>




<refsect1>
<title>Description</title>
<para>
This widget is a virtual widget to define the interface to a druid
page.  It's descendants are placed in <link linkend="GnomeDruid">GnomeDruid</link>, and comprise of the
actual material in the widget.
</para>
</refsect1>

<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="gnome-druid-page-next">gnome_druid_page_next ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gnome_druid_page_next           (<link linkend="GnomeDruidPage">GnomeDruidPage</link> *druid_page);</programlisting>
<para>
This will emit the "next" signal for that particular page.  It
is called by gnome-druid exclusively.  It is expected that non-linear Druid's
will override this signal and return TRUE if it handles changing pages.</para>
<para>

</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>druid_page</parameter>&nbsp;:</entry>
<entry> A DruidPage widget.
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> This function will return FALSE by default.
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gnome-druid-page-prepare">gnome_druid_page_prepare ()</title>
<programlisting>void        gnome_druid_page_prepare        (<link linkend="GnomeDruidPage">GnomeDruidPage</link> *druid_page);</programlisting>
<para>
This emits the "prepare" signal for the page.  It is called by
gnome-druid exclusively.</para>
<para>

</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>druid_page</parameter>&nbsp;:</entry>
<entry> A DruidPage widget.
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gnome-druid-page-back">gnome_druid_page_back ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gnome_druid_page_back           (<link linkend="GnomeDruidPage">GnomeDruidPage</link> *druid_page);</programlisting>
<para>
This will emit the "back" signal for that particular page.  It
is called by gnome-druid exclusively.  It is expected that non-linear Druid's
will override this signal and return TRUE if it handles changing pages.</para>
<para>

</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>druid_page</parameter>&nbsp;:</entry>
<entry> A DruidPage widget.
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> This function will return FALSE by default.
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gnome-druid-page-cancel">gnome_druid_page_cancel ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gnome_druid_page_cancel         (<link linkend="GnomeDruidPage">GnomeDruidPage</link> *druid_page);</programlisting>
<para>
This will emit the "cancel" signal for that particular page.  It
is called by gnome-druid exclusively.  It is expected that a Druid will
override this signal and return TRUE if it does not want to exit.</para>
<para>

</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>druid_page</parameter>&nbsp;:</entry>
<entry> A DruidPage widget.
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> This function will return FALSE by default.
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gnome-druid-page-finish">gnome_druid_page_finish ()</title>
<programlisting>void        gnome_druid_page_finish         (<link linkend="GnomeDruidPage">GnomeDruidPage</link> *druid_page);</programlisting>
<para>
This emits the "finish" signal for the page.  It is called by
gnome-druid exclusively.</para>
<para>

</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>druid_page</parameter>&nbsp;:</entry>
<entry> A DruidPage widget.
</entry></row>
</tbody></tgroup></informaltable></refsect2>

</refsect1>



<refsect1>
<title>See Also</title>
<para>
<link linkend="GnomeDruid">GnomeDruid</link>, <link linkend="GnomeDruidPageStart">GnomeDruidPageStart</link>, <link linkend="GnomeDruidPageStandard">GnomeDruidPageStandard</link>, <link linkend="GnomeDruidPageFinish">GnomeDruidPageFinish</link>
</para>
</refsect1>

</refentry>
