File: filemanager-actions-FMAIIOProvider.html

package info (click to toggle)
filemanager-actions 3.4-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 27,428 kB
  • sloc: ansic: 48,857; xml: 17,767; sh: 4,662; makefile: 1,375; lisp: 9
file content (794 lines) | stat: -rw-r--r-- 33,757 bytes parent folder | download
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
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>FMAIIOProvider: <span class="productname">FileManager-Actions</span>™ Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="FileManager-Actions™ Reference Manual">
<link rel="up" href="ch03.html" title="Public extension interfaces">
<link rel="prev" href="ch03.html" title="Public extension interfaces">
<link rel="next" href="filemanager-actions-FMAIImporter.html" title="FMAIImporter">
<meta name="generator" content="GTK-Doc V1.25 (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="#filemanager-actions-FMAIIOProvider.description" class="shortcut">Description</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="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch03.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="filemanager-actions-FMAIImporter.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="filemanager-actions-FMAIIOProvider"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="filemanager-actions-FMAIIOProvider.top_of_page"></a>FMAIIOProvider</span></h2>
<p>FMAIIOProvider — The I/O Provider Interface</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="filemanager-actions-FMAIIOProvider.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="filemanager-actions-FMAIIOProvider.html#FMA-IIO-PROVIDER:CAPS" title="FMA_IIO_PROVIDER()">FMA_IIO_PROVIDER</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="filemanager-actions-FMAIIOProvider.html#FMA-IS-IIO-PROVIDER:CAPS" title="FMA_IS_IIO_PROVIDER()">FMA_IS_IIO_PROVIDER</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="filemanager-actions-FMAIIOProvider.html#FMA-IIO-PROVIDER-GET-INTERFACE:CAPS" title="FMA_IIO_PROVIDER_GET_INTERFACE()">FMA_IIO_PROVIDER_GET_INTERFACE</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="filemanager-actions-FMAIIOProvider.html#fma-iio-provider-item-changed" title="fma_iio_provider_item_changed ()">fma_iio_provider_item_changed</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="filemanager-actions-FMAIIOProvider.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="filemanager-actions-FMAIIOProvider.html#FMA-TYPE-IIO-PROVIDER:CAPS" title="FMA_TYPE_IIO_PROVIDER">FMA_TYPE_IIO_PROVIDER</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="filemanager-actions-FMAIIOProvider.html#FMAIIOProvider" title="FMAIIOProvider">FMAIIOProvider</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="filemanager-actions-FMAIIOProvider.html#FMAIIOProviderInterface" title="FMAIIOProviderInterface">FMAIIOProviderInterface</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="filemanager-actions-FMAIIOProvider.html#FMAIIOProviderWritabilityStatus" title="enum FMAIIOProviderWritabilityStatus">FMAIIOProviderWritabilityStatus</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="filemanager-actions-FMAIIOProvider.html#FMAIIOProviderOperationStatus" title="enum FMAIIOProviderOperationStatus">FMAIIOProviderOperationStatus</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="filemanager-actions-FMAIIOProvider.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;filemanager-actions/fma-iio-provider.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="filemanager-actions-FMAIIOProvider.description"></a><h2>Description</h2>
<p>The <a class="link" href="filemanager-actions-FMAIIOProvider.html#FMAIIOProvider" title="FMAIIOProvider"><span class="type">FMAIIOProvider</span></a> interface is defined in order to let both <span class="productname">FileManager-Actions</span>™
internal and user-provided external plugins provide read and write accesses
to their own private storage subsystem.</p>
<p><span class="productname">FileManager-Actions</span>™ core does not provide by itself input/output code. Instead,
it entirely relies on input/output facilities provided by implementations
of this interface.</p>
<p><span class="productname">FileManager-Actions</span>™ is bundled with several I/O providers.
Since version 3, the <code class="literal">io-desktop</code> I/O provider, which
implements the</p>
<a class="ulink" href="http://www.filemanager-actions.org/?q=node/377/" target="_top">DES-EMA</a><p>specification, is the preferred way of storing (and sharing) items.</p>
<p>The <a class="link" href="filemanager-actions-FMAIIOProvider.html#FMAIIOProvider" title="FMAIIOProvider"><span class="type">FMAIIOProvider</span></a> interface provides three types of services:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><b>
    loading items
   . </b>
    Loading items is used both by the file manager plugins, by the
    <span class="productname">FileManager-Actions Configuration Tool</span>™ program, and by the command-line utilities.
   </p></li>
