← 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/GtkdocObject.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/GtkdocObject.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>GtkdocObject</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="main-api.html" title="Tests">
 
10
<link rel="next" href="GtkdocIface.html" title="GtkdocIface">
 
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="main-api.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="GtkdocIface.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="#GtkdocObject.synopsis" class="shortcut">Top</a>
 
33
                 | 
 
34
                <a href="#GtkdocObject.description" class="shortcut">Description</a>
 
35
                 | 
 
36
                <a href="#GtkdocObject.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
37
                 | 
 
38
                <a href="#GtkdocObject.properties" class="shortcut">Properties</a>
 
39
                 | 
 
40
                <a href="#GtkdocObject.signals" class="shortcut">Signals</a>
 
41
</td></tr>
 
42
</table>
 
43
<div class="refentry" lang="en">
 
44
<a name="GtkdocObject"></a><div class="titlepage"></div>
 
45
<div class="refnamediv"><table width="100%"><tr>
 
46
<td valign="top">
 
47
<h2><span class="refentrytitle"><a name="GtkdocObject.top_of_page"></a>GtkdocObject</span></h2>
 
48
<p>GtkdocObject — class 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="GtkdocObject.synopsis"></a><h2>Synopsis</h2>
 
54
<pre class="synopsis">
 
55
                    <a class="link" href="GtkdocObject.html#GtkdocObject-struct" title="GtkdocObject">GtkdocObject</a>;
 
56
                    <a class="link" href="GtkdocObject.html#GtkdocObjectClass" title="GtkdocObjectClass">GtkdocObjectClass</a>;
 
57
<a class="link" href="GtkdocObject.html" title="GtkdocObject">GtkdocObject</a> *      <a class="link" href="GtkdocObject.html#gtkdoc-object-new" title="gtkdoc_object_new ()">gtkdoc_object_new</a>                   (void);
 
58
void                <a class="link" href="GtkdocObject.html#gtkdoc-object-set-otest" title="gtkdoc_object_set_otest ()">gtkdoc_object_set_otest</a>             (<a
 
59
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
 
60
>GObject</a> *self,
 
61
                                                         const <a
 
62
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
63
>gchar</a> *value);
 
64
void                <a class="link" href="GtkdocObject.html#gtkdoc-object-frobnicate" title="gtkdoc_object_frobnicate ()">gtkdoc_object_frobnicate</a>            (<a
 
65
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
 
66
>GObject</a> *self,
 
67
                                                         <a
 
68
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
 
69
>gint</a> n);
 
70
#define             <a class="link" href="GtkdocObject.html#GTKDOC-OBJECT-MACRO-DUMMY--CAPS" title="GTKDOC_OBJECT_MACRO_DUMMY()">GTKDOC_OBJECT_MACRO_DUMMY</a>           (parameter_1,parameter_2)
 
71
#define             <a class="link" href="GtkdocObject.html#GTKDOC-OBJECT-MACRO-SUM--CAPS" title="GTKDOC_OBJECT_MACRO_SUM()">GTKDOC_OBJECT_MACRO_SUM</a>             (parameter_1,parameter_2)
 
72
</pre>
 
73
</div>
 
74
<div class="refsect1" lang="en">
 
75
<a name="GtkdocObject.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
76
<pre class="synopsis">
 
77
  <a
 
78
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
 
79
>GObject</a>
 
80
   +----GtkdocObject
 
81
</pre>
 
82
</div>
 
83
<div class="refsect1" lang="en">
 
84
<a name="GtkdocObject.properties"></a><h2>Properties</h2>
 
85
<pre class="synopsis">
 
86
  "<a class="link" href="GtkdocObject.html#GtkdocObject--otest" title='The "otest" property'>otest</a>"                    <a
 
87
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
88
>gchar</a>*                : Read / Write
 
89
</pre>
 
90
</div>
 
91
<div class="refsect1" lang="en">
 
92
<a name="GtkdocObject.signals"></a><h2>Signals</h2>
 
93
<pre class="synopsis">
 
94
  "<a class="link" href="GtkdocObject.html#GtkdocObject-otest" title='The "otest" signal'>otest</a>"                                          : Run Last / No Recursion / No Hooks
 
95
</pre>
 
96
</div>
 
97
<div class="refsect1" lang="en">
 
98
<a name="GtkdocObject.description"></a><h2>Description</h2>
 
99
<p>
 
100
This file contains non-sense code for the sole purpose of testing the docs.
 
101
We can link to the <a class="link" href="GtkdocObject.html#GtkdocObject--otest" title='The "otest" property'><span class="type">"otest"</span></a> property and the <a class="link" href="GtkdocObject.html#GtkdocObject-otest" title='The "otest" signal'><span class="type">"otest"</span></a>
 
102
signal.
 
103
A new instance can be created using the <a class="link" href="GtkdocObject.html#gtkdoc-object-new" title="gtkdoc_object_new ()"><code class="function">gtkdoc_object_new()</code></a> function. The
 
104
whole lifecycle usualy looks like shown in this example: </p>
 
105
<div class="informalexample"><pre class="programlisting">
 
106
GObject *myobj;
 
