← Back to branch summary

~ubuntu-branches/ubuntu/dapper/libgnomeui/dapper-updates

« back to all changes in this revision

Viewing changes to doc/reference/xml/gnome-druid-page.xml

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2006-04-11 17:46:10 UTC
  • mfrom: (1.1.7 upstream)
  • Revision ID: james.westby@ubuntu.com-20060411174610-yb9v0rvx60x0mdli
Tags: 2.14.1-0ubuntu1
* New upstream release:
  - Fix --disable-crash-dialog 
  - Fix leaks 
  - Fix gettext initialization 
* Resynchronized with Debian, only Ubuntu changes are:
  - debian/libgnomeui-0.shlibs: bumped for added interfaces.
  - debian/rules: added stuff for cleaning.
  - debian/patches/30_crash-dialog.patch: dropped, fixed upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/xml/gnome-druid-page.xml
1
1
<refentry id="GnomeDruidPage">
2
2
<refmeta>
3
 
<refentrytitle id="top_of_page">GnomeDruidPage</refentrytitle>
 
3
<refentrytitle>GnomeDruidPage</refentrytitle>
4
4
<manvolnum>3</manvolnum>
5
5
<refmiscinfo>LIBGNOMEUI Library</refmiscinfo>
6
6
</refmeta>
7
7
 
8
8
<refnamediv>
9
 
<refname>GnomeDruidPage</refname>
10
 
<refpurpose>A widget representing a single page inside a druid.</refpurpose>
11
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
 
9
<refname>GnomeDruidPage</refname><refpurpose>A widget representing a single page inside a druid.</refpurpose>
12
10
</refnamediv>
13
11
 
14
 
<refsynopsisdiv id="synopsis">
15
 
<title id="synopsis.title">Synopsis</title>
 
12
<refsynopsisdiv><title>Synopsis</title>
16
13
 
17
14
<synopsis>
18
15
 
31
28
</synopsis>
32
29
</refsynopsisdiv>
33
30
 
34
 
<refsect1 id="object_hierarchy">
35
 
<title id="object_hierarchy.title">Object Hierarchy</title>
 
31
<refsect1>
 
32
<title>Object Hierarchy</title>
36
33
<synopsis>
37
34
 
38
35
  <link linkend="GObject">GObject</link>
50
47
 
51
48
 
52
49
 
53
 
<refsect1 id="impl_interfaces">
54
 
<title id="impl_interfaces.title">Implemented Interfaces</title>
 
50
<refsect1>
 
51
<title>Implemented Interfaces</title>
55
52
<para>
56
53
GnomeDruidPage implements
57
54
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
60
57
 
61
58
 
62
59
 
63
 
<refsect1 id="signal_proto">
64
 
<title id="signal_proto.title">Signals</title>
 
60
<refsect1>
 
61
<title>Signal Prototypes</title>
65
62
<synopsis>
66
63
 
67
64
&quot;<link linkend="GnomeDruidPage-back">back</link>&quot;      <link linkend="gboolean">gboolean</link>    user_function      (<link linkend="GnomeDruidPage">GnomeDruidPage</link> *druidpage,
68
 
                                            <link linkend="GtkWidget">GtkWidget</link>      *widget,
69
 
                                            <link linkend="gpointer">gpointer</link>        user_data)      : Run last
 
65
                                            <link linkend="GtkWidget">GtkWidget</link> *widget,
 
66
                                            <link linkend="gpointer">gpointer</link> user_data);
70
67
&quot;<link linkend="GnomeDruidPage-cancel">cancel</link>&quot;    <link linkend="gboolean">gboolean</link>    user_function      (<link linkend="GnomeDruidPage">GnomeDruidPage</link> *druidpage,
71
 
                                            <link linkend="GtkWidget">GtkWidget</link>      *widget,
72
 
                                            <link linkend="gpointer">gpointer</link>        user_data)      : Run last
 
68
                                            <link linkend="GtkWidget">GtkWidget</link> *widget,
 
69
                                            <link linkend="gpointer">gpointer</link> user_data);
73
70
&quot;<link linkend="GnomeDruidPage-finish">finish</link>&quot;    <link linkend="void">void</link>        user_function      (<link linkend="GnomeDruidPage">GnomeDruidPage</link> *druidpage,
74
 
                                            <link linkend="GtkWidget">GtkWidget</link>      *widget,
75
 
                                            <link linkend="gpointer">gpointer</link>        user_data)      : Run last
 
71
                                            <link linkend="GtkWidget">GtkWidget</link> *widget,
 
72
                                            <link linkend="gpointer">gpointer</link> user_data);