<li class="listitem"><p><b>
    creating, updating or deleting items
   . </b>
    Updating items is a feature only used by the <span class="productname">FileManager-Actions Configuration Tool</span>™ program and
    by some command-line utilities.
   </p></li>
<li class="listitem">
<p><b>
    informing <span class="productname">FileManager-Actions</span>™ of external modifications
   . </b>
    The I/O provider should inform <span class="productname">FileManager-Actions</span>™ when an item happens to
    have been modified in the underlying storage subsystem.
   </p>
<p>
   This feature is only used by the file manager plugins and by the
   <span class="productname">FileManager-Actions Configuration Tool</span>™ program.
  </p>
<p>
   The <a class="link" href="filemanager-actions-FMAIIOProvider.html#FMAIIOProvider" title="FMAIIOProvider"><span class="type">FMAIIOProvider</span></a> interface does not define specific monitoring
   methods (but you can also take a glance at <a class="link" href="filemanager-actions-FMATimeout.html#FMATimeout" title="FMATimeout"><span class="type">FMATimeout</span></a> object).
   Instead, it is expected that the I/O provider module takes care
   itself of managing its own monitoring services at
   load/unload time, calling the <a class="link" href="filemanager-actions-FMAIIOProvider.html#fma-iio-provider-item-changed" title="fma_iio_provider_item_changed ()"><code class="function">fma_iio_provider_item_changed()</code></a>
   function when appropriate.
  </p>
</li>
</ul></div>
<p>These services may be fully implemented by the I/O provider itself.
Or, the I/O provider may also prefer to take advantage of the data
factory management (see <a class="link" href="filemanager-actions-FMAIFactoryObject.html#FMAIFactoryObject" title="FMAIFactoryObject"><span class="type">FMAIFactoryObject</span></a> and <a class="link" href="filemanager-actions-FMAIFactoryProvider.html#FMAIFactoryProvider" title="FMAIFactoryProvider"><span class="type">FMAIFactoryProvider</span></a>
interfaces) services.</p>
<div class="refsect2">
<a name="id-1.4.2.6.10"></a><h3>I/O provider identifier</h3>
<p>
  For its own internal needs, <span class="productname">FileManager-Actions</span>™ requires that each I/O provider
  have its own identifier, as an ASCII string.
 </p>
<p>
  In order to avoid any collision, this I/O provider identifier is
  allocated by the <span class="productname">FileManager-Actions</span>™ maintainers team. If you wish develop
  yourself a new I/O provider, and so need a new provider identifier,
  please contact the maintainers (see filemanager-actions.doap at the
  root of the source tree).
 </p>
<p>
  Below is a list of currently allocated I/O provider identifiers.
  This list has been last updated on 2010, Feb. 14th.
 </p>