107
 
 
108
myobj = gtkdoc_object_new();
 
109
// do somehing
 
110
g_object_unref (myobj);
 
111
</pre></div>
 
112
<p>
 
113
</p>
 
114
<p>
 
115
You can also change parameters:
 
116
</p>
 
117
<div class="informalexample"><pre class="programlisting">/* example for gobject usage */
 
118
 
 
119
#include &lt;glib.h&gt;
 
120
#include &lt;glib-object.h&gt;
 
121
 
 
122
gint
 
123
main(gint argc, gchar **argv)
 
124
{
 
125
  GObject *myobj;
 
126
 
 
127
  myobj = gtkdoc_object_new();
 
128
  g_object_set (myobj, "parameter", 5, NULL);
 
129
  g_object_unref (myobj);
 
130
  
 
131
  return 0;
 
132
}
 
133
 
 
134
</pre></div>
 
135
<p>
 
136
</p>
 
137
</div>
 
138
<div class="refsect1" lang="en">
 
139
<a name="GtkdocObject.details"></a><h2>Details</h2>
 
140
<div class="refsect2" lang="en">
 
141
<a name="GtkdocObject-struct"></a><h3>GtkdocObject</h3>
 
142
<pre class="programlisting">typedef struct _GtkdocObject GtkdocObject;</pre>
 
143
<p>
 
144
instance data of gtk-doc unit test class</p>
 
145
<p>
 
146
</p>
 
147
</div>
 
148
<hr>
 
149
<div class="refsect2" lang="en">
 
150
<a name="GtkdocObjectClass"></a><h3>GtkdocObjectClass</h3>
 
151
<pre class="programlisting">typedef struct {
 
152
  GObjectClass parent;
 
153
 
 
154
  /* class methods */
 
155
  void (*test)(const GtkdocObject * const self, gconstpointer const user_data);
 
156
} GtkdocObjectClass;
 
157
</pre>
 
158
<p>
 
159
class data of gtk-doc unit test class</p>
 
160
<p>
 
161
</p>
 
162
<div class="variablelist"><table border="0">
 
163
<col align="left" valign="top">
 
164
<tbody>
 
165
<tr>
 
166
<td><p><span class="term"><a
 
167
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObjectClass"
 
168
>GObjectClass</a> <em class="structfield"><code>parent</code></em>;</span></p></td>
 
169
<td> this is a bug :/
 
170
</td>
 
171
</tr>
 
172
<tr>
 
173
<td><p><span class="term"><em class="structfield"><code>test</code></em> ()</span></p></td>
 
174
<td> overideable method
 
175
</td>
 
176
</tr>
 
177
</tbody>
 
178
</table></div>
 
179
</div>
 
180
<hr>
 
181
<div class="refsect2" lang="en">
 
182
<a name="gtkdoc-object-new"></a><h3>gtkdoc_object_new ()</h3>
 
183
<pre class="programlisting"><a class="link" href="GtkdocObject.html" title="GtkdocObject">GtkdocObject</a> *      gtkdoc_object_new                   (void);</pre>
 
184
<p>
 
185
Create a new instance</p>
 
186
<p>
 
187
</p>
 
188
<div class="variablelist"><table border="0">
 
189
<col align="left" valign="top">
 
190
<tbody><tr>
 
191
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
192
<td> the instance or <code class="literal">NULL</code> in case of an error
 
193
 
 
194
</td>
 
195
</tr></tbody>
 
196
</table></div>
 
197
<p class="since">Since 0.1</p>
 
198
</div>
 
199
<hr>
 
200
<div class="refsect2" lang="en">
 
201
<a name="gtkdoc-object-set-otest"></a><h3>gtkdoc_object_set_otest ()</h3>
 
202
<pre class="programlisting">void                gtkdoc_object_set_otest             (<a
 
203
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
 
204
>GObject</a> *self,
 
205
                                                         const <a
 
206
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
207
>gchar</a> *value);</pre>
 
208
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
209
<h3 class="title">Warning</h3>
 
210
<p><code class="literal">gtkdoc_object_set_otest</code> is deprecated and should not be used in newly-written code. Use g_object_set(obj,"otest",value,NULL); instead.</p>
 
211
</div>
 
212
<p>
 
213
Set the <a class="link" href="GtkdocObject.html#GtkdocObject--otest" title='The "otest" property'><span class="type">"otest"</span></a> property.</p>
 
214
<p>
 
215
</p>
 
216
<div class="variablelist"><table border="0">
 
217
<col align="left" valign="top">
 
218
<tbody>
 
219
<tr>
 
220
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 
221
<td> the object
 
222
</td>
 
223
</tr>
 
224
<tr>
 
225
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 
226
<td> the new otest value
 
227
</td>
 
228
</tr>
 
229
</tbody>
 
230
</table></div>
 
231
<p class="since">Since 0.5</p>
 
232
</div>
 
233
<hr>
 
234
<div class="refsect2" lang="en">
 
235
<a name="gtkdoc-object-frobnicate"></a><h3>gtkdoc_object_frobnicate ()</h3>
 
