|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /proc/22697/root/usr/share/gtk-doc/html/libgnomeui/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GnomeDruidPage</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="GNOME UI Library Reference Manual">
<link rel="up" href="druids.html" title="Druids">
<link rel="prev" href="GnomeDruid.html" title="GnomeDruid">
<link rel="next" href="GnomeDruidPageEdge.html" title="GnomeDruidPageEdge">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="GNOME UI Library (libgnomeui)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GnomeDruid.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="druids.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GNOME UI Library Reference Manual</th>
<td><a accesskey="n" href="GnomeDruidPageEdge.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2982074" class="shortcut">Top</a>
 | 
<a href="#id2982546" class="shortcut">Description</a>
 | 
<a href="#id2982227" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id2982307" class="shortcut">Implemented Interfaces</a>
 | 
<a href="#id2982330" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GnomeDruidPage"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2982074"></a><span class="refentrytitle">GnomeDruidPage</span>
</h2>
<p>GnomeDruidPage — A widget representing a single page inside a druid.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
#include <libgnomeui/libgnomeui.h>
<a href="GnomeDruidPage.html#GnomeDruidPage-struct">GnomeDruidPage</a>;
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>* <a href="GnomeDruidPage.html#gnome-druid-page-new">gnome_druid_page_new</a> (void);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="GnomeDruidPage.html#gnome-druid-page-next">gnome_druid_page_next</a> (<a href="GnomeDruidPage.html" title="GnomeDruidPage">GnomeDruidPage</a> *druid_page);
void <a href="GnomeDruidPage.html#gnome-druid-page-prepare">gnome_druid_page_prepare</a> (<a href="GnomeDruidPage.html" title="GnomeDruidPage">GnomeDruidPage</a> *druid_page);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="GnomeDruidPage.html#gnome-druid-page-back">gnome_druid_page_back</a> (<a href="GnomeDruidPage.html" title="GnomeDruidPage">GnomeDruidPage</a> *druid_page);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="GnomeDruidPage.html#gnome-druid-page-cancel">gnome_druid_page_cancel</a> (<a href="GnomeDruidPage.html" title="GnomeDruidPage">GnomeDruidPage</a> *druid_page);
void <a href="GnomeDruidPage.html#gnome-druid-page-finish">gnome_druid_page_finish</a> (<a href="GnomeDruidPage.html" title="GnomeDruidPage">GnomeDruidPage</a> *druid_page);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2982227"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
>GInitiallyUnowned</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkObject.html"
>GtkObject</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkContainer.html"
>GtkContainer</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkBin.html"
>GtkBin</a>
+----GnomeDruidPage
+----<a href="GnomeDruidPageEdge.html" title="GnomeDruidPageEdge">GnomeDruidPageEdge</a>
+----<a href="GnomeDruidPageStandard.html" title="GnomeDruidPageStandard">GnomeDruidPageStandard</a>
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2982307"></a><h2>Implemented Interfaces</h2>
<p>
GnomeDruidPage implements
AtkImplementorIface.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2982330"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="GnomeDruidPage.html#GnomeDruidPage-back">back</a>" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> user_function (<a href="GnomeDruidPage.html" title="GnomeDruidPage">GnomeDruidPage</a> *druidpage,
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a> *widget,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last
"<a href="GnomeDruidPage.html#GnomeDruidPage-cancel">cancel</a>" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> user_function (<a href="GnomeDruidPage.html" title="GnomeDruidPage">GnomeDruidPage</a> *druidpage,
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a> *widget,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last
"<a href="GnomeDruidPage.html#GnomeDruidPage-finish">finish</a>" void user_function (<a href="GnomeDruidPage.html" title="GnomeDruidPage">GnomeDruidPage</a> *druidpage,
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a> *widget,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last
"<a href="GnomeDruidPage.html#GnomeDruidPage-next">next</a>" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> user_function (<a href="GnomeDruidPage.html" title="GnomeDruidPage">GnomeDruidPage</a> *druidpage,
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a> *widget,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last
"<a href="GnomeDruidPage.html#GnomeDruidPage-prepare">prepare</a>" void user_function (<a href="GnomeDruidPage.html" title="GnomeDruidPage">GnomeDruidPage</a> *druidpage,
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a> *widget,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2982546"></a><h2>Description</h2>
<p>
The functions in this page are mostly only for the information of developers --
they should never needt o call them directly. Typically, a druid will connect
to the various signals described here as a way of controlling the behaviour of
druids that do not just proceed in a front-to-back fashion (for example, where
the subsequent pages depend upon the choice made at some point).
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2982567"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2982577"></a><h3>
<a name="GnomeDruidPage-struct"></a>GnomeDruidPage</h3>
<a class="indexterm" name="id2982590"></a><pre class="programlisting">typedef struct _GnomeDruidPage GnomeDruidPage;</pre>
<p>
The widget for a aprticular page in a druid.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2982606"></a><h3>
<a name="gnome-druid-page-new"></a>gnome_druid_page_new ()</h3>
<a class="indexterm" name="id2982619"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>* gnome_druid_page_new (void);</pre>
<p>
Creates a new <a href="GnomeDruidPage.html" title="GnomeDruidPage"><span class="type">GnomeDruidPage</span></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The newly created <a href="GnomeDruidPage.html" title="GnomeDruidPage"><span class="type">GnomeDruidPage</span></a>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2982675"></a><h3>
<a name="gnome-druid-page-next"></a>gnome_druid_page_next ()</h3>
<a class="indexterm" name="id2982688"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gnome_druid_page_next (<a href="GnomeDruidPage.html" title="GnomeDruidPage">GnomeDruidPage</a> *druid_page);</pre>
<p>
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.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>druid_page</code></em> :</span></td>
<td> A DruidPage widget.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> This function will return FALSE by default.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2982753"></a><h3>
<a name="gnome-druid-page-prepare"></a>gnome_druid_page_prepare ()</h3>
<a class="indexterm" name="id2982766"></a><pre class="programlisting">void gnome_druid_page_prepare (<a href="GnomeDruidPage.html" title="GnomeDruidPage">GnomeDruidPage</a> *druid_page);</pre>
<p>
This emits the "prepare" signal for the page. It is called by
gnome-druid exclusively. This function is called immediately prior to a druid
page being shown so that it can "prepare" for display.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>druid_page</code></em> :</span></td>
<td> A DruidPage widget.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2982819"></a><h3>
<a name="gnome-druid-page-back"></a>gnome_druid_page_back ()</h3>
<a class="indexterm" name="id2982833"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gnome_druid_page_back (<a href="GnomeDruidPage.html" title="GnomeDruidPage">GnomeDruidPage</a> *druid_page);</pre>
<p>
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.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>druid_page</code></em> :</span></td>
<td> A DruidPage widget.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> This function will return FALSE by default.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2982898"></a><h3>
<a name="gnome-druid-page-cancel"></a>gnome_druid_page_cancel ()</h3>
<a class="indexterm" name="id2982911"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gnome_druid_page_cancel (<a href="GnomeDruidPage.html" title="GnomeDruidPage">GnomeDruidPage</a> *druid_page);</pre>
<p>
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.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>druid_page</code></em> :</span></td>
<td> A DruidPage widget.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> This function will return FALSE by default.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2982976"></a><h3>
<a name="gnome-druid-page-finish"></a>gnome_druid_page_finish ()</h3>
<a class="indexterm" name="id2982989"></a><pre class="programlisting">void gnome_druid_page_finish (<a href="GnomeDruidPage.html" title="GnomeDruidPage">GnomeDruidPage</a> *druid_page);</pre>
<p>
This emits the "finish" signal for the page. It is called by
gnome-druid exclusively.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>druid_page</code></em> :</span></td>
<td> A DruidPage widget.
</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2983042"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2983053"></a><h3>
<a name="GnomeDruidPage-back"></a>The "back" signal</h3>
<a class="indexterm" name="id2983062"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> user_function (<a href="GnomeDruidPage.html" title="GnomeDruidPage">GnomeDruidPage</a> *druidpage,
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a> *widget,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>druidpage</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>widget</code></em> :</span></td>
<td>The <a href="GnomeDruid.html" title="GnomeDruid"><span class="type">GnomeDruid</span></a> containg this page.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
<a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if the signal handler has changed the page (since this stops
all further emission of the signal), <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2983192"></a><h3>
<a name="GnomeDruidPage-cancel"></a>The "cancel" signal</h3>
<a class="indexterm" name="id2983202"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> user_function (<a href="GnomeDruidPage.html" title="GnomeDruidPage">GnomeDruidPage</a> *druidpage,
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a> *widget,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>druidpage</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>widget</code></em> :</span></td>
<td>The <a href="GnomeDruid.html" title="GnomeDruid"><span class="type">GnomeDruid</span></a> containg this page.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
<a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if the druid does not want to exit yet, <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> if the exit
should continue.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2983331"></a><h3>
<a name="GnomeDruidPage-finish"></a>The "finish" signal</h3>
<a class="indexterm" name="id2983341"></a><pre class="programlisting">void user_function (<a href="GnomeDruidPage.html" title="GnomeDruidPage">GnomeDruidPage</a> *druidpage,
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a> *widget,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>druidpage</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>widget</code></em> :</span></td>
<td>The <a href="GnomeDruid.html" title="GnomeDruid"><span class="type">GnomeDruid</span></a> containg this page.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2983439"></a><h3>
<a name="GnomeDruidPage-next"></a>The "next" signal</h3>
<a class="indexterm" name="id2983450"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> user_function (<a href="GnomeDruidPage.html" title="GnomeDruidPage">GnomeDruidPage</a> *druidpage,
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a> *widget,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>druidpage</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>widget</code></em> :</span></td>
<td>The <a href="GnomeDruid.html" title="GnomeDruid"><span class="type">GnomeDruid</span></a> containg this page.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
<a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if the signal handler has changed the page (since this stops
all further emission of the signal), <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2983579"></a><h3>
<a name="GnomeDruidPage-prepare"></a>The "prepare" signal</h3>
<a class="indexterm" name="id2983590"></a><pre class="programlisting">void user_function (<a href="GnomeDruidPage.html" title="GnomeDruidPage">GnomeDruidPage</a> *druidpage,
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a> *widget,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>druidpage</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>widget</code></em> :</span></td>
<td>The <a href="GnomeDruid.html" title="GnomeDruid"><span class="type">GnomeDruid</span></a> containg this page.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>