<div class="table">
<a name="id-1.4.2.6.10.5"></a><p class="title"><b>Table 2. Currently allocated I/O provider identifiers</b></p>
<div class="table-contents"><table summary="Currently allocated I/O provider identifiers" border="1">
<colgroup>
<col class="id">
<col class="label">
<col class="holder">
<col align="center" class="allocated">
</colgroup>
<thead><tr>
<th>Identifier</th>
<th>Name</th>
<th>Holder</th>
<th align="center">Allocated on</th>
<th> </th>
<th> </th>
</tr></thead>
<tbody>
<tr>
<td><code class="literal">all</code></td>
<td>Reserved for <span class="productname">FileManager-Actions</span>™ internal needs</td>
<td>
<span class="productname">FileManager-Actions</span>™</td>
<td align="center">2010-01-28</td>
<td> </td>
<td>current</td>
</tr>
<tr>
<td><code class="literal">na-desktop</code></td>
<td>NA Desktop I/O Provider</td>
<td>
<span class="productname">FileManager-Actions</span>™</td>
<td align="center">2009-12-16</td>
<td>deprecated</td>
<td> </td>
</tr>
<tr>
<td><code class="literal">na-gconf</code></td>
<td>NA GConf I/O Provider</td>
<td>
<span class="productname">FileManager-Actions</span>™</td>
<td align="center">2009-12-16</td>
<td>deprecated</td>
<td> </td>
</tr>
<tr>
<td><code class="literal">na-xml</code></td>
<td>NA XML module</td>
<td>
<span class="productname">FileManager-Actions</span>™</td>
<td align="center">2010-02-14</td>
<td>deprecated</td>
<td> </td>
</tr>
<tr>
<td><code class="literal">io-desktop</code></td>
<td>FMA Desktop I/O Provider</td>
<td>
<span class="productname">FileManager-Actions</span>™</td>
<td align="center">2015- 9-10</td>
<td> </td>
<td>current</td>
</tr>
<tr>
<td><code class="literal">io-gconf</code></td>
<td>FMA GConf I/O Provider</td>
<td>
<span class="productname">FileManager-Actions</span>™</td>
<td align="center">2015- 9-10</td>
<td>deprecated</td>
<td> </td>
</tr>
<tr>
<td><code class="literal">io-xml</code></td>
<td>FMA XML module</td>
<td>
<span class="productname">FileManager-Actions</span>™</td>
<td align="center">2015- 9-10</td>
<td> </td>
<td>current</td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break">
</div>
<hr>
<div class="refsect2">
<a name="id-1.4.2.6.11"></a><h3>Versions historic</h3>
<div class="table">
<a name="id-1.4.2.6.11.2"></a><p class="title"><b>Table 3. Historic of the versions of the <a class="link" href="filemanager-actions-FMAIIOProvider.html#FMAIIOProvider" title="FMAIIOProvider"><span class="type">FMAIIOProvider</span></a> interface</b></p>
<div class="table-contents"><table summary="Historic of the versions of the FMAIIOProvider interface" border="1">
<colgroup>
<col align="center" class="fma-version">
<col align="center" class="api-version">
<col align="center" class="current">
</colgroup>
<thead><tr>
<th align="center">
<span class="productname">FileManager-Actions</span>™ version</th>
<th align="center">
<a class="link" href="filemanager-actions-FMAIIOProvider.html#FMAIIOProvider" title="FMAIIOProvider"><span class="type">FMAIIOProvider</span></a> interface version</th>
<th align="center"> </th>
</tr></thead>
<tbody><tr>
<td align="center">since 2.30</td>
<td align="center">1</td>
<td align="center">current version</td>
</tr></tbody>
</table></div>
</div>
<br class="table-break">
</div>
</div>
<div class="refsect1">
<a name="filemanager-actions-FMAIIOProvider.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="FMA-IIO-PROVIDER:CAPS"></a><h3>FMA_IIO_PROVIDER()</h3>
<pre class="programlisting">#define FMA_IIO_PROVIDER( instance )               ( G_TYPE_CHECK_INSTANCE_CAST( instance, FMA_TYPE_IIO_PROVIDER, FMAIIOProvider ))
</pre>
</div>
<hr>
<div class="refsect2">
<a name="FMA-IS-IIO-PROVIDER:CAPS"></a><h3>FMA_IS_IIO_PROVIDER()</h3>
<pre class="programlisting">#define FMA_IS_IIO_PROVIDER( instance )            ( G_TYPE_CHECK_INSTANCE_TYPE( instance, FMA_TYPE_IIO_PROVIDER ))
</pre>
</div>
<hr>
<div class="refsect2">
<a name="FMA-IIO-PROVIDER-GET-INTERFACE:CAPS"></a><h3>FMA_IIO_PROVIDER_GET_INTERFACE()</h3>
<pre class="programlisting">#define FMA_IIO_PROVIDER_GET_INTERFACE( instance ) ( G_TYPE_INSTANCE_GET_INTERFACE(( instance ), FMA_TYPE_IIO_PROVIDER, FMAIIOProviderInterface ))
</pre>
</div>
<hr>
<div class="refsect2">
<a name="fma-iio-provider-item-changed"></a><h3>fma_iio_provider_item_changed ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
fma_iio_provider_item_changed (<em class="parameter"><code>const <a class="link" href="filemanager-actions-FMAIIOProvider.html#FMAIIOProvider" title="FMAIIOProvider"><span class="type">FMAIIOProvider</span></a> *instance</code></em>);</pre>
<p>Informs <span class="productname">FileManager-Actions</span>™ that this <a class="link" href="filemanager-actions-FMAIIOProvider.html#FMAIIOProvider" title="FMAIIOProvider"><span class="type">FMAIIOProvider</span></a> <em class="parameter"><code>instance</code></em>
 has
