← Back to branch summary

~ubuntu-branches/ubuntu/saucy/gtk-doc/saucy

« back to all changes in this revision

Viewing changes to tests/gobject/docs-tmpl/html/GtkdocIface.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastian Dröge
  • Date: 2009-02-17 17:11:41 UTC
  • mto: (1.2.8 upstream) (4.1.2 squeeze)
  • mto: This revision was merged to the branch mainline in revision 11.
  • Revision ID: james.westby@ubuntu.com-20090217171141-nobu8ey8kqtq5alx
Import upstream version 1.11

Show diffs side-by-side

added added

removed removed

Lines of Context:
tests/gobject/docs-tmpl/html/GtkdocIface.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>GtkdocIface</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
 
7
<link rel="start" href="index.html" title="tester Reference Manual">
 
8
<link rel="up" href="main-api.html" title="Tests">
 
9
<link rel="prev" href="GtkdocObject.html" title="GtkdocObject">
 
10
<link rel="next" href="object-tree.html" title="Object Hierarchy">
 
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
<link rel="chapter" href="intro.html" title="Introduction">
 
14
<link rel="chapter" href="main-api.html" title="Tests">
 
15
<link rel="chapter" href="object-tree.html" title="Object Hierarchy">
 
16
<link rel="index" href="api-index.html" title="API Index">
 
17
<link rel="index" href="deprecated-api-index.html" title="Index of deprecated API">
 
18
<link rel="index" href="api-index-0-1.html" title="Index of new API in 0.1">
 
19
<link rel="index" href="api-index-0-5.html" title="Index of new API in 0.5">
 
20
<link rel="glossary" href="go01.html" title="Glossary">
 
21
</head>
 
22
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
23
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
24
<tr valign="middle">
 
25
<td><a accesskey="p" href="GtkdocObject.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
26
<td><a accesskey="u" href="main-api.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
27
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
28
<th width="100%" align="center">tester Reference Manual</th>
 
29
<td><a accesskey="n" href="object-tree.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
30
</tr>
 
31
<tr><td colspan="5" class="shortcuts">
 
32
<a href="#GtkdocIface.synopsis" class="shortcut">Top</a>
 
33
                 | 
 
34
                <a href="#GtkdocIface.description" class="shortcut">Description</a>
 
35
                 | 
 
36
                <a href="#GtkdocIface.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
37
                 | 
 
38
                <a href="#GtkdocIface.properties" class="shortcut">Properties</a>
 
39
                 | 
 
40
                <a href="#GtkdocIface.signals" class="shortcut">Signals</a>
 
41
</td></tr>
 
42
</table>
 
43
<div class="refentry" lang="en">
 
44
<a name="GtkdocIface"></a><div class="titlepage"></div>
 
45
<div class="refnamediv"><table width="100%"><tr>
 
46
<td valign="top">
 
47
<h2><span class="refentrytitle"><a name="GtkdocIface.top_of_page"></a>GtkdocIface</span></h2>
 
48
<p>GtkdocIface — interface for gtk-doc unit test</p>
 
49
</td>
 
50
<td valign="top" align="right"></td>
 
51
</tr></table></div>
 
52
<div class="refsynopsisdiv">
 
53
<a name="GtkdocIface.synopsis"></a><h2>Synopsis</h2>
 
54
<pre class="synopsis">
 
55
                    <a class="link" href="GtkdocIface.html#GtkdocIface-struct" title="GtkdocIface">GtkdocIface</a>;
 
56
                    <a class="link" href="GtkdocIface.html#GtkdocIfaceInterface" title="GtkdocIfaceInterface">GtkdocIfaceInterface</a>;
 
57
<a
 
58
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
59
>gboolean</a>            <a class="link" href="GtkdocIface.html#gtkdoc-iface-configure" title="gtkdoc_iface_configure ()">gtkdoc_iface_configure</a>              (<a
 
60
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
61
>gchar</a> *config);
 
62
#define             <a class="link" href="GtkdocIface.html#GTKDOC-IFACE-MACRO-DUMMY--CAPS" title="GTKDOC_IFACE_MACRO_DUMMY()">GTKDOC_IFACE_MACRO_DUMMY</a>            (parameter_1,parameter_2)
 
63
#define             <a class="link" href="GtkdocIface.html#GTKDOC-IFACE-MACRO-SUM--CAPS" title="GTKDOC_IFACE_MACRO_SUM()">GTKDOC_IFACE_MACRO_SUM</a>              (parameter_1,parameter_2)
 