236
<pre class="programlisting">void                gtkdoc_object_frobnicate            (<a
 
237
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
 
238
>GObject</a> *self,
 
239
                                                         <a
 
240
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
 
241
>gint</a> n);</pre>
 
242
<p>
 
243
Frobnicate the content of <em class="parameter"><code>self</code></em> <em class="parameter"><code>n</code></em> times.</p>
 
244
<p>
 
245
</p>
 
246
<div class="variablelist"><table border="0">
 
247
<col align="left" valign="top">
 
248
<tbody>
 
249
<tr>
 
250
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 
251
<td> the object
 
252
</td>
 
253
</tr>
 
254
<tr>
 
255
<td><p><span class="term"><em class="parameter"><code>n</code></em> :</span></p></td>
 
256
<td> number of iterations
 
257
</td>
 
258
</tr>
 
259
</tbody>
 
260
</table></div>
 
261
<p class="since">Since 0.5</p>
 
262
</div>
 
263
<hr>
 
264
<div class="refsect2" lang="en">
 
265
<a name="GTKDOC-OBJECT-MACRO-DUMMY--CAPS"></a><h3>GTKDOC_OBJECT_MACRO_DUMMY()</h3>
 
266
<pre class="programlisting">#define GTKDOC_OBJECT_MACRO_DUMMY(parameter_1,parameter_2) /* do nothing */
 
267
</pre>
 
268
<p>
 
269
This macro does nothing.</p>
 
270
<p>
 
271
</p>
 
272
<div class="variablelist"><table border="0">
 
273
<col align="left" valign="top">
 
274
<tbody>
 
275
<tr>
 
276
<td><p><span class="term"><em class="parameter"><code>parameter_1</code></em> :</span></p></td>
 
277
<td> first arg
 
278
</td>
 
279
</tr>
 
280
<tr>
 
281
<td><p><span class="term"><em class="parameter"><code>parameter_2</code></em> :</span></p></td>
 
282
<td> second arg
 
283
</td>
 
284
</tr>
 
285
</tbody>
 
286
</table></div>
 
287
</div>
 
288
<hr>
 
289
<div class="refsect2" lang="en">
 
290
<a name="GTKDOC-OBJECT-MACRO-SUM--CAPS"></a><h3>GTKDOC_OBJECT_MACRO_SUM()</h3>
 
291
<pre class="programlisting">#define             GTKDOC_OBJECT_MACRO_SUM(parameter_1,parameter_2)</pre>
 
292
<p>
 
293
This macro adds its args.
 
294
</p>
 
295
<p>
 
296
Return: the sum of <em class="parameter"><code>parameter_1</code></em> and <em class="parameter"><code>parameter_2</code></em></p>
 
297
<p>
 
298
</p>
 
299
<div class="variablelist"><table border="0">
 
300
<col align="left" valign="top">
 
301
<tbody>
 
302
<tr>
 
303
<td><p><span class="term"><em class="parameter"><code>parameter_1</code></em> :</span></p></td>
 
304
<td> first arg
 
305
</td>
 
306
</tr>
 
307
<tr>
 
308
<td><p><span class="term"><em class="parameter"><code>parameter_2</code></em> :</span></p></td>
 
309
<td> second arg
 
310
</td>
 
311
</tr>
 
312
</tbody>
 
313
</table></div>
 
314
</div>
 
315
</div>
 
316
<div class="refsect1" lang="en">
 
317
<a name="GtkdocObject.property-details"></a><h2>Property Details</h2>
 
318
<div class="refsect2" lang="en">
 
319
<a name="GtkdocObject--otest"></a><h3>The <code class="literal">"otest"</code> property</h3>
 
320
<pre class="programlisting">  "otest"                    <a
 
321
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
322
>gchar</a>*                : Read / Write</pre>
 
323
<p>dummy property for object.</p>
 
324
<p>Default value: "dummy"</p>
 
325
</div>
 
326
</div>
 
327
<div class="refsect1" lang="en">
 
328
<a name="GtkdocObject.signal-details"></a><h2>Signal Details</h2>
 
329
<div class="refsect2" lang="en">
 
330
<a name="GtkdocObject-otest"></a><h3>The <code class="literal">"otest"</code> signal</h3>
 
331
<pre class="programlisting">void                user_function                      (<a class="link" href="GtkdocObject.html" title="GtkdocObject">GtkdocObject</a> *self,
 
332
                                                        <a
 
333
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
 
334
>gpointer</a>      user_data)      : Run Last / No Recursion / No Hooks</pre>
 
335
<p>
 
336
The event has been triggered.</p>
 
337
<p>
 
338
</p>
 
339
<div class="variablelist"><table border="0">
 
340
<col align="left" valign="top">
 
341
<tbody>
 
342
<tr>
 
343
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 
344
<td> myself
 
345
</td>
 
346
</tr>
 
347
<tr>
 
348
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
349
<td>user data set when the signal handler was connected.</td>
 
350
</tr>
 
351
</tbody>
 
352
</table></div>
 
353
</div>
 
354
</div>
 
355
</div>
 
356
<div class="footer">
 
357
<hr>
 
358
          Generated by GTK-Doc V1.11</div>
 
359
</body>
 
360
</html>