76
73
&quot;<link linkend="GnomeDruidPage-next">next</link>&quot;      <link linkend="gboolean">gboolean</link>    user_function      (<link linkend="GnomeDruidPage">GnomeDruidPage</link> *druidpage,
77
 
                                            <link linkend="GtkWidget">GtkWidget</link>      *widget,
78
 
                                            <link linkend="gpointer">gpointer</link>        user_data)      : Run last
 
74
                                            <link linkend="GtkWidget">GtkWidget</link> *widget,
 
75
                                            <link linkend="gpointer">gpointer</link> user_data);
79
76
&quot;<link linkend="GnomeDruidPage-prepare">prepare</link>&quot;   <link linkend="void">void</link>        user_function      (<link linkend="GnomeDruidPage">GnomeDruidPage</link> *druidpage,
80
 
                                            <link linkend="GtkWidget">GtkWidget</link>      *widget,
81
 
                                            <link linkend="gpointer">gpointer</link>        user_data)      : Run last
 
77
                                            <link linkend="GtkWidget">GtkWidget</link> *widget,
 
78
                                            <link linkend="gpointer">gpointer</link> user_data);
82
79
</synopsis>
83
80
</refsect1>
84
81
 
85
82
 
86
 
<refsect1 id="desc">
87
 
<title id="desc.title">Description</title>
 
83
<refsect1>
 
84
<title>Description</title>
88
85
<para>
89
86
The functions in this page are mostly only for the information of developers --
90
87
they should never needt o call them directly. Typically, a druid will connect
95
92
</para>
96
93
</refsect1>
97
94
 
98
 
<refsect1 id="details">
99
 
<title id="details.title">Details</title>
 
95
<refsect1>
 
96
<title>Details</title>
100
97
<refsect2>
101
 
<title><anchor id="GnomeDruidPage-struct" role="struct"/>GnomeDruidPage</title>
 
98
<title><anchor id="GnomeDruidPage-struct"/>GnomeDruidPage</title>
102
99
<indexterm><primary>GnomeDruidPage</primary></indexterm><programlisting>typedef struct _GnomeDruidPage GnomeDruidPage;</programlisting>
103
100
<para>
104
101
The widget for a aprticular page in a druid.
105
102
</para></refsect2>
106
103
<refsect2>
107
 
<title><anchor id="gnome-druid-page-new" role="function"/>gnome_druid_page_new ()</title>
 
104
<title><anchor id="gnome-druid-page-new"/>gnome_druid_page_new ()</title>
108
105
<indexterm><primary>gnome_druid_page_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*  gnome_druid_page_new            (void);</programlisting>
109
106
<para>
110
107
Creates a new <link linkend="GnomeDruidPage"><type>GnomeDruidPage</type></link>.</para>
115
112
</simpara></listitem></varlistentry>
116
113
</variablelist></refsect2>
117
114
<refsect2>
118
 
<title><anchor id="gnome-druid-page-next" role="function"/>gnome_druid_page_next ()</title>
 
115
<title><anchor id="gnome-druid-page-next"/>gnome_druid_page_next ()</title>
119
116
<indexterm><primary>gnome_druid_page_next</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gnome_druid_page_next           (<link linkend="GnomeDruidPage">GnomeDruidPage</link> *druid_page);</programlisting>
120
117
<para>
121
118
This will emit the "next" signal for that particular page.  It
131
128
</simpara></listitem></varlistentry>
132
129
</variablelist></refsect2>
133
130
<refsect2>
134
 
<title><anchor id="gnome-druid-page-prepare" role="function"/>gnome_druid_page_prepare ()</title>
 
131
<title><anchor id="gnome-druid-page-prepare"/>gnome_druid_page_prepare ()</title>
135
132
<indexterm><primary>gnome_druid_page_prepare</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_druid_page_prepare        (<link linkend="GnomeDruidPage">GnomeDruidPage</link> *druid_page);</programlisting>
136
133
<para>
137
134
This emits the "prepare" signal for the page.  It is called by
145
142
</simpara></listitem></varlistentry>
146
143
</variablelist></refsect2>
147
144
<refsect2>
148
 
<title><anchor id="gnome-druid-page-back" role="function"/>gnome_druid_page_back ()</title>
 
145
<title><anchor id="gnome-druid-page-back"/>gnome_druid_page_back ()</title>
149
146
<indexterm><primary>gnome_druid_page_back</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gnome_druid_page_back           (<link linkend="GnomeDruidPage">GnomeDruidPage</link> *druid_page);</programlisting>
150
147
<para>
151
148
This will emit the "back" signal for that particular page.  It
161
158
</simpara></listitem></varlistentry>
162
159
</variablelist></refsect2>
163
160
<refsect2>
164
 
<title><anchor id="gnome-druid-page-cancel" role="function"/>gnome_druid_page_cancel ()</title>
 