64
</pre>
 
65
</div>
 
66
<div class="refsect1" lang="en">
 
67
<a name="GtkdocIface.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
68
<pre class="synopsis">
 
69
  GInterface
 
70
   +----GtkdocIface
 
71
</pre>
 
72
</div>
 
73
<div class="refsect1" lang="en">
 
74
<a name="GtkdocIface.properties"></a><h2>Properties</h2>
 
75
<pre class="synopsis">
 
76
  "<a class="link" href="GtkdocIface.html#GtkdocIface--itest" title='The "itest" property'>itest</a>"                    <a
 
77
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
78
>gchar</a>*                : Read / Write
 
79
</pre>
 
80
</div>
 
81
<div class="refsect1" lang="en">
 
82
<a name="GtkdocIface.signals"></a><h2>Signals</h2>
 
83
<pre class="synopsis">
 
84
  "<a class="link" href="GtkdocIface.html#GtkdocIface-itest" title='The "itest" signal'>itest</a>"                                          : Run Last / No Recursion / No Hooks
 
85
</pre>
 
86
</div>
 
87
<div class="refsect1" lang="en">
 
88
<a name="GtkdocIface.description"></a><h2>Description</h2>
 
89
<p>
 
90
This file contains non-sense code for the sole purpose of testing the docs.
 
91
We can link to the <a class="link" href="GtkdocIface.html#GtkdocIface--itest" title='The "itest" property'><span class="type">"itest"</span></a> property and the <a class="link" href="GtkdocIface.html#GtkdocIface-itest" title='The "itest" signal'><span class="type">"itest"</span></a>
 
92
signal.
 
93
An instance can be configured using the <a class="link" href="GtkdocIface.html#gtkdoc-iface-configure" title="gtkdoc_iface_configure ()"><code class="function">gtkdoc_iface_configure()</code></a> function.</p>
 
94
<p>
 
95
</p>
 
96
</div>
 
97
<div class="refsect1" lang="en">
 
98
<a name="GtkdocIface.details"></a><h2>Details</h2>
 
99
<div class="refsect2" lang="en">
 
100
<a name="GtkdocIface-struct"></a><h3>GtkdocIface</h3>
 
101
<pre class="programlisting">typedef struct _GtkdocIface GtkdocIface;</pre>
 
102
<p>
 
103
opaque instance of gtk-doc unit test interface</p>
 
104
<p>
 
105
</p>
 
106
</div>
 
107
<hr>
 
108
<div class="refsect2" lang="en">
 
109
<a name="GtkdocIfaceInterface"></a><h3>GtkdocIfaceInterface</h3>
 
110
<pre class="programlisting">typedef struct {
 
111
  GTypeInterface parent;
 
112
 
 
113
  /* class methods */
 
114
  void (*test)(const GtkdocIface * const self, gconstpointer const user_data);
 
115
} GtkdocIfaceInterface;
 
116
</pre>
 
117
<p>
 
118
class data of gtk-doc unit test interface</p>
 
119
<p>
 
120
</p>
 
121
<div class="variablelist"><table border="0">
 
122
<col align="left" valign="top">
 
123
<tbody>
 
124
<tr>
 
125
<td><p><span class="term"><a
 
126
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GTypeInterface"
 
127
>GTypeInterface</a> <em class="structfield"><code>parent</code></em>;</span></p></td>
 
128
<td> this is a bug :/
 
129
</td>
 
130
</tr>
 
131
<tr>
 
132
<td><p><span class="term"><em class="structfield"><code>test</code></em> ()</span></p></td>
 
133
<td> overideable method
 
134
</td>
 
135
</tr>
 
136
</tbody>
 
137
</table></div>
 
138
</div>
 
139
<hr>
 
140
<div class="refsect2" lang="en">
 
141
<a name="gtkdoc-iface-configure"></a><h3>gtkdoc_iface_configure ()</h3>
 
142
<pre class="programlisting"><a
 
143
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
144
>gboolean</a>            gtkdoc_iface_configure              (<a
 
145
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
146
>gchar</a> *config);</pre>
 
147
<p>
 
148
Configure a new instance</p>
 
149
<p>
 
150
</p>
 
151
<div class="variablelist"><table border="0">
 
152
<col align="left" valign="top">
 
153
<tbody>
 
154
<tr>
 
155
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
 
156
<td> settings
 
157
</td>
 
158
</tr>
 
159
<tr>
 
160
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
161
<td> <code class="literal">TRUE</code> for sucess or <code class="literal">FALSE</code> in case of an error
 
