4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>Parole</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7
7
<link rel="home" href="index.html" title="Parole Plugins Reference Manual">
8
8
<link rel="up" href="fundamentals.html" title="Part III. Fundamentals">
9
9
<link rel="prev" href="fundamentals.html" title="Part III. Fundamentals">
10
10
<link rel="next" href="API.html" title="Part IV. Parole Plugin Reference">
11
<meta name="generator" content="GTK-Doc V1.13 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
<link rel="part" href="Intro.html" title="Part I. Introduction">
14
<link rel="part" href="parole-plugins-tut.html" title="Part II. Parole Plugin Tutorial">
15
<link rel="part" href="fundamentals.html" title="Part III. Fundamentals">
16
<link rel="part" href="API.html" title="Part IV. Parole Plugin Reference">
17
<link rel="part" href="Utils.html" title="Part V. Parole Utilities">
18
<link rel="index" href="api-index-full.html" title="API Index">
20
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
21
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
43
37
</tr></table></div>
44
38
<div class="refsynopsisdiv">
45
39
<a name="Parole-Plugins-parole.synopsis"></a><h2>Synopsis</h2>
46
<pre class="synopsis">#define <a href="Parole-Plugins-parole.html#PAROLE-MAJOR-VERSION:CAPS">PAROLE_MAJOR_VERSION</a>
47
#define <a href="Parole-Plugins-parole.html#PAROLE-MINOR-VERSION:CAPS">PAROLE_MINOR_VERSION</a>
48
#define <a href="Parole-Plugins-parole.html#PAROLE-MICRO-VERSION:CAPS">PAROLE_MICRO_VERSION</a>
49
#define <a href="Parole-Plugins-parole.html#PAROLE-CHECK-VERSION:CAPS">PAROLE_CHECK_VERSION</a> (major,minor,micro)
50
#define <a href="Parole-Plugins-parole.html#PAROLE-DEFINE-TYPE:CAPS">PAROLE_DEFINE_TYPE</a> (TN, t_n, T_P)
51
#define <a href="Parole-Plugins-parole.html#PAROLE-DEFINE-TYPE-EXTENDED:CAPS">PAROLE_DEFINE_TYPE_EXTENDED</a> (TN, t_n, T_P, _f_, _C_)
52
#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_)
53
#define <a href="Parole-Plugins-parole.html#PAROLE-DEFINE-ABSTRACT-TYPE:CAPS">PAROLE_DEFINE_ABSTRACT_TYPE</a> (TN, t_n, T_P)
54
#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_)
55
#define <a href="Parole-Plugins-parole.html#PAROLE-IMPLEMENT-INTERFACE:CAPS">PAROLE_IMPLEMENT_INTERFACE</a> (TYPE_IFACE, iface_init)
40
<pre class="synopsis">#define <a class="link" href="Parole-Plugins-parole.html#PAROLE-MAJOR-VERSION:CAPS" title="PAROLE_MAJOR_VERSION">PAROLE_MAJOR_VERSION</a>
41
#define <a class="link" href="Parole-Plugins-parole.html#PAROLE-MINOR-VERSION:CAPS" title="PAROLE_MINOR_VERSION">PAROLE_MINOR_VERSION</a>
42
#define <a class="link" href="Parole-Plugins-parole.html#PAROLE-MICRO-VERSION:CAPS" title="PAROLE_MICRO_VERSION">PAROLE_MICRO_VERSION</a>
43
#define <a class="link" href="Parole-Plugins-parole.html#PAROLE-CHECK-VERSION:CAPS" title="PAROLE_CHECK_VERSION()">PAROLE_CHECK_VERSION</a> (major,
46
#define <a class="link" href="Parole-Plugins-parole.html#PAROLE-DEFINE-TYPE:CAPS" title="PAROLE_DEFINE_TYPE()">PAROLE_DEFINE_TYPE</a> (TN,
49
#define <a class="link" href="Parole-Plugins-parole.html#PAROLE-DEFINE-TYPE-EXTENDED:CAPS" title="PAROLE_DEFINE_TYPE_EXTENDED()">PAROLE_DEFINE_TYPE_EXTENDED</a> (TN,
54
#define <a class="link" href="Parole-Plugins-parole.html#PAROLE-DEFINE-TYPE-WITH-CODE:CAPS" title="PAROLE_DEFINE_TYPE_WITH_CODE()">PAROLE_DEFINE_TYPE_WITH_CODE</a> (TN,
58
#define <a class="link" href="Parole-Plugins-parole.html#PAROLE-DEFINE-ABSTRACT-TYPE:CAPS" title="PAROLE_DEFINE_ABSTRACT_TYPE()">PAROLE_DEFINE_ABSTRACT_TYPE</a> (TN,
61
#define <a class="link" href="Parole-Plugins-parole.html#PAROLE-DEFINE-ABSTRACT-TYPE-WITH-CODE:CAPS" title="PAROLE_DEFINE_ABSTRACT_TYPE_WITH_CODE()">PAROLE_DEFINE_ABSTRACT_TYPE_WITH_CODE</a>(TN,
65
#define <a class="link" href="Parole-Plugins-parole.html#PAROLE-IMPLEMENT-INTERFACE:CAPS" title="PAROLE_IMPLEMENT_INTERFACE()">PAROLE_IMPLEMENT_INTERFACE</a> (TYPE_IFACE,
58
<div class="refsect1" lang="en">
69
<div class="refsect1">
59
70
<a name="Parole-Plugins-parole.description"></a><h2>Description</h2>
63
<div class="refsect1" lang="en">
74
<div class="refsect1">
64
75
<a name="Parole-Plugins-parole.details"></a><h2>Details</h2>
65
<div class="refsect2" lang="en">
76
<div class="refsect2">
66
77
<a name="PAROLE-MAJOR-VERSION:CAPS"></a><h3>PAROLE_MAJOR_VERSION</h3>
67
78
<pre class="programlisting">#define PAROLE_MAJOR_VERSION 0
81
<div class="refsect2" lang="en">
92
<div class="refsect2">
82
93
<a name="PAROLE-MICRO-VERSION:CAPS"></a><h3>PAROLE_MICRO_VERSION</h3>
83
<pre class="programlisting">#define PAROLE_MICRO_VERSION 0.2
94
<pre class="programlisting">#define PAROLE_MICRO_VERSION 0.6
89
<div class="refsect2" lang="en">
100
<div class="refsect2">
90
101
<a name="PAROLE-CHECK-VERSION:CAPS"></a><h3>PAROLE_CHECK_VERSION()</h3>
91
102
<pre class="programlisting">#define PAROLE_CHECK_VERSION(major,minor,micro)</pre>
93
Checks the parole version.</p>
104
Checks the parole version.
94
106
<div class="variablelist"><table border="0">
95
107
<col align="left" valign="top">
98
110
<td><p><span class="term"><em class="parameter"><code>major</code></em> :</span></p></td>
99
<td> major version number.
111
<td>major version number.</td>
103
114
<td><p><span class="term"><em class="parameter"><code>minor</code></em> :</span></p></td>
104
<td> minor version number.
115
<td>minor version number.</td>
108
118
<td><p><span class="term"><em class="parameter"><code>micro</code></em> :</span></p></td>
109
<td> micor version number.
119
<td>micor version number.</td>
114
123
<p class="since">Since 0.2</p>
117
<div class="refsect2" lang="en">
126
<div class="refsect2">
118
127
<a name="PAROLE-DEFINE-TYPE:CAPS"></a><h3>PAROLE_DEFINE_TYPE()</h3>
119
128
<pre class="programlisting">#define PAROLE_DEFINE_TYPE(TN, t_n, T_P) PAROLE_DEFINE_TYPE_EXTENDED (TN, t_n, T_P, 0, {})
125
134
<td><p><span class="term"><em class="parameter"><code>TN</code></em> :</span></p></td>
126
<td> The name of the new type, in Camel case.
135
<td>The name of the new type, in Camel case.</td>
130
138
<td><p><span class="term"><em class="parameter"><code>t_n</code></em> :</span></p></td>
131
<td> The name of the new type, in lowercase, with words separated by '_'.
139
<td>The name of the new type, in lowercase, with words separated by '_'.</td>
135
142
<td><p><span class="term"><em class="parameter"><code>T_P</code></em> :</span></p></td>
136
<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.
143
<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>
141
147
<p class="since">Since 0.2</p>
144
<div class="refsect2" lang="en">
150
<div class="refsect2">
145
151
<a name="PAROLE-DEFINE-TYPE-EXTENDED:CAPS"></a><h3>PAROLE_DEFINE_TYPE_EXTENDED()</h3>
146
152
<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()
152
158
<td><p><span class="term"><em class="parameter"><code>TN</code></em> :</span></p></td>
153
<td> The name of the new type, in Camel case.
159
<td>The name of the new type, in Camel case.</td>
157
162
<td><p><span class="term"><em class="parameter"><code>t_n</code></em> :</span></p></td>
158
<td> The name of the new type, in lowercase, with words separated by '_'.
163
<td>The name of the new type, in lowercase, with words separated by '_'.</td>
162
166
<td><p><span class="term"><em class="parameter"><code>T_P</code></em> :</span></p></td>
163
<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.
167
<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>
167
170
<td><p><span class="term"><em class="parameter"><code>_f_</code></em> :</span></p></td>
168
<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>.
172
<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>
172
175
<td><p><span class="term"><em class="parameter"><code>_C_</code></em> :</span></p></td>
173
<td> Custom code that gets inserted in *_get_type() function.
176
<td>Custom code that gets inserted in *_get_type() function.</td>
178
180
<p class="since">Since 0.2</p>
181
<div class="refsect2" lang="en">
183
<div class="refsect2">
182
184
<a name="PAROLE-DEFINE-TYPE-WITH-CODE:CAPS"></a><h3>PAROLE_DEFINE_TYPE_WITH_CODE()</h3>
183
185
<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()
189
191
<td><p><span class="term"><em class="parameter"><code>TN</code></em> :</span></p></td>
190
<td> The name of the new type, in Camel case.
192
<td>The name of the new type, in Camel case.</td>
194
195
<td><p><span class="term"><em class="parameter"><code>t_n</code></em> :</span></p></td>
195
<td> The name of the new type, in lowercase, with words separated by '_'.
196
<td>The name of the new type, in lowercase, with words separated by '_'.</td>
199
199
<td><p><span class="term"><em class="parameter"><code>T_P</code></em> :</span></p></td>
200
<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.
200
<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>
204
203
<td><p><span class="term"><em class="parameter"><code>_C_</code></em> :</span></p></td>
205
<td> Custom code that gets inserted in *_get_type() function.
204
<td>Custom code that gets inserted in *_get_type() function.</td>
210
208
<p class="since">Since 0.2</p>
213
<div class="refsect2" lang="en">
211
<div class="refsect2">
214
212
<a name="PAROLE-DEFINE-ABSTRACT-TYPE:CAPS"></a><h3>PAROLE_DEFINE_ABSTRACT_TYPE()</h3>
215
213
<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, {})
221
219
<td><p><span class="term"><em class="parameter"><code>TN</code></em> :</span></p></td>
222
<td> The name of the new type, in Camel case.
220
<td>The name of the new type, in Camel case.</td>
226
223
<td><p><span class="term"><em class="parameter"><code>t_n</code></em> :</span></p></td>
227
<td> The name of the new type, in lowercase, with words separated by '_'.
224
<td>The name of the new type, in lowercase, with words separated by '_'.</td>
231
227
<td><p><span class="term"><em class="parameter"><code>T_P</code></em> :</span></p></td>
232
<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.
228
<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>
237
232
<p class="since">Since 0.2</p>
240
<div class="refsect2" lang="en">
235
<div class="refsect2">
241
236
<a name="PAROLE-DEFINE-ABSTRACT-TYPE-WITH-CODE:CAPS"></a><h3>PAROLE_DEFINE_ABSTRACT_TYPE_WITH_CODE()</h3>
242
237
<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_)
248
243
<td><p><span class="term"><em class="parameter"><code>TN</code></em> :</span></p></td>
249
<td> The name of the new type, in Camel case.
244
<td>The name of the new type, in Camel case.</td>
253
247
<td><p><span class="term"><em class="parameter"><code>t_n</code></em> :</span></p></td>
254
<td> The name of the new type, in lowercase, with words separated by '_'.
248
<td>The name of the new type, in lowercase, with words separated by '_'.</td>
258
251
<td><p><span class="term"><em class="parameter"><code>T_P</code></em> :</span></p></td>
259
<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.
252
<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>
263
255
<td><p><span class="term"><em class="parameter"><code>_C_</code></em> :</span></p></td>
264
<td> Custom code that gets inserted in *_get_type() function.
256
<td>Custom code that gets inserted in *_get_type() function.</td>
269
260
<p class="since">Since 0.2</p>
272
<div class="refsect2" lang="en">
263
<div class="refsect2">
273
264
<a name="PAROLE-IMPLEMENT-INTERFACE:CAPS"></a><h3>PAROLE_IMPLEMENT_INTERFACE()</h3>
274
265
<pre class="programlisting">#define PAROLE_IMPLEMENT_INTERFACE(TYPE_IFACE, iface_init)</pre>
275
266
<div class="variablelist"><table border="0">
279
270
<td><p><span class="term"><em class="parameter"><code>TYPE_IFACE</code></em> :</span></p></td>
280
<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.
271
<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>
284
274
<td><p><span class="term"><em class="parameter"><code>iface_init</code></em> :</span></p></td>
285
<td> The interface init function.
275
<td>The interface init function.</td>