161
<title><anchor id="gnome-druid-page-cancel"/>gnome_druid_page_cancel ()</title>
165
162
<indexterm><primary>gnome_druid_page_cancel</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gnome_druid_page_cancel         (<link linkend="GnomeDruidPage">GnomeDruidPage</link> *druid_page);</programlisting>
166
163
<para>
167
164
This will emit the "cancel" signal for that particular page.  It
177
174
</simpara></listitem></varlistentry>
178
175
</variablelist></refsect2>
179
176
<refsect2>
180
 
<title><anchor id="gnome-druid-page-finish" role="function"/>gnome_druid_page_finish ()</title>
 
177
<title><anchor id="gnome-druid-page-finish"/>gnome_druid_page_finish ()</title>
181
178
<indexterm><primary>gnome_druid_page_finish</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_druid_page_finish         (<link linkend="GnomeDruidPage">GnomeDruidPage</link> *druid_page);</programlisting>
182
179
<para>
183
180
This emits the "finish" signal for the page.  It is called by
192
189
 
193
190
</refsect1>
194
191
 
195
 
<refsect1 id="signals">
196
 
<title id="signals.title">Signal Details</title>
 
192
<refsect1>
 
193
<title>Signals</title>
197
194
<refsect2><title><anchor id="GnomeDruidPage-back"/>The &quot;back&quot; signal</title>
198
195
<programlisting><link linkend="gboolean">gboolean</link>    user_function                  (<link linkend="GnomeDruidPage">GnomeDruidPage</link> *druidpage,
199
 
                                            <link linkend="GtkWidget">GtkWidget</link>      *widget,
200
 
                                            <link linkend="gpointer">gpointer</link>        user_data)      : Run last</programlisting>
 
196
                                            <link linkend="GtkWidget">GtkWidget</link> *widget,
 
197
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
201
198
<para>
202
199
 
203
200
</para><variablelist role="params">
215
212
</simpara></listitem></varlistentry>
216
213
</variablelist></refsect2><refsect2><title><anchor id="GnomeDruidPage-cancel"/>The &quot;cancel&quot; signal</title>
217
214
<programlisting><link linkend="gboolean">gboolean</link>    user_function                  (<link linkend="GnomeDruidPage">GnomeDruidPage</link> *druidpage,
218
 
                                            <link linkend="GtkWidget">GtkWidget</link>      *widget,
219
 
                                            <link linkend="gpointer">gpointer</link>        user_data)      : Run last</programlisting>
 
215
                                            <link linkend="GtkWidget">GtkWidget</link> *widget,
 
216
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
220
217
<para>
221
218
 
222
219
</para><variablelist role="params">
234
231
</simpara></listitem></varlistentry>
235
232
</variablelist></refsect2><refsect2><title><anchor id="GnomeDruidPage-finish"/>The &quot;finish&quot; signal</title>
236
233
<programlisting><link linkend="void">void</link>        user_function                  (<link linkend="GnomeDruidPage">GnomeDruidPage</link> *druidpage,
237
 
                                            <link linkend="GtkWidget">GtkWidget</link>      *widget,
238
 
                                            <link linkend="gpointer">gpointer</link>        user_data)      : Run last</programlisting>
 
234
                                            <link linkend="GtkWidget">GtkWidget</link> *widget,
 
235
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
239
236
<para>
240
237
 
241
238
</para><variablelist role="params">
250
247
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
251
248
</variablelist></refsect2><refsect2><title><anchor id="GnomeDruidPage-next"/>The &quot;next&quot; signal</title>
252
249
<programlisting><link linkend="gboolean">gboolean</link>    user_function                  (<link linkend="GnomeDruidPage">GnomeDruidPage</link> *druidpage,
253
 
                                            <link linkend="GtkWidget">GtkWidget</link>      *widget,
254
 
                                            <link linkend="gpointer">gpointer</link>        user_data)      : Run last</programlisting>
 
250
                                            <link linkend="GtkWidget">GtkWidget</link> *widget,
 
251
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
255
252
<para>
256
253
 
257
254
</para><variablelist role="params">
269
266
</simpara></listitem></varlistentry>
270
267
</variablelist></refsect2><refsect2><title><anchor id="GnomeDruidPage-prepare"/>The &quot;prepare&quot; signal</title>
271
268
<programlisting><link linkend="void">void</link>        user_function                  (<link linkend="GnomeDruidPage">GnomeDruidPage</link> *druidpage,
272
 
                                            <link linkend="GtkWidget">GtkWidget</link>      *widget,
273
 
                                            <link linkend="gpointer">gpointer</link>        user_data)      : Run last</programlisting>
 
269
                                            <link linkend="GtkWidget">GtkWidget</link> *widget,
 
270
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
274
271
<para>
275
272
 
276
273
</para><variablelist role="params">