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
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ThunarxProviderPlugin: thunarx Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="thunarx Reference Manual">
<link rel="up" href="thunarx-abstraction-layer.html" title="Part IV. Abstraction Layer">
<link rel="prev" href="ThunarxPropertyPage.html" title="ThunarxPropertyPage">
<link rel="next" href="ThunarxRenamer.html" title="ThunarxRenamer">
<meta name="generator" content="GTK-Doc V1.34.0 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#ThunarxProviderPlugin.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#ThunarxProviderPlugin.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#ThunarxProviderPlugin.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="thunarx-abstraction-layer.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ThunarxPropertyPage.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ThunarxRenamer.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ThunarxProviderPlugin"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ThunarxProviderPlugin.top_of_page"></a>ThunarxProviderPlugin</span></h2>
<p>ThunarxProviderPlugin — The interface to the plugin type registration</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ThunarxProviderPlugin.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ThunarxProviderPlugin.html#thunarx-provider-plugin-get-resident" title="thunarx_provider_plugin_get_resident ()">thunarx_provider_plugin_get_resident</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ThunarxProviderPlugin.html#thunarx-provider-plugin-set-resident" title="thunarx_provider_plugin_set_resident ()">thunarx_provider_plugin_set_resident</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GType</span>
</td>
<td class="function_name">
<a class="link" href="ThunarxProviderPlugin.html#thunarx-provider-plugin-register-type" title="thunarx_provider_plugin_register_type ()">thunarx_provider_plugin_register_type</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ThunarxProviderPlugin.html#thunarx-provider-plugin-add-interface" title="thunarx_provider_plugin_add_interface ()">thunarx_provider_plugin_add_interface</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GType</span>
</td>
<td class="function_name">
<a class="link" href="ThunarxProviderPlugin.html#thunarx-provider-plugin-register-enum" title="thunarx_provider_plugin_register_enum ()">thunarx_provider_plugin_register_enum</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GType</span>
</td>
<td class="function_name">
<a class="link" href="ThunarxProviderPlugin.html#thunarx-provider-plugin-register-flags" title="thunarx_provider_plugin_register_flags ()">thunarx_provider_plugin_register_flags</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="ThunarxProviderPlugin.html#THUNARX-DEFINE-TYPE:CAPS" title="THUNARX_DEFINE_TYPE()">THUNARX_DEFINE_TYPE</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="ThunarxProviderPlugin.html#THUNARX-DEFINE-TYPE-WITH-CODE:CAPS" title="THUNARX_DEFINE_TYPE_WITH_CODE()">THUNARX_DEFINE_TYPE_WITH_CODE</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="ThunarxProviderPlugin.html#THUNARX-DEFINE-ABSTRACT-TYPE:CAPS" title="THUNARX_DEFINE_ABSTRACT_TYPE()">THUNARX_DEFINE_ABSTRACT_TYPE</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="ThunarxProviderPlugin.html#THUNARX-DEFINE-ABSTRACT-TYPE-WITH-CODE:CAPS" title="THUNARX_DEFINE_ABSTRACT_TYPE_WITH_CODE()">THUNARX_DEFINE_ABSTRACT_TYPE_WITH_CODE</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="ThunarxProviderPlugin.html#THUNARX-DEFINE-TYPE-EXTENDED:CAPS" title="THUNARX_DEFINE_TYPE_EXTENDED()">THUNARX_DEFINE_TYPE_EXTENDED</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="ThunarxProviderPlugin.html#THUNARX-IMPLEMENT-INTERFACE:CAPS" title="THUNARX_IMPLEMENT_INTERFACE()">THUNARX_IMPLEMENT_INTERFACE</a><span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ThunarxProviderPlugin.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ThunarxProviderPlugin.html#ThunarxProviderPlugin--resident" title="The “resident” property">resident</a></td>
<td class="property_flags">Read / Write</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ThunarxProviderPlugin.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="ThunarxProviderPlugin.html#ThunarxProviderPlugin-struct" title="ThunarxProviderPlugin">ThunarxProviderPlugin</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ThunarxProviderPlugin.html#ThunarxProviderPluginIface" title="struct ThunarxProviderPluginIface">ThunarxProviderPluginIface</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ThunarxProviderPlugin.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a>
<span class="lineart">╰──</span> ThunarxProviderPlugin
</pre>
</div>
<div class="refsect1">
<a name="ThunarxProviderPlugin.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <thunarx/thunarx.h>
</pre>
</div>
<div class="refsect1">
<a name="ThunarxProviderPlugin.description"></a><h2>Description</h2>
<p><a class="link" href="ThunarxProviderPlugin.html" title="ThunarxProviderPlugin"><span class="type">ThunarxProviderPlugin</span></a> is the interface to the file manager's type plugin loader implementation. It
provides methods to extensions - also called <span class="emphasis"><em>provider plugins</em></span> - to register dynamic
types and control certain aspects of the plugin (see <a class="link" href="ThunarxProviderPlugin.html#thunarx-provider-plugin-set-resident" title="thunarx_provider_plugin_set_resident ()"><code class="function">thunarx_provider_plugin_set_resident()</code></a>).</p>
</div>
<div class="refsect1">
<a name="ThunarxProviderPlugin.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="thunarx-provider-plugin-get-resident"></a><h3>thunarx_provider_plugin_get_resident ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
thunarx_provider_plugin_get_resident (<em class="parameter"><code>const <a class="link" href="ThunarxProviderPlugin.html" title="ThunarxProviderPlugin"><span class="type">ThunarxProviderPlugin</span></a> *plugin</code></em>);</pre>
<p>Determines whether the application is allowed to unload <em class="parameter"><code>plugin</code></em>
from memory when no longer needed and reload it on demand. If
<code class="literal">FALSE</code> is returned, then the application may unload <em class="parameter"><code>plugin</code></em>
, else
if <code class="literal">TRUE</code> is returned the application will take care that <em class="parameter"><code>plugin</code></em>
is never unloaded from memory during the lifetime of the application.</p>
<div class="refsect3">
<a name="thunarx-provider-plugin-get-resident.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>plugin</p></td>
<td class="parameter_description"><p>a <a class="link" href="ThunarxProviderPlugin.html" title="ThunarxProviderPlugin"><span class="type">ThunarxProviderPlugin</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="thunarx-provider-plugin-get-resident.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if <em class="parameter"><code>plugin</code></em>
will be kept in memory once loaded
for the first time.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="thunarx-provider-plugin-set-resident"></a><h3>thunarx_provider_plugin_set_resident ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
thunarx_provider_plugin_set_resident (<em class="parameter"><code><a class="link" href="ThunarxProviderPlugin.html" title="ThunarxProviderPlugin"><span class="type">ThunarxProviderPlugin</span></a> *plugin</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> resident</code></em>);</pre>
<p>This method is used to instruct the application that <em class="parameter"><code>plugin</code></em>
must be
kept in memory during the lifetime of the application. The default
is to allow the application to unload <em class="parameter"><code>plugin</code></em>
from the memory when
no longer needed. If this method is invoked with a <em class="parameter"><code>resident</code></em>
value
of <code class="literal">TRUE</code> then the application will never try to unload <em class="parameter"><code>plugin</code></em>
.</p>
<p>This method has no effect unless called from the
<code class="literal">thunar_extension_initialize</code> method of the <em class="parameter"><code>plugin</code></em>
.</p>
<div class="refsect3">
<a name="thunarx-provider-plugin-set-resident.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>plugin</p></td>
<td class="parameter_description"><p>a <a class="link" href="ThunarxProviderPlugin.html" title="ThunarxProviderPlugin"><span class="type">ThunarxProviderPlugin</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>resident</p></td>
<td class="parameter_description"><p><code class="literal">TRUE</code> to make <em class="parameter"><code>plugin</code></em>
resident in memory.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="thunarx-provider-plugin-register-type"></a><h3>thunarx_provider_plugin_register_type ()</h3>
<pre class="programlisting"><span class="returnvalue">GType</span>
thunarx_provider_plugin_register_type (<em class="parameter"><code><a class="link" href="ThunarxProviderPlugin.html" title="ThunarxProviderPlugin"><span class="type">ThunarxProviderPlugin</span></a> *plugin</code></em>,
<em class="parameter"><code><span class="type">GType</span> type_parent</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *type_name</code></em>,
<em class="parameter"><code>const <span class="type">GTypeInfo</span> *type_info</code></em>,
<em class="parameter"><code><span class="type">GTypeFlags</span> type_flags</code></em>);</pre>
<p>Looks up or registers a type that is implemented with a particular type <em class="parameter"><code>plugin</code></em>
. If a type with name <em class="parameter"><code>type_name</code></em>
was previously registered, the <span class="type">GType</span> identifier for the type is returned, otherwise the type is newly registered,
and the resulting <span class="type">GType</span> identifier returned.</p>
<p>When reregistering a type (typically because a module is unloaded then reloaded, and reinitialized), module and
<em class="parameter"><code>type_parent</code></em>
must be the same as they were previously.</p>
<div class="refsect3">
<a name="thunarx-provider-plugin-register-type.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>plugin</p></td>
<td class="parameter_description"><p>a <a class="link" href="ThunarxProviderPlugin.html" title="ThunarxProviderPlugin"><span class="type">ThunarxProviderPlugin</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type_parent</p></td>
<td class="parameter_description"><p>the type for the parent class.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type_name</p></td>
<td class="parameter_description"><p>name for the type.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type_info</p></td>
<td class="parameter_description"><p>type information structure.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type_flags</p></td>
<td class="parameter_description"><p>flags field providing details about the type.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="thunarx-provider-plugin-register-type.returns"></a><h4>Returns</h4>
<p> the new or existing type id.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="thunarx-provider-plugin-add-interface"></a><h3>thunarx_provider_plugin_add_interface ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
thunarx_provider_plugin_add_interface (<em class="parameter"><code><a class="link" href="ThunarxProviderPlugin.html" title="ThunarxProviderPlugin"><span class="type">ThunarxProviderPlugin</span></a> *plugin</code></em>,
<em class="parameter"><code><span class="type">GType</span> instance_type</code></em>,
<em class="parameter"><code><span class="type">GType</span> interface_type</code></em>,
<em class="parameter"><code>const <span class="type">GInterfaceInfo</span> *interface_info</code></em>);</pre>
<p>Registers an additional interface for a type, whose interface lives in the given type <em class="parameter"><code>plugin</code></em>
.
If the interface was already registered for the type in this <em class="parameter"><code>plugin</code></em>
, nothing will be done.</p>
<p>As long as any instances of the type exist, the type <em class="parameter"><code>plugin</code></em>
will not be unloaded.</p>
<div class="refsect3">
<a name="thunarx-provider-plugin-add-interface.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>plugin</p></td>
<td class="parameter_description"><p>a <a class="link" href="ThunarxProviderPlugin.html" title="ThunarxProviderPlugin"><span class="type">ThunarxProviderPlugin</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>instance_type</p></td>
<td class="parameter_description"><p>type to which to add the interface.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>interface_type</p></td>
<td class="parameter_description"><p>interface type to add.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>interface_info</p></td>
<td class="parameter_description"><p>type information structure.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="thunarx-provider-plugin-register-enum"></a><h3>thunarx_provider_plugin_register_enum ()</h3>
<pre class="programlisting"><span class="returnvalue">GType</span>
thunarx_provider_plugin_register_enum (<em class="parameter"><code><a class="link" href="ThunarxProviderPlugin.html" title="ThunarxProviderPlugin"><span class="type">ThunarxProviderPlugin</span></a> *plugin</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code>const <span class="type">GEnumValue</span> *const_static_values</code></em>);</pre>
<p>Looks up or registers an enumeration that is implemented with a particular type <em class="parameter"><code>plugin</code></em>
. If a type
with name <em class="parameter"><code>name</code></em>
was previously registered, the <span class="type">GType</span> identifier for the type is returned,
otherwise the type is newly registered, and the resulting <span class="type">GType</span> identifier returned.</p>
<p>As long as any instances of the type exist, the type <em class="parameter"><code>plugin</code></em>
will not be unloaded.</p>
<div class="refsect3">
<a name="thunarx-provider-plugin-register-enum.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>plugin</p></td>
<td class="parameter_description"><p>a <a class="link" href="ThunarxProviderPlugin.html" title="ThunarxProviderPlugin"><span class="type">ThunarxProviderPlugin</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>the name for the type.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>const_static_values</p></td>
<td class="parameter_description"><p>an array of <span class="type">GEnumValue</span> structs for the possible enumeration values.
The array is terminated by a struct with all members being <code class="literal">0</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="thunarx-provider-plugin-register-enum.returns"></a><h4>Returns</h4>
<p> the new or existing type id.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="thunarx-provider-plugin-register-flags"></a><h3>thunarx_provider_plugin_register_flags ()</h3>
<pre class="programlisting"><span class="returnvalue">GType</span>
thunarx_provider_plugin_register_flags
(<em class="parameter"><code><a class="link" href="ThunarxProviderPlugin.html" title="ThunarxProviderPlugin"><span class="type">ThunarxProviderPlugin</span></a> *plugin</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code>const <span class="type">GFlagsValue</span> *const_static_values</code></em>);</pre>
<p>Looks up or registers a flags type that is implemented with a particular type <em class="parameter"><code>plugin</code></em>
. If a type with name
qname was previously registered, the <span class="type">GType</span> identifier for the type is returned, otherwise the type is newly
registered, and the resulting <span class="type">GType</span> identifier returned.</p>
<p>As long as any instances of the type exist, the type <em class="parameter"><code>plugin</code></em>
will not be unloaded.</p>
<div class="refsect3">
<a name="thunarx-provider-plugin-register-flags.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>plugin</p></td>
<td class="parameter_description"><p>a <a class="link" href="ThunarxProviderPlugin.html" title="ThunarxProviderPlugin"><span class="type">ThunarxProviderPlugin</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>name for the type.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>const_static_values</p></td>
<td class="parameter_description"><p>an array of <span class="type">GFlagsValue</span> structs for the possible flags values.
The array is terminated by a struct with all members being <code class="literal">0</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="thunarx-provider-plugin-register-flags.returns"></a><h4>Returns</h4>
<p> the new or existing type id.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="THUNARX-DEFINE-TYPE:CAPS"></a><h3>THUNARX_DEFINE_TYPE()</h3>
<pre class="programlisting">#define THUNARX_DEFINE_TYPE(TN, t_n, T_P) THUNARX_DEFINE_TYPE_EXTENDED (TN, t_n, T_P, 0, {})
</pre>
</div>
<hr>
<div class="refsect2">
<a name="THUNARX-DEFINE-TYPE-WITH-CODE:CAPS"></a><h3>THUNARX_DEFINE_TYPE_WITH_CODE()</h3>
<pre class="programlisting">#define THUNARX_DEFINE_TYPE_WITH_CODE(TN, t_n, T_P, _C_) THUNARX_DEFINE_TYPE_EXTENDED (TN, t_n, T_P, 0, _C_)
</pre>
</div>
<hr>
<div class="refsect2">
<a name="THUNARX-DEFINE-ABSTRACT-TYPE:CAPS"></a><h3>THUNARX_DEFINE_ABSTRACT_TYPE()</h3>
<pre class="programlisting">#define THUNARX_DEFINE_ABSTRACT_TYPE(TN, t_n, T_P) THUNARX_DEFINE_TYPE_EXTENDED (TN, t_n, T_P, G_TYPE_FLAG_ABSTRACT, {})
</pre>
</div>
<hr>
<div class="refsect2">
<a name="THUNARX-DEFINE-ABSTRACT-TYPE-WITH-CODE:CAPS"></a><h3>THUNARX_DEFINE_ABSTRACT_TYPE_WITH_CODE()</h3>
<pre class="programlisting">#define THUNARX_DEFINE_ABSTRACT_TYPE_WITH_CODE(TN, t_n, T_P, _C_) THUNARX_DEFINE_TYPE_EXTENDED (TN, t_n, T_P, G_TYPE_FLAG_ABSTRACT, _C_)
</pre>
</div>
<hr>
<div class="refsect2">
<a name="THUNARX-DEFINE-TYPE-EXTENDED:CAPS"></a><h3>THUNARX_DEFINE_TYPE_EXTENDED()</h3>
<pre class="programlisting">#define THUNARX_DEFINE_TYPE_EXTENDED(TypeName, type_name, TYPE_PARENT, flags, CODE)</pre>
</div>
<hr>
<div class="refsect2">
<a name="THUNARX-IMPLEMENT-INTERFACE:CAPS"></a><h3>THUNARX_IMPLEMENT_INTERFACE()</h3>
<pre class="programlisting">#define THUNARX_IMPLEMENT_INTERFACE(TYPE_IFACE, iface_init)</pre>
</div>
</div>
<div class="refsect1">
<a name="ThunarxProviderPlugin.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ThunarxProviderPlugin-struct"></a><h3>ThunarxProviderPlugin</h3>
<pre class="programlisting">typedef struct _ThunarxProviderPlugin ThunarxProviderPlugin;</pre>
</div>
<hr>
<div class="refsect2">
<a name="ThunarxProviderPluginIface"></a><h3>struct ThunarxProviderPluginIface</h3>
<pre class="programlisting">struct ThunarxProviderPluginIface {
gboolean (*get_resident) (const ThunarxProviderPlugin *plugin);
void (*set_resident) (ThunarxProviderPlugin *plugin,
gboolean resident);
GType (*register_type) (ThunarxProviderPlugin *plugin,
GType type_parent,
const gchar *type_name,
const GTypeInfo *type_info,
GTypeFlags type_flags);
void (*add_interface) (ThunarxProviderPlugin *plugin,
GType instance_type,
GType interface_type,
const GInterfaceInfo *interface_info);
GType (*register_enum) (ThunarxProviderPlugin *plugin,
const gchar *name,
const GEnumValue *const_static_values);
GType (*register_flags) (ThunarxProviderPlugin *plugin,
const gchar *name,
const GFlagsValue *const_static_values);
};
</pre>
<p>Interface with virtual methods implemented by the file manager and
accessible from the extensions.</p>
<div class="refsect3">
<a name="ThunarxProviderPluginIface.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ThunarxProviderPluginIface.get-resident"></a>get_resident</code></em> ()</p></td>
<td class="struct_member_description"><p>see <a class="link" href="ThunarxProviderPlugin.html#thunarx-provider-plugin-get-resident" title="thunarx_provider_plugin_get_resident ()"><code class="function">thunarx_provider_plugin_get_resident()</code></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ThunarxProviderPluginIface.set-resident"></a>set_resident</code></em> ()</p></td>
<td class="struct_member_description"><p>see <a class="link" href="ThunarxProviderPlugin.html#thunarx-provider-plugin-set-resident" title="thunarx_provider_plugin_set_resident ()"><code class="function">thunarx_provider_plugin_set_resident()</code></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ThunarxProviderPluginIface.register-type"></a>register_type</code></em> ()</p></td>
<td class="struct_member_description"><p>see <a class="link" href="ThunarxProviderPlugin.html#thunarx-provider-plugin-register-type" title="thunarx_provider_plugin_register_type ()"><code class="function">thunarx_provider_plugin_register_type()</code></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ThunarxProviderPluginIface.add-interface"></a>add_interface</code></em> ()</p></td>
<td class="struct_member_description"><p>see <a class="link" href="ThunarxProviderPlugin.html#thunarx-provider-plugin-add-interface" title="thunarx_provider_plugin_add_interface ()"><code class="function">thunarx_provider_plugin_add_interface()</code></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ThunarxProviderPluginIface.register-enum"></a>register_enum</code></em> ()</p></td>
<td class="struct_member_description"><p>see <a class="link" href="ThunarxProviderPlugin.html#thunarx-provider-plugin-register-enum" title="thunarx_provider_plugin_register_enum ()"><code class="function">thunarx_provider_plugin_register_enum()</code></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ThunarxProviderPluginIface.register-flags"></a>register_flags</code></em> ()</p></td>
<td class="struct_member_description"><p>see <a class="link" href="ThunarxProviderPlugin.html#thunarx-provider-plugin-register-flags" title="thunarx_provider_plugin_register_flags ()"><code class="function">thunarx_provider_plugin_register_flags()</code></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="ThunarxProviderPlugin.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="ThunarxProviderPlugin--resident"></a><h3>The <code class="literal">“resident”</code> property</h3>
<pre class="programlisting"> “resident” <span class="type">gboolean</span></pre>
<p>Tells whether a plugin must reside in memory once loaded for
the first time. See <a class="link" href="ThunarxProviderPlugin.html#thunarx-provider-plugin-get-resident" title="thunarx_provider_plugin_get_resident ()"><code class="function">thunarx_provider_plugin_get_resident()</code></a> and
<a class="link" href="ThunarxProviderPlugin.html#thunarx-provider-plugin-set-resident" title="thunarx_provider_plugin_set_resident ()"><code class="function">thunarx_provider_plugin_set_resident()</code></a> for more details.</p>
<p>Owner: ThunarxProviderPlugin</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.34.0</div>
</body>
</html>
|