162
 
 
163
</td>
 
164
</tr>
 
165
</tbody>
 
166
</table></div>
 
167
<p class="since">Since 0.1</p>
 
168
</div>
 
169
<hr>
 
170
<div class="refsect2" lang="en">
 
171
<a name="GTKDOC-IFACE-MACRO-DUMMY--CAPS"></a><h3>GTKDOC_IFACE_MACRO_DUMMY()</h3>
 
172
<pre class="programlisting">#define GTKDOC_IFACE_MACRO_DUMMY(parameter_1,parameter_2) /* do nothing */
 
173
</pre>
 
174
<p>
 
175
This macro does nothing.</p>
 
176
<p>
 
177
</p>
 
178
<div class="variablelist"><table border="0">
 
179
<col align="left" valign="top">
 
180
<tbody>
 
181
<tr>
 
182
<td><p><span class="term"><em class="parameter"><code>parameter_1</code></em> :</span></p></td>
 
183
<td> first arg
 
184
</td>
 
185
</tr>
 
186
<tr>
 
187
<td><p><span class="term"><em class="parameter"><code>parameter_2</code></em> :</span></p></td>
 
188
<td> second arg
 
189
</td>
 
190
</tr>
 
191
</tbody>
 
192
</table></div>
 
193
</div>
 
194
<hr>
 
195
<div class="refsect2" lang="en">
 
196
<a name="GTKDOC-IFACE-MACRO-SUM--CAPS"></a><h3>GTKDOC_IFACE_MACRO_SUM()</h3>
 
197
<pre class="programlisting">#define             GTKDOC_IFACE_MACRO_SUM(parameter_1,parameter_2)</pre>
 
198
<p>
 
199
This macro adds its args.
 
200
</p>
 
201
<p>
 
202
Return: the sum of <em class="parameter"><code>parameter_1</code></em> and <em class="parameter"><code>parameter_2</code></em></p>
 
203
<p>
 
204
</p>
 
205
<div class="variablelist"><table border="0">
 
206
<col align="left" valign="top">
 
207
<tbody>
 
208
<tr>
 
209
<td><p><span class="term"><em class="parameter"><code>parameter_1</code></em> :</span></p></td>
 
210
<td> first arg
 
211
</td>
 
212
</tr>
 
213
<tr>
 
214
<td><p><span class="term"><em class="parameter"><code>parameter_2</code></em> :</span></p></td>
 
215
<td> second arg
 
216
</td>
 
217
</tr>
 
218
</tbody>
 
219
</table></div>
 
220
</div>
 
221
</div>
 
222
<div class="refsect1" lang="en">
 
223
<a name="GtkdocIface.property-details"></a><h2>Property Details</h2>
 
224
<div class="refsect2" lang="en">
 
225
<a name="GtkdocIface--itest"></a><h3>The <code class="literal">"itest"</code> property</h3>
 
226
<pre class="programlisting">  "itest"                    <a
 
227
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
228
>gchar</a>*                : Read / Write</pre>
 
229
<p>dummy property for iface.</p>
 
230
<p>Default value: "dummy"</p>
 
231
</div>
 
232
</div>
 
233
<div class="refsect1" lang="en">
 
234
<a name="GtkdocIface.signal-details"></a><h2>Signal Details</h2>
 
235
<div class="refsect2" lang="en">
 
236
<a name="GtkdocIface-itest"></a><h3>The <code class="literal">"itest"</code> signal</h3>
 
237
<pre class="programlisting">void                user_function                      (<a class="link" href="GtkdocIface.html" title="GtkdocIface">GtkdocIface</a> *self,
 
238
                                                        <a
 
239
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
 
240
>gpointer</a>     user_data)      : Run Last / No Recursion / No Hooks</pre>
 
241
<p>
 
242
The event has been triggered.</p>
 
243
<p>
 
244
</p>
 
245
<div class="variablelist"><table border="0">
 
246
<col align="left" valign="top">
 
247
<tbody>
 
248
<tr>
 
249
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 
250
<td> myself
 
251
</td>
 
252
</tr>
 
253
<tr>
 
254
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
255
<td>user data set when the signal handler was connected.</td>
 
256
</tr>
 
257
</tbody>
 
258
</table></div>
 
259
</div>
 
260
</div>
 
261
</div>
 
262
<div class="footer">
 
263
<hr>
 
264
          Generated by GTK-Doc V1.11</div>
 
265
</body>
 
266
</html>