~ubuntu-branches/ubuntu/saucy/parole/saucy-proposed

« back to all changes in this revision

Viewing changes to docs/plugin-api/html/Parole-Plugins-parole.html

  • Committer: Bazaar Package Importer
  • Author(s): Yves-Alexis Perez, Lionel Le Folgoc, Yves-Alexis Perez
  • Date: 2011-04-24 16:09:19 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20110424160919-rpjwaicrdb8f7un2
Tags: 0.2.0.6-1
[ Lionel Le Folgoc ]
* debian/control:
  - drop unneeded build-dep on xulrunner-dev.   closes: #594073
  - suggests a few useful gstreamer0.10 plugins.
  - build-depends on quilt.
* debian/patches:
  - 01_fix-implicit-dso-linking.patch: added, fixes FTBFS with binutils-gold.
  - series: added.                                            closes: #615760
* debian/rules: pass --with quilt to dh.

[ Yves-Alexis Perez ]
* New upstream release.
* Switch to 3.0 (quilt) source format.
* debian/control:
  - update standards version to 3.9.2.
  - drop browser-plugin-parole package.
  - drop quilt build-dep.
  - add build-dep on hardening-includes
  - bump xfce build-deps to 4.8.
* debian/parole.install updated.
* debian/rules:
  - use --fail-missing and manually remove spurious files.
  - drop quilt addon
  - pick build flags from dpkg-buildflags.
  - add -O1, -z,defs and --as-needed to LDFLAGS.
  - add hardening flags to build flags.
  - stop harcoding the shell to bash, it works fine now.      closes: #623830

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
<head>
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">
19
13
</head>
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">
32
26
                  <a href="#Parole-Plugins-parole.description" class="shortcut">Description</a>
33
27
</td></tr>
34
28
</table>
35
 
<div class="refentry" lang="en">
 
29
<div class="refentry">
36
30
<a name="Parole-Plugins-parole"></a><div class="titlepage"></div>
37
31
<div class="refnamediv"><table width="100%"><tr>
38
32
<td valign="top">
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,
 
44
                                                         minor,
 
45
                                                         micro)
 
46
#define             <a class="link" href="Parole-Plugins-parole.html#PAROLE-DEFINE-TYPE:CAPS" title="PAROLE_DEFINE_TYPE()">PAROLE_DEFINE_TYPE</a>                  (TN,
 
47
                                                         t_n,
 
48
                                                         T_P)
 
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,
 
50
                                                         t_n,
 
51
                                                         T_P,
 
52
                                                         _f_,
 
53
                                                         _C_)
 
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,
 
55
                                                         t_n,
 
56
                                                         T_P,
 
57
                                                         _C_)
 
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,
 
59
                                                         t_n,
 
60
                                                         T_P)
 
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,
 
62
                                                         t_n,
 
63
                                                         T_P,
 
64
                                                         _C_)
 
65
#define             <a class="link" href="Parole-Plugins-parole.html#PAROLE-IMPLEMENT-INTERFACE:CAPS" title="PAROLE_IMPLEMENT_INTERFACE()">PAROLE_IMPLEMENT_INTERFACE</a>          (TYPE_IFACE,
 
66
                                                         iface_init)
56
67
</pre>
57
68
</div>
58
 
<div class="refsect1" lang="en">
 
69
<div class="refsect1">
59
70
<a name="Parole-Plugins-parole.description"></a><h2>Description</h2>
60
71
<p>
61
72
</p>
62
73
</div>
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
68
79
</pre>
70
81
</p>
71
82
</div>
72
83
<hr>
73
 
<div class="refsect2" lang="en">
 
84
<div class="refsect2">
74
85
<a name="PAROLE-MINOR-VERSION:CAPS"></a><h3>PAROLE_MINOR_VERSION</h3>
75
86
<pre class="programlisting">#define PAROLE_MINOR_VERSION                2
76
87
</pre>
78
89
</p>
79
90
</div>
80
91
<hr>
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
84
95
</pre>
85
96
<p>
86
97
</p>
87
98
</div>
88
99
<hr>
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>
92
103
<p>
93
 
Checks the parole version.</p>
 
104
Checks the parole version.
 
105
</p>
94
106
<div class="variablelist"><table border="0">
95
107
<col align="left" valign="top">
96
108
<tbody>
97
109
<tr>
98
110
<td><p><span class="term"><em class="parameter"><code>major</code></em> :</span></p></td>
99
 
<td> major version number.
100
 
</td>
 
111
<td>major version number.</td>
101
112
</tr>
102
113
<tr>
103
114
<td><p><span class="term"><em class="parameter"><code>minor</code></em> :</span></p></td>
104
 
