1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Parole</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
<link rel="home" href="index.html" title="Parole Plugins Reference Manual">
<link rel="up" href="fundamentals.html" title="Part III. Fundamentals">
<link rel="prev" href="fundamentals.html" title="Part III. Fundamentals">
<link rel="next" href="API.html" title="Part IV. Parole Plugin Reference">
<meta name="generator" content="GTK-Doc V1.13 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="Intro.html" title="Part I. Introduction">
<link rel="part" href="parole-plugins-tut.html" title="Part II. Parole Plugin Tutorial">
<link rel="part" href="fundamentals.html" title="Part III. Fundamentals">
<link rel="part" href="API.html" title="Part IV. Parole Plugin Reference">
<link rel="part" href="Utils.html" title="Part V. Parole Utilities">
<link rel="index" href="api-index-full.html" title="API Index">
</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="fundamentals.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="fundamentals.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">Parole Plugins Reference Manual</th>
<td><a accesskey="n" href="API.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#Parole-Plugins-parole.synopsis" class="shortcut">Top</a>
|
<a href="#Parole-Plugins-parole.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" lang="en">
<a name="Parole-Plugins-parole"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="Parole-Plugins-parole.top_of_page"></a>Parole</span></h2>
<p>Parole</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="Parole-Plugins-parole.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">#define <a href="Parole-Plugins-parole.html#PAROLE-MAJOR-VERSION:CAPS">PAROLE_MAJOR_VERSION</a>
#define <a href="Parole-Plugins-parole.html#PAROLE-MINOR-VERSION:CAPS">PAROLE_MINOR_VERSION</a>
#define <a href="Parole-Plugins-parole.html#PAROLE-MICRO-VERSION:CAPS">PAROLE_MICRO_VERSION</a>
#define <a href="Parole-Plugins-parole.html#PAROLE-CHECK-VERSION:CAPS">PAROLE_CHECK_VERSION</a> (major,minor,micro)
#define <a href="Parole-Plugins-parole.html#PAROLE-DEFINE-TYPE:CAPS">PAROLE_DEFINE_TYPE</a> (TN, t_n, T_P)
#define <a href="Parole-Plugins-parole.html#PAROLE-DEFINE-TYPE-EXTENDED:CAPS">PAROLE_DEFINE_TYPE_EXTENDED</a> (TN, t_n, T_P, _f_, _C_)
#define <a href="Parole-Plugins-parole.html#PAROLE-DEFINE-TYPE-WITH-CODE:CAPS">PAROLE_DEFINE_TYPE_WITH_CODE</a> (TN, t_n, T_P, _C_)
#define <a href="Parole-Plugins-parole.html#PAROLE-DEFINE-ABSTRACT-TYPE:CAPS">PAROLE_DEFINE_ABSTRACT_TYPE</a> (TN, t_n, T_P)
#define <a href="Parole-Plugins-parole.html#PAROLE-DEFINE-ABSTRACT-TYPE-WITH-CODE:CAPS">PAROLE_DEFINE_ABSTRACT_TYPE_WITH_CODE</a>(TN, t_n, T_P, _C_)
#define <a href="Parole-Plugins-parole.html#PAROLE-IMPLEMENT-INTERFACE:CAPS">PAROLE_IMPLEMENT_INTERFACE</a> (TYPE_IFACE, iface_init)
</pre>
</div>
<div class="refsect1" lang="en">
<a name="Parole-Plugins-parole.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="Parole-Plugins-parole.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="PAROLE-MAJOR-VERSION:CAPS"></a><h3>PAROLE_MAJOR_VERSION</h3>
<pre class="programlisting">#define PAROLE_MAJOR_VERSION 0
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="PAROLE-MINOR-VERSION:CAPS"></a><h3>PAROLE_MINOR_VERSION</h3>
<pre class="programlisting">#define PAROLE_MINOR_VERSION 2
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="PAROLE-MICRO-VERSION:CAPS"></a><h3>PAROLE_MICRO_VERSION</h3>
<pre class="programlisting">#define PAROLE_MICRO_VERSION 0.2
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="PAROLE-CHECK-VERSION:CAPS"></a><h3>PAROLE_CHECK_VERSION()</h3>
<pre class="programlisting">#define PAROLE_CHECK_VERSION(major,minor,micro)</pre>
<p>
Checks the parole version.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>major</code></em> :</span></p></td>
<td> major version number.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>minor</code></em> :</span></p></td>
<td> minor version number.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>micro</code></em> :</span></p></td>
<td> micor version number.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="PAROLE-DEFINE-TYPE:CAPS"></a><h3>PAROLE_DEFINE_TYPE()</h3>
<pre class="programlisting">#define PAROLE_DEFINE_TYPE(TN, t_n, T_P) PAROLE_DEFINE_TYPE_EXTENDED (TN, t_n, T_P, 0, {})
</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>TN</code></em> :</span></p></td>
<td> The name of the new type, in Camel case.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>t_n</code></em> :</span></p></td>
<td> The name of the new type, in lowercase, with words separated by '_'.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>T_P</code></em> :</span></p></td>
<td> The <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> of the parent type.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="PAROLE-DEFINE-TYPE-EXTENDED:CAPS"></a><h3>PAROLE_DEFINE_TYPE_EXTENDED()</h3>
<pre class="programlisting">#define PAROLE_DEFINE_TYPE_EXTENDED(TN, t_n, T_P, _f_, _C_) _PAROLE_DEFINE_TYPE_EXTENDED_BEGIN(TN, t_n, T_P, _f_) {_C_;} _PAROLE_DEFINE_TYPE_EXTENDED_END()
</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>TN</code></em> :</span></p></td>
<td> The name of the new type, in Camel case.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>t_n</code></em> :</span></p></td>
<td> The name of the new type, in lowercase, with words separated by '_'.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>T_P</code></em> :</span></p></td>
<td> The <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> of the parent type.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>_f_</code></em> :</span></p></td>
<td> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GTypeFlags"><span class="type">GTypeFlags</span></a> to pass to <a href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html#g-type-module-register-type"><code class="function">g_type_module_register_type()</code></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>_C_</code></em> :</span></p></td>
<td> Custom code that gets inserted in *_get_type() function.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="PAROLE-DEFINE-TYPE-WITH-CODE:CAPS"></a><h3>PAROLE_DEFINE_TYPE_WITH_CODE()</h3>
<pre class="programlisting">#define PAROLE_DEFINE_TYPE_WITH_CODE(TN, t_n, T_P, _C_) _PAROLE_DEFINE_TYPE_EXTENDED_BEGIN(TN, t_n, T_P, 0) {_C_;} _PAROLE_DEFINE_TYPE_EXTENDED_END()
</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>TN</code></em> :</span></p></td>
<td> The name of the new type, in Camel case.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>t_n</code></em> :</span></p></td>
<td> The name of the new type, in lowercase, with words separated by '_'.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>T_P</code></em> :</span></p></td>
<td> The <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> of the parent type.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>_C_</code></em> :</span></p></td>
<td> Custom code that gets inserted in *_get_type() function.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="PAROLE-DEFINE-ABSTRACT-TYPE:CAPS"></a><h3>PAROLE_DEFINE_ABSTRACT_TYPE()</h3>
<pre class="programlisting">#define PAROLE_DEFINE_ABSTRACT_TYPE(TN, t_n, T_P) PAROLE_DEFINE_TYPE_EXTENDED (TN, t_n, T_P, G_TYPE_FLAG_ABSTRACT, {})
</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>TN</code></em> :</span></p></td>
<td> The name of the new type, in Camel case.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>t_n</code></em> :</span></p></td>
<td> The name of the new type, in lowercase, with words separated by '_'.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>T_P</code></em> :</span></p></td>
<td> The <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> of the parent type.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="PAROLE-DEFINE-ABSTRACT-TYPE-WITH-CODE:CAPS"></a><h3>PAROLE_DEFINE_ABSTRACT_TYPE_WITH_CODE()</h3>
<pre class="programlisting">#define PAROLE_DEFINE_ABSTRACT_TYPE_WITH_CODE(TN, t_n, T_P, _C_) PAROLE_DEFINE_TYPE_EXTENDED (TN, t_n, T_P, G_TYPE_FLAG_ABSTRACT, _C_)
</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>TN</code></em> :</span></p></td>
<td> The name of the new type, in Camel case.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>t_n</code></em> :</span></p></td>
<td> The name of the new type, in lowercase, with words separated by '_'.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>T_P</code></em> :</span></p></td>
<td> The <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> of the parent type.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>_C_</code></em> :</span></p></td>
<td> Custom code that gets inserted in *_get_type() function.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="PAROLE-IMPLEMENT-INTERFACE:CAPS"></a><h3>PAROLE_IMPLEMENT_INTERFACE()</h3>
<pre class="programlisting">#define PAROLE_IMPLEMENT_INTERFACE(TYPE_IFACE, iface_init)</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>TYPE_IFACE</code></em> :</span></p></td>
<td> the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> of the interface to add.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iface_init</code></em> :</span></p></td>
<td> The interface init function.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.13</div>
</body>
</html>
|
