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
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IpatchConverter</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<link rel="home" href="index.html" title="libinstpatch Reference Manual">
<link rel="up" href="ch02.html" title="Utility objects and functions">
<link rel="prev" href="IpatchList.html" title="IpatchList">
<link rel="next" href="IpatchConverterSF2VoiceCache.html" title="IpatchConverterSF2VoiceCache">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="Base objects and functions">
<link rel="chapter" href="ch02.html" title="Utility objects and functions">
<link rel="chapter" href="ch03.html" title="Sample data objects and functions">
<link rel="chapter" href="ch04.html" title="DLS patches">
<link rel="chapter" href="ch05.html" title="SoundFont patches">
<link rel="chapter" href="ch06.html" title="GigaSampler patches">
<link rel="chapter" href="ch07.html" title="Virtual banks">
<link rel="chapter" href="object-tree.html" title="Object Hierarchy">
<link rel="index" href="api-index-full.html" title="API Index">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="IpatchList.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libinstpatch Reference Manual</th>
<td><a accesskey="n" href="IpatchConverterSF2VoiceCache.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#IpatchConverter.synopsis" class="shortcut">Top</a>
|
<a href="#IpatchConverter.description" class="shortcut">Description</a>
|
<a href="#IpatchConverter.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#IpatchConverter.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry" title="IpatchConverter">
<a name="IpatchConverter"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="IpatchConverter.top_of_page"></a>IpatchConverter</span></h2>
<p>IpatchConverter — Base class for object conversion handlers</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="IpatchConverter.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="IpatchConverter.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a
href="../libinstpatch/IpatchConverter.html#IpatchConverter-struct"
>IpatchConverter</a>;
enum <a
href="../libinstpatch/IpatchConverter.html#IpatchConverterLogType"
>IpatchConverterLogType</a>;
#define <a
href="../libinstpatch/IpatchConverter.html#IPATCH-CONVERTER-LOG-TYPE-MASK--CAPS"
>IPATCH_CONVERTER_LOG_TYPE_MASK</a>
#define <a
href="../libinstpatch/IpatchConverter.html#IPATCH-CONVERTER-LOG-MSG-ALLOC--CAPS"
>IPATCH_CONVERTER_LOG_MSG_ALLOC</a>
#define <a
href="../libinstpatch/IpatchConverter.html#IPATCH-CONVERTER-INPUT--CAPS"
>IPATCH_CONVERTER_INPUT</a> (converter)
#define <a
href="../libinstpatch/IpatchConverter.html#IPATCH-CONVERTER-OUTPUT--CAPS"
>IPATCH_CONVERTER_OUTPUT</a> (converter)
enum <a
href="../libinstpatch/IpatchConverter.html#IpatchConverterCount"
>IpatchConverterCount</a>;
enum <a
href="../libinstpatch/IpatchConverter.html#IpatchConverterFlags"
>IpatchConverterFlags</a>;
enum <a
href="../libinstpatch/IpatchConverter.html#IpatchConverterPriority"
>IpatchConverterPriority</a>;
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> <a
href="../libinstpatch/IpatchConverter.html#ipatch-convert-objects"
>ipatch_convert_objects</a> (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *input,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *output,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
>GError</a> **err);
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> * <a
href="../libinstpatch/IpatchConverter.html#ipatch-convert-object-to-type"
>ipatch_convert_object_to_type</a> (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *object,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> type,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
>GError</a> **err);
<a
href="../libinstpatch/IpatchList.html"
>IpatchList</a> * <a
href="../libinstpatch/IpatchConverter.html#ipatch-convert-object-to-type-multi"
>ipatch_convert_object_to_type_multi</a> (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *object,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> type,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
>GError</a> **err);
<a
href="../libinstpatch/IpatchList.html"
>IpatchList</a> * <a
href="../libinstpatch/IpatchConverter.html#ipatch-convert-object-to-type-multi-set"
>ipatch_convert_object_to_type_multi_set</a>
(<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *object,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> type,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
>GError</a> **err,
const char *first_property_name,
...);
<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> * <a
href="../libinstpatch/IpatchConverter.html#ipatch-create-converter"
>ipatch_create_converter</a> (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> src_type,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> dest_type);
void <a
href="../libinstpatch/IpatchConverter.html#ipatch-register-converter-map"
>ipatch_register_converter_map</a> (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> conv_type,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> flags,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> src_type,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> src_match,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint8"
>gint8</a> src_count,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> dest_type,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> dest_match,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint8"
>gint8</a> dest_count);
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> <a
href="../libinstpatch/IpatchConverter.html#ipatch-find-converter"
>ipatch_find_converter</a> (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> src_type,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> dest_type);
IpatchConverterInfo * <a
href="../libinstpatch/IpatchConverter.html#ipatch-lookup-converter-info"
>ipatch_lookup_converter_info</a> (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> conv_type,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> src_type,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> dest_type);
void <a
href="../libinstpatch/IpatchConverter.html#ipatch-converter-add-input"
>ipatch_converter_add_input</a> (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *object);
void <a
href="../libinstpatch/IpatchConverter.html#ipatch-converter-add-output"
>ipatch_converter_add_output</a> (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *object);
void <a
href="../libinstpatch/IpatchConverter.html#ipatch-converter-add-inputs"
>ipatch_converter_add_inputs</a> (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
>GList</a> *objects);
void <a
href="../libinstpatch/IpatchConverter.html#ipatch-converter-add-outputs"
>ipatch_converter_add_outputs</a> (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
>GList</a> *objects);
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> * <a
href="../libinstpatch/IpatchConverter.html#ipatch-converter-get-input"
>ipatch_converter_get_input</a> (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter);
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> * <a
href="../libinstpatch/IpatchConverter.html#ipatch-converter-get-output"
>ipatch_converter_get_output</a> (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter);
<a
href="../libinstpatch/IpatchList.html"
>IpatchList</a> * <a
href="../libinstpatch/IpatchConverter.html#ipatch-converter-get-inputs"
>ipatch_converter_get_inputs</a> (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter);
<a
href="../libinstpatch/IpatchList.html"
>IpatchList</a> * <a
href="../libinstpatch/IpatchConverter.html#ipatch-converter-get-outputs"
>ipatch_converter_get_outputs</a> (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> <a
href="../libinstpatch/IpatchConverter.html#ipatch-converter-verify"
>ipatch_converter_verify</a> (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter,
char **failmsg);
void <a
href="../libinstpatch/IpatchConverter.html#ipatch-converter-init"
>ipatch_converter_init</a> (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> <a
href="../libinstpatch/IpatchConverter.html#ipatch-converter-convert"
>ipatch_converter_convert</a> (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
>GError</a> **err);
void <a
href="../libinstpatch/IpatchConverter.html#ipatch-converter-reset"
>ipatch_converter_reset</a> (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter);
char * <a
href="../libinstpatch/IpatchConverter.html#ipatch-converter-get-notes"
>ipatch_converter_get_notes</a> (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter);
void <a
href="../libinstpatch/IpatchConverter.html#ipatch-converter-log"
>ipatch_converter_log</a> (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *item,
int type,
char *msg);
void <a
href="../libinstpatch/IpatchConverter.html#ipatch-converter-log-printf"
>ipatch_converter_log_printf</a> (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *item,
int type,
const char *fmt,
...);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> <a
href="../libinstpatch/IpatchConverter.html#ipatch-converter-log-next"
>ipatch_converter_log_next</a> (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
>gpointer</a> *pos,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> **item,
int *type,
char **msg);
void <a
href="../libinstpatch/IpatchConverter.html#ipatch-converter-set-link-funcs"
>ipatch_converter_set_link_funcs</a> (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter,
IpatchConverterLinkLookupFunc *link_lookup,
IpatchConverterLinkNotifyFunc *link_notify);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="IpatchConverter.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----IpatchConverter
+----<a
href="../libinstpatch/IpatchConverterSF2VoiceCache.html"
>IpatchConverterSF2VoiceCache</a>
</pre>
</div>
<div class="refsect1" title="Properties">
<a name="IpatchConverter.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a
href="../libinstpatch/IpatchConverter.html#IpatchConverter--progress"
>progress</a>" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"
>gfloat</a> : Read / Write
</pre>
</div>
<div class="refsect1" title="Description">
<a name="IpatchConverter.description"></a><h2>Description</h2>
<p>
A base abstract type for object conversion handlers.</p>
</div>
<div class="refsect1" title="Details">
<a name="IpatchConverter.details"></a><h2>Details</h2>
<div class="refsect2" title="IpatchConverter">
<a name="IpatchConverter-struct"></a><h3>IpatchConverter</h3>
<pre class="programlisting">typedef struct _IpatchConverter IpatchConverter;</pre>
</div>
<hr>
<div class="refsect2" title="enum IpatchConverterLogType">
<a name="IpatchConverterLogType"></a><h3>enum IpatchConverterLogType</h3>
<pre class="programlisting">typedef enum
{
IPATCH_CONVERTER_LOG_RATING, /* log a rating update */
IPATCH_CONVERTER_LOG_INFO, /* informational only */
IPATCH_CONVERTER_LOG_WARN, /* warning */
IPATCH_CONVERTER_LOG_CRITICAL, /* critical (but non fatal) message */
IPATCH_CONVERTER_LOG_FATAL /* fatal error */
} IpatchConverterLogType;
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_CONVERTER_LOG_TYPE_MASK">
<a name="IPATCH-CONVERTER-LOG-TYPE-MASK--CAPS"></a><h3>IPATCH_CONVERTER_LOG_TYPE_MASK</h3>
<pre class="programlisting">#define IPATCH_CONVERTER_LOG_TYPE_MASK 0x0F
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_CONVERTER_LOG_MSG_ALLOC">
<a name="IPATCH-CONVERTER-LOG-MSG-ALLOC--CAPS"></a><h3>IPATCH_CONVERTER_LOG_MSG_ALLOC</h3>
<pre class="programlisting">#define IPATCH_CONVERTER_LOG_MSG_ALLOC 0x80
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_CONVERTER_INPUT()">
<a name="IPATCH-CONVERTER-INPUT--CAPS"></a><h3>IPATCH_CONVERTER_INPUT()</h3>
<pre class="programlisting">#define IPATCH_CONVERTER_INPUT(converter)</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_CONVERTER_OUTPUT()">
<a name="IPATCH-CONVERTER-OUTPUT--CAPS"></a><h3>IPATCH_CONVERTER_OUTPUT()</h3>
<pre class="programlisting">#define IPATCH_CONVERTER_OUTPUT(converter)</pre>
</div>
<hr>
<div class="refsect2" title="enum IpatchConverterCount">
<a name="IpatchConverterCount"></a><h3>enum IpatchConverterCount</h3>
<pre class="programlisting">typedef enum
{
IPATCH_CONVERTER_COUNT_ONE_OR_MORE = -1, /* 1 or more objects */
IPATCH_CONVERTER_COUNT_ZERO_OR_MORE = -2 /* 0 or more objects */
} IpatchConverterCount;
</pre>
</div>
<hr>
<div class="refsect2" title="enum IpatchConverterFlags">
<a name="IpatchConverterFlags"></a><h3>enum IpatchConverterFlags</h3>
<pre class="programlisting">typedef enum
{
IPATCH_CONVERTER_FLAG_SRC_DERIVED = 1 << 8 /* match source derived types */
} IpatchConverterFlags;
</pre>
</div>
<hr>
<div class="refsect2" title="enum IpatchConverterPriority">
<a name="IpatchConverterPriority"></a><h3>enum IpatchConverterPriority</h3>
<pre class="programlisting">typedef enum
{
/* 0 value is an alias for IPATCH_CONVERTER_PRIORITY_DEFAULT */
IPATCH_CONVERTER_PRIORITY_LOWEST = 1,
IPATCH_CONVERTER_PRIORITY_LOW = 25,
IPATCH_CONVERTER_PRIORITY_DEFAULT = 50,
IPATCH_CONVERTER_PRIORITY_HIGH = 75,
IPATCH_CONVERTER_PRIORITY_HIGHEST = 100
} IpatchConverterPriority;
</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_convert_objects ()">
<a name="ipatch-convert-objects"></a><h3>ipatch_convert_objects ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> ipatch_convert_objects (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *input,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *output,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
>GError</a> **err);</pre>
<p>
A convenience function for converting from one object to another. This
function will only work for converters which take exactly one input and
output object.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>input</code></em> :</span></p></td>
<td> Input object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>output</code></em> :</span></p></td>
<td> Output object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
<td> Location to store error info or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> otherwise (in which case <em class="parameter"><code>err</code></em> may be set)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_convert_object_to_type ()">
<a name="ipatch-convert-object-to-type"></a><h3>ipatch_convert_object_to_type ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> * ipatch_convert_object_to_type (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *object,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> type,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
>GError</a> **err);</pre>
<p>
A convenience function to convert an object to another object of a given
type. This function will only work for converters which require 1
input and one or zero outputs. The output object is created as needed
and returned.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td> Object to convert from
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td> Type of object to convert to
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
<td> Location to store error info or <code class="literal">NULL</code> to ignore
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The output object or <code class="literal">NULL</code> on error (in which case <em class="parameter"><code>err</code></em> may be set).
The returned object has a refcount of 1 which the caller owns.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_convert_object_to_type_multi ()">
<a name="ipatch-convert-object-to-type-multi"></a><h3>ipatch_convert_object_to_type_multi ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchList.html"
>IpatchList</a> * ipatch_convert_object_to_type_multi (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *object,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> type,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
>GError</a> **err);</pre>
<p>
A convenience function to convert an object to one or more objects of a given
<em class="parameter"><code>type</code></em>. This function will work for converters which require 1
input and any number of outputs.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td> Object to convert from
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td> Type of object to convert to
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
<td> Location to store error info or <code class="literal">NULL</code> to ignore
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> List of output objects or <code class="literal">NULL</code> on error (in which case <em class="parameter"><code>err</code></em> may be set).
The returned object list has a refcount of 1 which the caller owns.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_convert_object_to_type_multi_set ()">
<a name="ipatch-convert-object-to-type-multi-set"></a><h3>ipatch_convert_object_to_type_multi_set ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchList.html"
>IpatchList</a> * ipatch_convert_object_to_type_multi_set
(<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *object,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> type,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
>GError</a> **err,
const char *first_property_name,
...);</pre>
<p>
A convenience function to convert an object to one or more objects of a given
<em class="parameter"><code>type</code></em>. This function will work for converters which require 1
input and any number of outputs. Like <a
href="../libinstpatch/IpatchConverter.html#ipatch-convert-object-to-type-multi"
><code class="function">ipatch_convert_object_to_type_multi()</code></a>
but allows for properties of the converter to be assigned.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td> Object to convert from
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td> Type of object to convert to
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
<td> Location to store error info or <code class="literal">NULL</code> to ignore
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>first_property_name</code></em> :</span></p></td>
<td> Name of first property to assign or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
<td> First property value followed by property name/value pairs (as per
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-set"
><code class="function">g_object_set()</code></a>) to assign to the resulting converter, terminated with a
<code class="literal">NULL</code> property name.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> List of output objects or <code class="literal">NULL</code> on error (in which case <em class="parameter"><code>err</code></em> may be set).
The returned object list has a refcount of 1 which the caller owns.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_create_converter ()">
<a name="ipatch-create-converter"></a><h3>ipatch_create_converter ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> * ipatch_create_converter (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> src_type,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> dest_type);</pre>
<p>
Create a converter object for converting an object of type <em class="parameter"><code>src_type</code></em> to
<em class="parameter"><code>dest_type</code></em>. A convenience function, since one could use
<a
href="../libinstpatch/IpatchConverter.html#ipatch-find-converter"
><code class="function">ipatch_find_converter()</code></a> and create an instance of the returned type.
See <a
href="../libinstpatch/IpatchConverter.html#ipatch-find-converter"
><code class="function">ipatch_find_converter()</code></a> for more details.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>src_type</code></em> :</span></p></td>
<td> <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> derived source type
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest_type</code></em> :</span></p></td>
<td> <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> derived destination type
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The new converter object with a reference count of 1 which the
caller owns, or <code class="literal">NULL</code> if there is no matching conversion handler type.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_register_converter_map ()">
<a name="ipatch-register-converter-map"></a><h3>ipatch_register_converter_map ()</h3>
<pre class="programlisting">void ipatch_register_converter_map (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> conv_type,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> flags,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> src_type,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> src_match,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint8"
>gint8</a> src_count,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> dest_type,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> dest_match,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint8"
>gint8</a> dest_count);</pre>
<p>
Registers a <a
href="../libinstpatch/IpatchConverter.html"
><span class="type">IpatchConverter</span></a> handler to convert objects of <em class="parameter"><code>src_type</code></em>
to <em class="parameter"><code>dest_type</code></em>.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>conv_type</code></em> :</span></p></td>
<td> <a
href="../libinstpatch/IpatchConverter.html"
><span class="type">IpatchConverter</span></a> derived GType of conversion handler
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td> <a
href="../libinstpatch/IpatchConverter.html#IpatchConverterFlags"
><span class="type">IpatchConverterFlags</span></a> logically ORed with a priority (number from
0 to 100, 0 will use the default). <a
href="../libinstpatch/IpatchConverter.html#IpatchConverterPriority"
><span class="type">IpatchConverterPriority</span></a> defines some
common priorities. Used for overriding other converters for specific types.
If <span class="type">IPATCH_CONVERTER_FLAG_SRC_DERIVED</span> is specified then types which are
derived (children) of <em class="parameter"><code>src_type</code></em> will also match.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>src_type</code></em> :</span></p></td>
<td> Type for source object (GObject derived type or interface type).
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>src_match</code></em> :</span></p></td>
<td> The furthest parent type of <em class="parameter"><code>src_type</code></em> to match (all types in
between are also matched, 0 to match only <em class="parameter"><code>src_type</code></em>).
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>src_count</code></em> :</span></p></td>
<td> Required number of source items (can also be
an <a
href="../libinstpatch/IpatchConverter.html#IpatchConverterCount"
><span class="type">IpatchConverterCount</span></a> value)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest_type</code></em> :</span></p></td>
<td> Type for destination object (GObject derived type or interface type).
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest_match</code></em> :</span></p></td>
<td> The furthest parent type of <em class="parameter"><code>dest_type</code></em> to match (all types in
between are also matched, 0 to match only <em class="parameter"><code>dest_type</code></em>).
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest_count</code></em> :</span></p></td>
<td> Required number of destination items (can also be
an <a
href="../libinstpatch/IpatchConverter.html#IpatchConverterCount"
><span class="type">IpatchConverterCount</span></a> value). This value can be 0 in the case where
no objects should be supplied, but will be instead assigned after
conversion.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_find_converter ()">
<a name="ipatch-find-converter"></a><h3>ipatch_find_converter ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> ipatch_find_converter (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> src_type,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> dest_type);</pre>
<p>
Lookup a conversion handler type for a given <em class="parameter"><code>src_type</code></em> to <em class="parameter"><code>dest_type</code></em>
conversion. In some cases there may be multiple conversion handlers for
the given types, this function only returns the highest priority type.
To get a list of all available converters use <code class="function">ipatch_find_converters()</code>.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>src_type</code></em> :</span></p></td>
<td> <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> derived source type
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest_type</code></em> :</span></p></td>
<td> <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> derived destination type
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> An <a
href="../libinstpatch/IpatchConverter.html"
><span class="type">IpatchConverter</span></a> derived GType of the matching conversion
handler or 0 if no matches.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_lookup_converter_info ()">
<a name="ipatch-lookup-converter-info"></a><h3>ipatch_lookup_converter_info ()</h3>
<pre class="programlisting">IpatchConverterInfo * ipatch_lookup_converter_info (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> conv_type,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> src_type,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> dest_type);</pre>
<p>
Lookup converter map info.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>conv_type</code></em> :</span></p></td>
<td> <a
href="../libinstpatch/IpatchConverter.html"
><span class="type">IpatchConverter</span></a> derived GType to lookup info on (or 0 for wildcard)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>src_type</code></em> :</span></p></td>
<td> Source type of conversion map to lookup (or 0 for default map)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest_type</code></em> :</span></p></td>
<td> Destination type of conversion map (0 if <em class="parameter"><code>src_type</code></em> is 0)
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Converter info structure or <code class="literal">NULL</code> if no match. The returned
pointer is internal and should not be modified or freed.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_converter_add_input ()">
<a name="ipatch-converter-add-input"></a><h3>ipatch_converter_add_input ()</h3>
<pre class="programlisting">void ipatch_converter_add_input (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *object);</pre>
<p>
Add an input object to a converter object.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>converter</code></em> :</span></p></td>
<td> Converter instance
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td> Object to add
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_converter_add_output ()">
<a name="ipatch-converter-add-output"></a><h3>ipatch_converter_add_output ()</h3>
<pre class="programlisting">void ipatch_converter_add_output (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *object);</pre>
<p>
Add an output object to a converter object.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>converter</code></em> :</span></p></td>
<td> Converter instance
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td> Object to add
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_converter_add_inputs ()">
<a name="ipatch-converter-add-inputs"></a><h3>ipatch_converter_add_inputs ()</h3>
<pre class="programlisting">void ipatch_converter_add_inputs (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
>GList</a> *objects);</pre>
<p>
Add a list of input objects to a converter object.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>converter</code></em> :</span></p></td>
<td> Converter instance
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>objects</code></em> :</span></p></td>
<td> List of objects to add
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_converter_add_outputs ()">
<a name="ipatch-converter-add-outputs"></a><h3>ipatch_converter_add_outputs ()</h3>
<pre class="programlisting">void ipatch_converter_add_outputs (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
>GList</a> *objects);</pre>
<p>
Add a list of output objects to a converter object.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>converter</code></em> :</span></p></td>
<td> Converter instance
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>objects</code></em> :</span></p></td>
<td> List of objects to add
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_converter_get_input ()">
<a name="ipatch-converter-get-input"></a><h3>ipatch_converter_get_input ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> * ipatch_converter_get_input (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter);</pre>
<p>
Get a single input object from a converter.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>converter</code></em> :</span></p></td>
<td> Converter instance
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The first input object from a converter or <code class="literal">NULL</code> if
no input objects. The caller owns a reference to the returned
object.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_converter_get_output ()">
<a name="ipatch-converter-get-output"></a><h3>ipatch_converter_get_output ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> * ipatch_converter_get_output (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter);</pre>
<p>
Get a single output object from a converter.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>converter</code></em> :</span></p></td>
<td> Converter instance
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The first output object from a converter or <code class="literal">NULL</code> if
no output objects. The caller owns a reference to the returned
object.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_converter_get_inputs ()">
<a name="ipatch-converter-get-inputs"></a><h3>ipatch_converter_get_inputs ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchList.html"
>IpatchList</a> * ipatch_converter_get_inputs (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter);</pre>
<p>
Get a list of input objects from a converter.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>converter</code></em> :</span></p></td>
<td> Converter instance
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A newly created input object list from a converter or
<code class="literal">NULL</code> if no input objects. The caller owns a reference to the
returned list.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_converter_get_outputs ()">
<a name="ipatch-converter-get-outputs"></a><h3>ipatch_converter_get_outputs ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchList.html"
>IpatchList</a> * ipatch_converter_get_outputs (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter);</pre>
<p>
Get a list of output objects from a converter.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>converter</code></em> :</span></p></td>
<td> Converter instance
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A newly created output object list from a converter or
<code class="literal">NULL</code> if no output objects. The caller owns a reference to the
returned list.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_converter_verify ()">
<a name="ipatch-converter-verify"></a><h3>ipatch_converter_verify ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> ipatch_converter_verify (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter,
char **failmsg);</pre>
<p>
Verifies the settings of a converter object. This is automatically called
before a conversion is done, so it doesn't usually need to be explicitly
called.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>converter</code></em> :</span></p></td>
<td> Converter object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>failmsg</code></em> :</span></p></td>
<td> Location to store a failure message if <em class="parameter"><code>converter</code></em> fails
verification. The stored message should be freed when no longer needed.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">TRUE</code> if <em class="parameter"><code>converter</code></em> passed verification, <code class="literal">FALSE</code> otherwise in which
case an error message may be stored in <em class="parameter"><code>failmsg</code></em>. Remember to free the
message when finished with it.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_converter_init ()">
<a name="ipatch-converter-init"></a><h3>ipatch_converter_init ()</h3>
<pre class="programlisting">void ipatch_converter_init (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter);</pre>
<p>
Allows a converter type to initialize its parameters based on its input
and/or output objects. This function should be called after setting the
input and output objects, but before setting object parameters or
converting. Calling this function is not required, but certain converters
will work more intuitively if it is (an example is an audio sample saver
converter which could initialize the output sample file object format
based on the input sample object format).
</p>
<p>
NOTE: Verification of converter parameters is not done by this routine
so converter types implementing an init method are responsible for their
own verification.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>converter</code></em> :</span></p></td>
<td> Converter object
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_converter_convert ()">
<a name="ipatch-converter-convert"></a><h3>ipatch_converter_convert ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> ipatch_converter_convert (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
>GError</a> **err);</pre>
<p>
Runs the conversion method of a converter object. The <em class="parameter"><code>converter</code></em> object's
conversion paramters are first verified before the conversion is run.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>converter</code></em> :</span></p></td>
<td> Converter object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
<td> Location to store error info or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> otherwise
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_converter_reset ()">
<a name="ipatch-converter-reset"></a><h3>ipatch_converter_reset ()</h3>
<pre class="programlisting">void ipatch_converter_reset (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter);</pre>
<p>
Reset a converter object so it can be re-used.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>converter</code></em> :</span></p></td>
<td> Converter object
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_converter_get_notes ()">
<a name="ipatch-converter-get-notes"></a><h3>ipatch_converter_get_notes ()</h3>
<pre class="programlisting">char * ipatch_converter_get_notes (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter);</pre>
<p>
Get notes about a conversion implementation. These notes could include
things such as information about any loss of information in the conversion
that may occur, etc.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>converter</code></em> :</span></p></td>
<td> Converter object
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Newly allocated and possibly multi-line notes and comments
about a given conversion or <code class="literal">NULL</code> if no notes. Meant for display to
the user. This string should be freed when no longer needed.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_converter_log ()">
<a name="ipatch-converter-log"></a><h3>ipatch_converter_log ()</h3>
<pre class="programlisting">void ipatch_converter_log (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *item,
int type,
char *msg);</pre>
<p>
Logs an entry to a converter log. Usually only used by converter
object handlers.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>converter</code></em> :</span></p></td>
<td> Converter object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> Item the log entry pertains to or <code class="literal">NULL</code> if not item specific
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td> <a
href="../libinstpatch/IpatchConverter.html#IpatchConverterLogType"
><span class="type">IpatchConverterLogType</span></a> and other flags
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>msg</code></em> :</span></p></td>
<td> Message of the log. If message is dynamically allocated then
the <a
href="../libinstpatch/IpatchConverter.html#IPATCH-CONVERTER-LOG-MSG-ALLOC--CAPS"
><span class="type">IPATCH_CONVERTER_LOG_MSG_ALLOC</span></a> flag should be set in <em class="parameter"><code>type</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_converter_log_printf ()">
<a name="ipatch-converter-log-printf"></a><h3>ipatch_converter_log_printf ()</h3>
<pre class="programlisting">void ipatch_converter_log_printf (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *item,
int type,
const char *fmt,
...);</pre>
<p>
Logs a printf style message to a converter log. Usually only used by converter
object handlers. The <a
href="../libinstpatch/IpatchConverter.html#IPATCH-CONVERTER-LOG-MSG-ALLOC--CAPS"
><span class="type">IPATCH_CONVERTER_LOG_MSG_ALLOC</span></a> flag is automatically
set on the log entry, since it is dynamically allocated.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>converter</code></em> :</span></p></td>
<td> Converter object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> Item the log entry pertains to or <code class="literal">NULL</code> if not item specific
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td> <a
href="../libinstpatch/IpatchConverter.html#IpatchConverterLogType"
><span class="type">IpatchConverterLogType</span></a> and other flags
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>fmt</code></em> :</span></p></td>
<td> Printf format style string
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
<td> Arguments to <em class="parameter"><code>fmt</code></em> message string
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_converter_log_next ()">
<a name="ipatch-converter-log-next"></a><h3>ipatch_converter_log_next ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> ipatch_converter_log_next (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
>gpointer</a> *pos,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> **item,
int *type,
char **msg);</pre>
<p>
Get the first or next log entry from a converter object.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>converter</code></em> :</span></p></td>
<td> Converter object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pos</code></em> :</span></p></td>
<td> Opaque current position in log, should be <code class="literal">NULL</code> on first call to
this function to return first log item (oldest item)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> Location to store item of the log entry or <code class="literal">NULL</code>, no reference is
added so the item is only guarenteed to exist for as long as the
<em class="parameter"><code>converter</code></em> does
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td> Location to store the type parameter of the log entry or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>msg</code></em> :</span></p></td>
<td> Location to store the message of the log entry or <code class="literal">NULL</code>, message
is internal and should not be messed with and is only guarenteed for
the lifetime of the <em class="parameter"><code>converter</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">TRUE</code> if an entry was returned, <code class="literal">FALSE</code> if no more entries in which
case item, type and msg are all undefined.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_converter_set_link_funcs ()">
<a name="ipatch-converter-set-link-funcs"></a><h3>ipatch_converter_set_link_funcs ()</h3>
<pre class="programlisting">void ipatch_converter_set_link_funcs (<a
href="../libinstpatch/IpatchConverter.html"
>IpatchConverter</a> *converter,
IpatchConverterLinkLookupFunc *link_lookup,
IpatchConverterLinkNotifyFunc *link_notify);</pre>
<p>
This function allows for object link interception by the user of
an <a
href="../libinstpatch/IpatchConverter.html"
><span class="type">IpatchConverter</span></a> instance. The callback functions are used by
conversion processes which create objects linking other external
objects which need to be converted. For each link object needing
conversion <em class="parameter"><code>link_lookup</code></em> will be called. If <em class="parameter"><code>link_lookup</code></em> returns a valid
pointer it is used as the converted link object, if <code class="literal">NULL</code> is returned then
the link will be converted and <em class="parameter"><code>link_notify</code></em> will be called with the new
converted item. An example usage of this feature is
the <a
href="../libinstpatch/IpatchPaste.html"
><span class="type">IpatchPaste</span></a> system, which does object conversions and substitutes
already converted objects (a conversion pool).</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>converter</code></em> :</span></p></td>
<td> Converter object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>link_lookup</code></em> :</span></p></td>
<td> Set the link lookup callback function
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>link_notify</code></em> :</span></p></td>
<td> Set the link notify callback function
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="IpatchConverter.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "progress" property'>
<a name="IpatchConverter--progress"></a><h3>The <code class="literal">"progress"</code> property</h3>
<pre class="programlisting"> "progress" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"
>gfloat</a> : Read / Write</pre>
<p>Conversion progress.</p>
<p>Allowed values: [0,1]</p>
<p>Default value: 0</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
</body>
</html>
|