<td> minor version number.
105
 
</td>
 
115
<td>minor version number.</td>
106
116
</tr>
107
117
<tr>
108
118
<td><p><span class="term"><em class="parameter"><code>micro</code></em> :</span></p></td>
109
 
<td> micor version number.
110
 
</td>
 
119
<td>micor version number.</td>
111
120
</tr>
112
121
</tbody>
113
122
</table></div>
114
123
<p class="since">Since 0.2</p>
115
124
</div>
116
125
<hr>
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, {})
120
129
</pre>
123
132
<tbody>
124
133
<tr>
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.
127
 
</td>
 
135
<td>The name of the new type, in Camel case.</td>
128
136
</tr>
129
137
<tr>
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 '_'.
132
 
</td>
 
139
<td>The name of the new type, in lowercase, with words separated by '_'.</td>
133
140
</tr>
134
141
<tr>
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.
137
 
</td>
 
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>
138
144
</tr>
139
145
</tbody>
140
146
</table></div>
141
147
<p class="since">Since 0.2</p>
142
148
</div>
143
149
<hr>
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()
147
153
</pre>
150
156
<tbody>
151
157
<tr>
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.
154
 
</td>
 
159
<td>The name of the new type, in Camel case.</td>
155
160
</tr>
156
161
<tr>
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 '_'.
159
 
</td>
 
163
<td>The name of the new type, in lowercase, with words separated by '_'.</td>
160
164
</tr>
161
165
<tr>
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.
164
 
</td>
 
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>
165
168
</tr>
166
169
<tr>
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>.
169
 
</td>
 
171
<td>
 
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>
170
173
</tr>
171
174
<tr>
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.
174
 
</td>
 
176
<td>Custom code that gets inserted in *_get_type() function.</td>
175
177
</tr>
176
178
</tbody>
177
179
</table></div>
178
180
<p class="since">Since 0.2</p>
179
181
</div>
180
182
<hr>
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()
184
186
</pre>
187
189
<tbody>
188
190
<tr>
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.
191
 
</td>
 
192
<td>The name of the new type, in Camel case.</td>
192
193
</tr>
193
194
<tr>
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>
 
196
<td>The name of the new type, in lowercase, with words separated by '_'.</td>
197
197
</tr>
198
198
<tr>
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.
201
 
</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.</td>
202
201
</tr>
203
202
<tr>
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.
206
 
</td>
 
204
<td>Custom code that gets inserted in *_get_type() function.</td>
207
205
</tr>
208
206
</tbody>
209
207
</table></div>
210
208
<p class="since">Since 0.2</p>
211
209
</div>
212
210
<hr>
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, {})
216
214
</pre>
219
217
<tbody>
220
218
<tr>
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.
223
 
</td>
 
220
<td>The name of the new type, in Camel case.</td>
224
221
</tr>
225
222
<tr>
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 '_'.
228
 
</td>
 
224
<td>The name of the new type, in lowercase, with words separated by '_'.</td>
229
225
</tr>
230
226
<tr>
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.
233
 
</td>
 
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>
234
229
</tr>
235
230
</tbody>
236
231
</table></div>
237
232
<p class="since">Since 0.2</p>
238
233
</div>
239
234
<hr>
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_)
243
238
</pre>
246
241
<tbody>
247
242
<tr>
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.
250
 
</td>
 
244
<td>The name of the new type, in Camel case.</td>
251
245
</tr>
252
246
<tr>
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 '_'.
255
 
</td>
 
248
<td>The name of the new type, in lowercase, with words separated by '_'.</td>
256
249
</tr>
257
250
<tr>
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.
260
 
</td>
 
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>
261
253
</tr>
262
254
<tr>
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.
265
 
</td>
 
256
<td>Custom code that gets inserted in *_get_type() function.</td>
266
257
</tr>
267
258
</tbody>
268
259
</table></div>
269
260
<p class="since">Since 0.2</p>
270
261
</div>
271
262
<hr>
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">
277
268
<tbody>
278
269
<tr>
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.
281
 
</td>
 
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>
282
272
</tr>
283
273
<tr>
284
274
<td><p><span class="term"><em class="parameter"><code>iface_init</code></em> :</span></p></td>
285
 
<td> The interface init function.
286
 
</td>
 
275
<td>The interface init function.</td>
287
276
</tr>
288
277
</tbody>
289
278
</table></div>
292
281
</div>
293
282
<div class="footer">
294
283
<hr>
295
 
          Generated by GTK-Doc V1.13</div>
 
284
          Generated by GTK-Doc V1.17</div>
296
285
</body>
297
286
</html>
 
 
b'\\ No newline at end of file'