detected a modification in at least one of its items (menu
or action).</p>
<p>This function may be triggered for each and every
<a class="link" href="filemanager-actions-FMAObjectItem.html#FMAObjectItem" title="FMAObjectItem"><span class="type">FMAObjectItem</span></a> -derived modified object, and should, at least, be
triggered once for a coherent set of updates.</p>
<p>When receiving this signal, the currently running program may just
want to immediately reload the current list of items, menus and actions
(this is for example what the file manager plugins do); it may also
choose to ask the user if he is willing to reload such a current list
 (and this is the way <span class="productname">FileManager-Actions Configuration Tool</span>™ has chosen to deal with this message).</p>
<p>Note that application FMAPivot/FMAUpdater pivot is typically the
only object connected to this signal. It acts so as a filtering proxy,
re-emitting its own 'items-changed' signal for a whole set of detected
underlying modifications.</p>
<div class="refsect3">
<a name="fma-iio-provider-item-changed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>instance</p></td>
<td class="parameter_description"><p>the calling <a class="link" href="filemanager-actions-FMAIIOProvider.html#FMAIIOProvider" title="FMAIIOProvider"><span class="type">FMAIIOProvider</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-30.html#api-index-2.30">2.30</a></p>
</div>
</div>
<div class="refsect1">
<a name="filemanager-actions-FMAIIOProvider.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="FMA-TYPE-IIO-PROVIDER:CAPS"></a><h3>FMA_TYPE_IIO_PROVIDER</h3>
<pre class="programlisting">#define FMA_TYPE_IIO_PROVIDER                      ( fma_iio_provider_get_type())
</pre>
</div>
<hr>
<div class="refsect2">
<a name="FMAIIOProvider"></a><h3>FMAIIOProvider</h3>
<pre class="programlisting">typedef struct _FMAIIOProvider FMAIIOProvider;</pre>
</div>
<hr>
<div class="refsect2">
<a name="FMAIIOProviderInterface"></a><h3>FMAIIOProviderInterface</h3>
<pre class="programlisting">typedef struct {
	/**
	 * get_version:
	 * @instance: the FMAIIOProvider provider.
	 *
	 * FileManager-Actions calls this method each time it needs to know
	 * which version of this interface the plugin implements.
	 *
	 * If this method is not implemented by the plugin,
	 * FileManager-Actions considers that the plugin only implements
	 * the version 1 of the FMAIIOProvider interface.
	 *
	 * Return value: if implemented, this method must return the version
	 * number of this interface the I/O provider is supporting.
	 *
	 * Defaults to 1.
	 *
	 * Since: 2.30
	 */
	guint    ( *get_version )        ( const FMAIIOProvider *instance );

	/**
	 * get_id:
	 * @instance: the FMAIIOProvider provider.
	 *
	 * The I/O provider must implement this method.
	 *
	 * Return value: the implementation must return the internal identifier
	 * of the I/O provider, as a newly allocated string which will be g_free()
	 * by the caller.
	 *
	 * Since: 2.30
	 */
	gchar *  ( *get_id )             ( const FMAIIOProvider *instance );

	/**
	 * get_name:
	 * @instance: the FMAIIOProvider provider.
	 *
	 * Return value: if implemented, this method must return the display
	 * name of the I/O provider, as a newly allocated string which will be
	 * g_free() by the caller.
	 *
	 * This may be the name of the module itself, but this also may be a
	 * special name the modules gives to this interface.
	 *
	 * Defaults to an empty string.
	 *
	 * Since: 2.30
	 */
	gchar *  ( *get_name )           ( const FMAIIOProvider *instance );

	/**
	 * read_items:
	 * @instance: the FMAIIOProvider provider.
	 * @messages: a pointer to a GSList list of strings; the provider
	 *  may append messages to this list, but shouldn't reinitialize it.
	 *
	 * Reads the whole items list from the specified I/O provider.
	 *
	 * The I/O provider should implement this method, but if it doesn't,
	 * then this greatly lowerize the interest of this I/O provider (!).
	 *
	 * Return value: if implemented, this method must return a unordered
	 * flat GList of FMAObjectItem-derived objects (menus or actions);
	 * the actions embed their own profiles.
	 *
	 * Defaults to NULL list.
	 *
	 * Since: 2.30
	 */
	GList *  ( *read_items )         ( const FMAIIOProvider *instance,
											GSList **messages );

	/**
	 * is_willing_to_write:
	 * @instance: the FMAIIOProvider provider.
	 *
	 * The 'willing_to_write' property is intrinsic to the I/O provider.
	 * It is not supposed to make any assumption on the environment it is
	 * currently running on.
	 * This property just says that the developer/maintainer has released
	 * the needed code in order to update/create/delete FMAObjectItem-derived
	 * objects.
	 *
	 * Note that even if this property is TRUE, there is yet many
	 * reasons for not being able to update/delete existing items or
	 * create new ones (see e.g. is_able_to_write() method below).
	 *
	 * Return value: if implemented, this method must return a boolean
	 * value, whose purpose is to let know to FileManager-Actions whether
	 * this I/O provider is, or not, willing to write.
	 *
	 * Defaults to FALSE.
	 *
	 * Since: 2.30
	 */
	gboolean ( *is_willing_to_write )( const FMAIIOProvider *instance );

	/**
	 * is_able_to_write:
	 * @instance: the FMAIIOProvider provider.
	 *
	 * The 'able_to_write' property is a runtime one.
	 * When returning TRUE, the I/O provider insures that it has
	 * successfully checked that it was able to write some things
	 * down to its storage subsystem(s).
	 *
	 * The 'able_to_write' property is independent of the
	 * 'willing_to_write' above, though it is only checked if the
	 * I/O provider is actually willing to write.
	 *
	 * This condition is only relevant when trying to define new items,
	 * to determine if a willing-to provider is actually able to do write
	 * operations. It it not relevant for updating/deleting already
	 * existing items as they have already checked their own runtime
	 * writability status when read from the storage subsystems.
	 *
	 * Note that even if this property is TRUE, there is yet many
	 * reasons for not being able to update/delete existing items or
	 * create new ones (see e.g. 'locked' user preference key).
	 *
	 * Return value: if implemented, this method must return a boolean
	 * value, whose purpose is to let know to FileManager-Actions whether
	 * this I/O provider is eventually able to write.
	 *
	 * Defaults to FALSE.
	 *
	 * Since: 2.30
	 */
	gboolean ( *is_able_to_write )   ( const FMAIIOProvider *instance );

	/**
	 * write_item:
	 * @instance: the FMAIIOProvider provider.
	 * @item: a FMAObjectItem-derived item, menu or action.
	 * @messages: a pointer to a GSList list of strings; the provider
	 *  may append messages to this list, but shouldn't reinitialize it.
	 *
	 * Writes a new @item down to the privat underlying storage subsystem
	 * which happens to be managed by the I/O provider.
	 *
	 * There is no update_item function; it is the responsibility
	 * of the provider to delete the previous version of an item before
	 * actually writing the new one.
	 *
	 * The I/O provider should implement this method, or return
	 * FALSE in is_willing_to_write() method above.
	 *
	 * Return value: IIO_PROVIDER_CODE_OK if the write operation
	 * was successful, or another code depending of the detected error.
	 *
	 * Since: 2.30
	 */
	guint    ( *write_item )         ( const FMAIIOProvider *instance,
											const FMAObjectItem *item,
											GSList **messages );

	/**
	 * delete_item:
	 * @instance: the FMAIIOProvider provider.
	 * @item: a FMAObjectItem-derived item, menu or action.
	 * @messages: a pointer to a GSList list of strings; the provider
	 *  may append messages to this list, but shouldn't reinitialize it.
	 *
	 * Deletes an existing @item from the I/O subsystem.
	 *
	 * The I/O provider should implement this method, or return
	 * FALSE in is_willing_to_write() method above.
	 *
	 * Return value: IIO_PROVIDER_CODE_OK if the delete operation was
	 * successful, or another code depending of the detected error.
	 *
	 * Since: 2.30
	 */
	guint    ( *delete_item )        ( const FMAIIOProvider *instance,
											const FMAObjectItem *item,
											GSList **messages );

	/**
	 * duplicate_data:
	 * @instance: the FMAIIOProvider provider.
	 * @dest: a FMAObjectItem-derived item, menu or action.
	 * @source: a FMAObjectItem-derived item, menu or action.
	 * @messages: a pointer to a GSList list of strings; the provider
	 *  may append messages to this list, but shouldn't reinitialize it.
	 *
	 * FileManager-Actions typically calls this method while duplicating
	 * a FMAObjectItem-derived object, in order to let the I/O provider
	 * duplicates itself specific data (if any) it may have set on
	 * @source object.
	 *
	 * Note that this does not duplicate in any way any
	 * FMAObjectItem-derived object. We are just dealing here with
	 * the provider-specific data which may have been attached to
	 * the FMAObjectItem-derived object.
	 *
	 * Return value: IIO_PROVIDER_CODE_OK if the duplicate operation
	 * was successful, or another code depending of the detected error.
	 *
	 * Since: 2.30
	 */
	guint    ( *duplicate_data )     ( const FMAIIOProvider *instance,
											FMAObjectItem *dest,
											const FMAObjectItem *source,
											GSList **messages );
} FMAIIOProviderInterface;
</pre>
<p>This defines the methods that a <a class="link" href="filemanager-actions-FMAIIOProvider.html#FMAIIOProvider" title="FMAIIOProvider"><span class="type">FMAIIOProvider</span></a> may, should, or must
implement.</p>
<div class="refsect3">
<a name="FMAIIOProviderInterface.members"></a><h4>Members</h4>
<div class="informaltable"><table 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="FMAIIOProviderInterface.get-version"></a>get_version</code></em> ()</p></td>
<td class="struct_member_description"><p>[should] returns the version of this interface that the
plugin implements.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="FMAIIOProviderInterface.get-id"></a>get_id</code></em> ()</p></td>
<td class="struct_member_description"><p>[must]   returns the internal id of the plugin.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="FMAIIOProviderInterface.get-name"></a>get_name</code></em> ()</p></td>
<td class="struct_member_description"><p>[should] returns the public name of the plugin.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="FMAIIOProviderInterface.read-items"></a>read_items</code></em> ()</p></td>
<td class="struct_member_description"><p>[should] reads items.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="FMAIIOProviderInterface.is-willing-to-write"></a>is_willing_to_write</code></em> ()</p></td>
<td class="struct_member_description"><p>[should] asks the plugin whether it is willing to write.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="FMAIIOProviderInterface.is-able-to-write"></a>is_able_to_write</code></em> ()</p></td>
<td class="struct_member_description"><p>[should] asks the plugin whether it is able to write.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="FMAIIOProviderInterface.write-item"></a>write_item</code></em> ()</p></td>
<td class="struct_member_description"><p>[should] writes an item.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="FMAIIOProviderInterface.delete-item"></a>delete_item</code></em> ()</p></td>
<td class="struct_member_description"><p>[should] deletes an item.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="FMAIIOProviderInterface.duplicate-data"></a>duplicate_data</code></em> ()</p></td>
<td class="struct_member_description"><p>[may]    let the I/O provider duplicates its specific data.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="FMAIIOProviderWritabilityStatus"></a><h3>enum FMAIIOProviderWritabilityStatus</h3>
<p>The reasons for which an item may not be writable.</p>
<p>Not all reasons are to be managed at the I/O provider level.
Some are to be used only internally from <span class="productname">FileManager-Actions</span>™ programs.</p>
<div class="refsect3">
<a name="FMAIIOProviderWritabilityStatus.members"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="IIO-PROVIDER-STATUS-WRITABLE:CAPS"></a>IIO_PROVIDER_STATUS_WRITABLE</p></td>
<td class="enum_member_description">
<p>item and i/o provider are writable.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="IIO-PROVIDER-STATUS-UNAVAILABLE:CAPS"></a>IIO_PROVIDER_STATUS_UNAVAILABLE</p></td>
<td class="enum_member_description">
<p>unavailable i/o provider.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="IIO-PROVIDER-STATUS-INCOMPLETE-API:CAPS"></a>IIO_PROVIDER_STATUS_INCOMPLETE_API</p></td>
<td class="enum_member_description">
<p>i/o provider has an incomplete write api.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="IIO-PROVIDER-STATUS-NOT-WILLING-TO:CAPS"></a>IIO_PROVIDER_STATUS_NOT_WILLING_TO</p></td>
<td class="enum_member_description">
<p>i/o provider is not willing to write.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="IIO-PROVIDER-STATUS-NOT-ABLE-TO:CAPS"></a>IIO_PROVIDER_STATUS_NOT_ABLE_TO</p></td>
<td class="enum_member_description">
<p>i/o provider is not able to write.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="IIO-PROVIDER-STATUS-LOCKED-BY-ADMIN:CAPS"></a>IIO_PROVIDER_STATUS_LOCKED_BY_ADMIN</p></td>
<td class="enum_member_description">
<p>i/o provider has been locked by the administrator.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="IIO-PROVIDER-STATUS-LOCKED-BY-USER:CAPS"></a>IIO_PROVIDER_STATUS_LOCKED_BY_USER</p></td>
<td class="enum_member_description">
<p>i/o provider has been locked by the user.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="IIO-PROVIDER-STATUS-ITEM-READONLY:CAPS"></a>IIO_PROVIDER_STATUS_ITEM_READONLY</p></td>
<td class="enum_member_description">
<p>item is read-only.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="IIO-PROVIDER-STATUS-NO-PROVIDER-FOUND:CAPS"></a>IIO_PROVIDER_STATUS_NO_PROVIDER_FOUND</p></td>
<td class="enum_member_description">
<p>no writable i/o provider found.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="IIO-PROVIDER-STATUS-LEVEL-ZERO:CAPS"></a>IIO_PROVIDER_STATUS_LEVEL_ZERO</p></td>
<td class="enum_member_description">
<p>level zero is not writable.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="IIO-PROVIDER-STATUS-UNDETERMINED:CAPS"></a>IIO_PROVIDER_STATUS_UNDETERMINED</p></td>
<td class="enum_member_description">
<p>unknown reason (and probably a bug).</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="FMAIIOProviderOperationStatus"></a><h3>enum FMAIIOProviderOperationStatus</h3>
<p>The return code of operations.</p>
<div class="refsect3">
<a name="FMAIIOProviderOperationStatus.members"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="IIO-PROVIDER-CODE-OK:CAPS"></a>IIO_PROVIDER_CODE_OK</p></td>
<td class="enum_member_description">
<p>the requested operation has been successful.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="IIO-PROVIDER-CODE-PROGRAM-ERROR:CAPS"></a>IIO_PROVIDER_CODE_PROGRAM_ERROR</p></td>
<td class="enum_member_description">
<p>a program error has been detected;
                                     you should open a bug in</p>
<a class="ulink" href="https://bugzilla.gnome.org/enter_bug.cgi?product=filemanager-actions" target="_top">Bugzilla</a>.
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="IIO-PROVIDER-CODE-NOT-WILLING-TO-RUN:CAPS"></a>IIO_PROVIDER_CODE_NOT_WILLING_TO_RUN</p></td>
<td class="enum_member_description">
<p>the provider is not willing
                                            to do the requested action.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="IIO-PROVIDER-CODE-WRITE-ERROR:CAPS"></a>IIO_PROVIDER_CODE_WRITE_ERROR</p></td>
<td class="enum_member_description">
<p>a write error has been detected.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="IIO-PROVIDER-CODE-DELETE-SCHEMAS-ERROR:CAPS"></a>IIO_PROVIDER_CODE_DELETE_SCHEMAS_ERROR</p></td>
<td class="enum_member_description">
<p>the schemas could not be deleted.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="IIO-PROVIDER-CODE-DELETE-CONFIG-ERROR:CAPS"></a>IIO_PROVIDER_CODE_DELETE_CONFIG_ERROR</p></td>
<td class="enum_member_description">
<p>the configuration could not be deleted.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>