/usr/share/gtk-doc/html/libinstpatch/IpatchContainer.html is in libinstpatch-doc 1.0.0-7.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IpatchContainer</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="ch01.html" title="Base objects and functions">
<link rel="prev" href="IpatchItem.html" title="IpatchItem">
<link rel="next" href="IpatchBase.html" title="IpatchBase">
<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="IpatchItem.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.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="IpatchBase.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#IpatchContainer.synopsis" class="shortcut">Top</a>
|
<a href="#IpatchContainer.description" class="shortcut">Description</a>
|
<a href="#IpatchContainer.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry" title="IpatchContainer">
<a name="IpatchContainer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="IpatchContainer.top_of_page"></a>IpatchContainer</span></h2>
<p>IpatchContainer — Abstract object type used for items containing other
child items.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="IpatchContainer.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="IpatchContainer.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
void (<a
href="../libinstpatch/IpatchContainer.html#IpatchContainerCallback"
>*IpatchContainerCallback</a>) (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *item,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);
void (<a
href="../libinstpatch/IpatchContainer.html#IpatchContainerDisconnect"
>*IpatchContainerDisconnect</a>) (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *child,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);
<a
href="../libinstpatch/IpatchContainer.html#IpatchContainer-struct"
>IpatchContainer</a>;
#define <a
href="../libinstpatch/IpatchContainer.html#IPATCH-CONTAINER-UNUSED-FLAG-SHIFT--CAPS"
>IPATCH_CONTAINER_UNUSED_FLAG_SHIFT</a>
#define <a
href="../libinstpatch/IpatchContainer.html#IPATCH-CONTAINER-ERRMSG-INVALID-CHILD-2--CAPS"
>IPATCH_CONTAINER_ERRMSG_INVALID_CHILD_2</a>
<a
href="../libinstpatch/IpatchList.html"
>IpatchList</a> * <a
href="../libinstpatch/IpatchContainer.html#ipatch-container-get-children"
>ipatch_container_get_children</a> (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> type);
const <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> * <a
href="../libinstpatch/IpatchContainer.html#ipatch-container-get-child-types"
>ipatch_container_get_child_types</a> (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container);
const <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> * <a
href="../libinstpatch/IpatchContainer.html#ipatch-container-get-virtual-types"
>ipatch_container_get_virtual_types</a> (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container);
const <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> * <a
href="../libinstpatch/IpatchContainer.html#ipatch-container-type-get-child-types"
>ipatch_container_type_get_child_types</a>
(<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> container_type);
void <a
href="../libinstpatch/IpatchContainer.html#ipatch-container-insert"
>ipatch_container_insert</a> (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *item,
int pos);
void <a
href="../libinstpatch/IpatchContainer.html#ipatch-container-append"
>ipatch_container_append</a> (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *item);
#define <a
href="../libinstpatch/IpatchContainer.html#ipatch-container-add"
>ipatch_container_add</a>
void <a
href="../libinstpatch/IpatchContainer.html#ipatch-container-prepend"
>ipatch_container_prepend</a> (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *item);
void <a
href="../libinstpatch/IpatchContainer.html#ipatch-container-remove"
>ipatch_container_remove</a> (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *item);
void <a
href="../libinstpatch/IpatchContainer.html#ipatch-container-remove-all"
>ipatch_container_remove_all</a> (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> <a
href="../libinstpatch/IpatchContainer.html#ipatch-container-count"
>ipatch_container_count</a> (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> type);
void <a
href="../libinstpatch/IpatchContainer.html#ipatch-container-make-unique"
>ipatch_container_make_unique</a> (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *item);
void <a
href="../libinstpatch/IpatchContainer.html#ipatch-container-add-unique"
>ipatch_container_add_unique</a> (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *item);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> <a
href="../libinstpatch/IpatchContainer.html#ipatch-container-init-iter"
>ipatch_container_init_iter</a> (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/libinstpatch-IpatchIter.html#IpatchIter"
>IpatchIter</a> *iter,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> type);
void <a
href="../libinstpatch/IpatchContainer.html#ipatch-container-insert-iter"
>ipatch_container_insert_iter</a> (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *item,
<a
href="../libinstpatch/libinstpatch-IpatchIter.html#IpatchIter"
>IpatchIter</a> *iter);
void <a
href="../libinstpatch/IpatchContainer.html#ipatch-container-remove-iter"
>ipatch_container_remove_iter</a> (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/libinstpatch-IpatchIter.html#IpatchIter"
>IpatchIter</a> *iter);
void <a
href="../libinstpatch/IpatchContainer.html#ipatch-container-add-notify"
>ipatch_container_add_notify</a> (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *child);
void <a
href="../libinstpatch/IpatchContainer.html#ipatch-container-remove-notify"
>ipatch_container_remove_notify</a> (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *child);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> <a
href="../libinstpatch/IpatchContainer.html#ipatch-container-add-connect"
>ipatch_container_add_connect</a> (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/IpatchContainer.html#IpatchContainerCallback"
>IpatchContainerCallback</a> callback,
<a
href="../libinstpatch/IpatchContainer.html#IpatchContainerDisconnect"
>IpatchContainerDisconnect</a> disconnect,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> <a
href="../libinstpatch/IpatchContainer.html#ipatch-container-remove-connect"
>ipatch_container_remove_connect</a> (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *child,
<a
href="../libinstpatch/IpatchContainer.html#IpatchContainerCallback"
>IpatchContainerCallback</a> callback,
<a
href="../libinstpatch/IpatchContainer.html#IpatchContainerDisconnect"
>IpatchContainerDisconnect</a> disconnect,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);
void <a
href="../libinstpatch/IpatchContainer.html#ipatch-container-add-disconnect"
>ipatch_container_add_disconnect</a> (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> handler_id);
void <a
href="../libinstpatch/IpatchContainer.html#ipatch-container-add-disconnect-matched"
>ipatch_container_add_disconnect_matched</a>
(<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/IpatchContainer.html#IpatchContainerCallback"
>IpatchContainerCallback</a> callback,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);
void <a
href="../libinstpatch/IpatchContainer.html#ipatch-container-remove-disconnect"
>ipatch_container_remove_disconnect</a> (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> handler_id);
void <a
href="../libinstpatch/IpatchContainer.html#ipatch-container-remove-disconnect-matched"
>ipatch_container_remove_disconnect_matched</a>
(<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *child,
<a
href="../libinstpatch/IpatchContainer.html#IpatchContainerCallback"
>IpatchContainerCallback</a> callback,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="IpatchContainer.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>
+----<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a>
+----IpatchContainer
+----<a
href="../libinstpatch/IpatchBase.html"
>IpatchBase</a>
+----<a
href="../libinstpatch/IpatchDLS2Inst.html"
>IpatchDLS2Inst</a>
+----<a
href="../libinstpatch/IpatchGigRegion.html"
>IpatchGigRegion</a>
+----<a
href="../libinstpatch/IpatchSF2Preset.html"
>IpatchSF2Preset</a>
+----<a
href="../libinstpatch/IpatchSF2Inst.html"
>IpatchSF2Inst</a>
+----<a
href="../libinstpatch/IpatchVBankInst.html"
>IpatchVBankInst</a>
</pre>
</div>
<div class="refsect1" title="Description">
<a name="IpatchContainer.description"></a><h2>Description</h2>
<p>
Objects which are derived from this abstract type can contain other items,
thus forming a tree of items in an instrument file for example.</p>
</div>
<div class="refsect1" title="Details">
<a name="IpatchContainer.details"></a><h2>Details</h2>
<div class="refsect2" title="IpatchContainerCallback ()">
<a name="IpatchContainerCallback"></a><h3>IpatchContainerCallback ()</h3>
<pre class="programlisting">void (*IpatchContainerCallback) (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *item,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);</pre>
<p>
A function prototype callback which is called for container adds or removes
(after adds, before removes).</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
<td> Container item
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> Item that was added/removed to/from <em class="parameter"><code>container</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td> User defined pointer assigned when callback connected
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="IpatchContainerDisconnect ()">
<a name="IpatchContainerDisconnect"></a><h3>IpatchContainerDisconnect ()</h3>
<pre class="programlisting">void (*IpatchContainerDisconnect) (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *child,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);</pre>
<p>
A function prototype which is called when a callback gets disconnected.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
<td> Container item
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>child</code></em> :</span></p></td>
<td> Match child item of original connect
(<a
href="../libinstpatch/IpatchContainer.html#ipatch-container-remove-connect"
><code class="function">ipatch_container_remove_connect()</code></a> only, always NULL for
<a
href="../libinstpatch/IpatchContainer.html#ipatch-container-add-connect"
><code class="function">ipatch_container_add_connect()</code></a>).
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td> User defined pointer assigned when callback connected
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="IpatchContainer">
<a name="IpatchContainer-struct"></a><h3>IpatchContainer</h3>
<pre class="programlisting">typedef struct _IpatchContainer IpatchContainer;</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_CONTAINER_UNUSED_FLAG_SHIFT">
<a name="IPATCH-CONTAINER-UNUSED-FLAG-SHIFT--CAPS"></a><h3>IPATCH_CONTAINER_UNUSED_FLAG_SHIFT</h3>
<pre class="programlisting">#define IPATCH_CONTAINER_UNUSED_FLAG_SHIFT IPATCH_ITEM_UNUSED_FLAG_SHIFT
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_CONTAINER_ERRMSG_INVALID_CHILD_2">
<a name="IPATCH-CONTAINER-ERRMSG-INVALID-CHILD-2--CAPS"></a><h3>IPATCH_CONTAINER_ERRMSG_INVALID_CHILD_2</h3>
<pre class="programlisting">#define IPATCH_CONTAINER_ERRMSG_INVALID_CHILD_2</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_container_get_children ()">
<a name="ipatch-container-get-children"></a><h3>ipatch_container_get_children ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchList.html"
>IpatchList</a> * ipatch_container_get_children (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> type);</pre>
<p>
Get a list of child items from a container object. A new <a
href="../libinstpatch/IpatchList.html"
><span class="type">IpatchList</span></a> is
created containing all matching child items. The returned list object can
be iterated over safely even in a multi-thread environment. If
performance is an issue, <a
href="../libinstpatch/IpatchContainer.html#ipatch-container-init-iter"
><code class="function">ipatch_container_init_iter()</code></a> can be used instead,
although it requires locking of the container object.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
<td> Container object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td> GType of child items to get (will match type descendants as well)
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> New object list containing all matching items (an empty
list if no items matched). The caller owns a reference to the
object list and removing the reference will destroy it.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_container_get_child_types ()">
<a name="ipatch-container-get-child-types"></a><h3>ipatch_container_get_child_types ()</h3>
<pre class="programlisting">const <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> * ipatch_container_get_child_types (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container);</pre>
<p>
Get an array of child types for a container object. The number of types
is the number of individual lists the container has.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
<td> Container object
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Pointer to a zero terminated array of types. Array is
static and should not be modified or freed.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_container_get_virtual_types ()">
<a name="ipatch-container-get-virtual-types"></a><h3>ipatch_container_get_virtual_types ()</h3>
<pre class="programlisting">const <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> * ipatch_container_get_virtual_types (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container);</pre>
<p>
Get an array of virtual types for a container object. Virtual types are
used to group child items in user interfaces (an example is SoundFont
"Percussion Presets" which contains all presets in bank number 128). To
discover what virtual container a child object is part of lookup it's
"virtual-parent-type" type property (<a
href="../libinstpatch/libinstpatch-IpatchTypeProp.html#ipatch-type-get"
><code class="function">ipatch_type_get()</code></a> or
<a
href="../libinstpatch/libinstpatch-IpatchTypeProp.html#ipatch-type-object-get"
><code class="function">ipatch_type_object_get()</code></a>).</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
<td> Container object
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Pointer to a zero terminated array of types or <code class="literal">NULL</code> if no virtual
types for <em class="parameter"><code>container</code></em>. Array is static and should not be modified or freed.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_container_type_get_child_types ()">
<a name="ipatch-container-type-get-child-types"></a><h3>ipatch_container_type_get_child_types ()</h3>
<pre class="programlisting">const <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> * ipatch_container_type_get_child_types
(<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> container_type);</pre>
<p>
Get an array of child types for a container type. The number of types
is the number of individual lists the container has. Like
<a
href="../libinstpatch/IpatchContainer.html#ipatch-container-get-child-types"
><code class="function">ipatch_container_get_child_types()</code></a> but takes a container GType instead of
a container object.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>container_type</code></em> :</span></p></td>
<td> A <a
href="../libinstpatch/IpatchContainer.html"
><span class="type">IpatchContainer</span></a> derived type to get child types of
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Pointer to a zero terminated array of types. Array is
static and should not be modified or freed.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_container_insert ()">
<a name="ipatch-container-insert"></a><h3>ipatch_container_insert ()</h3>
<pre class="programlisting">void ipatch_container_insert (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *item,
int pos);</pre>
<p>
Inserts an item into a patch item container.
</p>
<p>
MT-NOTE: If position in list is critical the container item should
be locked and <a
href="../libinstpatch/IpatchContainer.html#ipatch-container-insert-iter"
><code class="function">ipatch_container_insert_iter()</code></a> used instead (see other
special requirements for using this function).
Only inserting in the first or last position (<em class="parameter"><code>pos</code></em> is 0 or less than 0)
is guaranteed.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
<td> Container item to insert into
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> Item to insert
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pos</code></em> :</span></p></td>
<td> Index position to insert <em class="parameter"><code>item</code></em> into (<em class="parameter"><code>item</code></em> type is used to
determine what list to insert into). 0 = first, less than 0 = last.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_container_append ()">
<a name="ipatch-container-append"></a><h3>ipatch_container_append ()</h3>
<pre class="programlisting">void ipatch_container_append (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *item);</pre>
<p>
Appends an item to a container's children.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
<td> Container item
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> Item to insert
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_container_add">
<a name="ipatch-container-add"></a><h3>ipatch_container_add</h3>
<pre class="programlisting">#define ipatch_container_add ipatch_container_append
</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_container_prepend ()">
<a name="ipatch-container-prepend"></a><h3>ipatch_container_prepend ()</h3>
<pre class="programlisting">void ipatch_container_prepend (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *item);</pre>
<p>
Prepends an item to a container's children.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
<td> Container item
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> Item to insert
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_container_remove ()">
<a name="ipatch-container-remove"></a><h3>ipatch_container_remove ()</h3>
<pre class="programlisting">void ipatch_container_remove (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *item);</pre>
<p>
Removes an <em class="parameter"><code>item</code></em> from <em class="parameter"><code>container</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>container</code></em> :</span></p></td>
<td> Container item to remove from
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> Item to remove from <em class="parameter"><code>container</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_container_remove_all ()">
<a name="ipatch-container-remove-all"></a><h3>ipatch_container_remove_all ()</h3>
<pre class="programlisting">void ipatch_container_remove_all (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container);</pre>
<p>
Removes all items from a <em class="parameter"><code>container</code></em> object.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
<td> Container object
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_container_count ()">
<a name="ipatch-container-count"></a><h3>ipatch_container_count ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> ipatch_container_count (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> type);</pre>
<p>
Counts children of a specific <em class="parameter"><code>type</code></em> (or derived thereof) in
a <em class="parameter"><code>container</code></em> object.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
<td> Container object to count children of
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td> Type of children to count
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Count of children of <em class="parameter"><code>type</code></em> in <em class="parameter"><code>container</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_container_make_unique ()">
<a name="ipatch-container-make-unique"></a><h3>ipatch_container_make_unique ()</h3>
<pre class="programlisting">void ipatch_container_make_unique (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *item);</pre>
<p>
Ensures an <em class="parameter"><code>item</code></em>'s duplicate sensitive properties are unique among items of
the same type in <em class="parameter"><code>container</code></em>. The item need not be a child of <em class="parameter"><code>container</code></em>, but
can be. The initial values of the duplicate sensitive properties are used
if already unique, otherwise they are modified (name strings have numbers
appended to them, unused MIDI locale is found, etc).</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
<td> Patch item container
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> An item of a type that can be added to <em class="parameter"><code>container</code></em> (but not
necessarily parented to <em class="parameter"><code>container</code></em>).
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_container_add_unique ()">
<a name="ipatch-container-add-unique"></a><h3>ipatch_container_add_unique ()</h3>
<pre class="programlisting">void ipatch_container_add_unique (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *item);</pre>
<p>
Adds a patch item to a container and ensures that the item's duplicate
sensitive properties are unique (see <a
href="../libinstpatch/IpatchContainer.html#ipatch-container-make-unique"
><code class="function">ipatch_container_make_unique()</code></a>).</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
<td> Container to add item to
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> Item to add
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_container_init_iter ()">
<a name="ipatch-container-init-iter"></a><h3>ipatch_container_init_iter ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> ipatch_container_init_iter (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/libinstpatch-IpatchIter.html#IpatchIter"
>IpatchIter</a> *iter,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> type);</pre>
<p>
Initialize an iterator structure to a child list of the specified
<em class="parameter"><code>type</code></em> in a <em class="parameter"><code>container</code></em> object.
</p>
<p>
MT-NOTE: The <em class="parameter"><code>container</code></em> must be locked, or single thread access
ensured, for the duration of this call and iteration of <em class="parameter"><code>iter</code></em> as
the <em class="parameter"><code>container</code></em> object's lists are used directly. The iterator related
functions are meant to be used for latency critical operations, and they
should try and minimize the locking duration.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
<td> Container object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td> Iterator structure to initialize
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td> Container child type list to initialize <em class="parameter"><code>iter</code></em> to
</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 the contents of
<em class="parameter"><code>iter</code></em> are undefined.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_container_insert_iter ()">
<a name="ipatch-container-insert-iter"></a><h3>ipatch_container_insert_iter ()</h3>
<pre class="programlisting">void ipatch_container_insert_iter (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *item,
<a
href="../libinstpatch/libinstpatch-IpatchIter.html#IpatchIter"
>IpatchIter</a> *iter);</pre>
<p>
This function should not normally be used. It is provided to allow for
custom high performance functions involving container adds. If used, certain
precautions and requirements must be followed.
</p>
<p>
Insert a patch <em class="parameter"><code>item</code></em> into a <em class="parameter"><code>container</code></em> after the position marked by
<em class="parameter"><code>iter</code></em>. No checking is done to see if child <em class="parameter"><code>item</code></em> is actually a valid
type in <em class="parameter"><code>container</code></em>, this is left up to the caller for added performance.
Also left up to the caller is a call to <a
href="../libinstpatch/IpatchContainer.html#ipatch-container-add-notify"
><code class="function">ipatch_container_add_notify()</code></a> to
notify that the item has been added (should be called after this function
and outside of <em class="parameter"><code>container</code></em> lock). It is not necessary to notify if hooks
are not enabled for <em class="parameter"><code>container</code></em> or caller doesn't care.
</p>
<p>
MT-NOTE: The <em class="parameter"><code>container</code></em> object should be write locked, or single thread
access ensured, for the duration of this call and prior iterator functions.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
<td> Container object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> Patch item to insert
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td> Iterator marking position to insert after (<code class="literal">NULL</code> position to
prepend). Iterator is advanced after insert to point to new
inserted item. Note that this makes appending multiple items rather
fast.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_container_remove_iter ()">
<a name="ipatch-container-remove-iter"></a><h3>ipatch_container_remove_iter ()</h3>
<pre class="programlisting">void ipatch_container_remove_iter (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/libinstpatch-IpatchIter.html#IpatchIter"
>IpatchIter</a> *iter);</pre>
<p>
This function should not normally be used. It is provided to allow for
custom high performance functions involving container removes. If used,
certain precautions and requirements must be followed.
</p>
<p>
Removes an item from a <em class="parameter"><code>container</code></em> object. The item is specified by the
current position in <em class="parameter"><code>iter</code></em>. It is left up to the caller to call
<a
href="../libinstpatch/IpatchContainer.html#ipatch-container-remove-notify"
><code class="function">ipatch_container_remove_notify()</code></a> (should be called before this function
and out of <em class="parameter"><code>container</code></em> lock) to notify that the item will be removed.
It is not necessary to notify if hooks are not enabled for <em class="parameter"><code>container</code></em> or
caller doesn't care.
</p>
<p>
MT-NOTE: The <em class="parameter"><code>container</code></em> object should be write locked, or single thread
access ensured, for the duration of this call and prior iterator functions.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
<td> Container object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td> Iterator marking item to remove
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_container_add_notify ()">
<a name="ipatch-container-add-notify"></a><h3>ipatch_container_add_notify ()</h3>
<pre class="programlisting">void ipatch_container_add_notify (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *child);</pre>
<p>
Notify that a child add has occurred to an <a
href="../libinstpatch/IpatchContainer.html"
><span class="type">IpatchContainer</span></a> object.
Should be called after the add has occurred. This function is normally
not needed except when using <a
href="../libinstpatch/IpatchContainer.html#ipatch-container-insert-iter"
><code class="function">ipatch_container_insert_iter()</code></a>.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
<td> Container item for which an item add occurred
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>child</code></em> :</span></p></td>
<td> Child which was added
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_container_remove_notify ()">
<a name="ipatch-container-remove-notify"></a><h3>ipatch_container_remove_notify ()</h3>
<pre class="programlisting">void ipatch_container_remove_notify (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *child);</pre>
<p>
Notify that a container remove will occur to an <a
href="../libinstpatch/IpatchContainer.html"
><span class="type">IpatchContainer</span></a> object.
Should be called before the remove occurs. This function is normally not
needed, except when using <a
href="../libinstpatch/IpatchContainer.html#ipatch-container-remove-iter"
><code class="function">ipatch_container_remove_iter()</code></a>.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
<td> Container item for which a remove will occur
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>child</code></em> :</span></p></td>
<td> Child which will be removed
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_container_add_connect ()">
<a name="ipatch-container-add-connect"></a><h3>ipatch_container_add_connect ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> ipatch_container_add_connect (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/IpatchContainer.html#IpatchContainerCallback"
>IpatchContainerCallback</a> callback,
<a
href="../libinstpatch/IpatchContainer.html#IpatchContainerDisconnect"
>IpatchContainerDisconnect</a> disconnect,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);</pre>
<p>
Adds a callback which gets called when a container item add operation occurs
and the container matches <em class="parameter"><code>container</code></em>. When <em class="parameter"><code>container</code></em> is <code class="literal">NULL</code>, <em class="parameter"><code>callback</code></em>
will be called for every container add operation.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
<td> Container to match (<code class="literal">NULL</code> for wildcard)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td> Callback function to call on match
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>disconnect</code></em> :</span></p></td>
<td> Function to call when callback is disconnected or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td> User defined data pointer to pass to <em class="parameter"><code>callback</code></em> and <em class="parameter"><code>disconnect</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Handler ID which can be used to disconnect the callback or
0 on error (only occurs on invalid function parameters).
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_container_remove_connect ()">
<a name="ipatch-container-remove-connect"></a><h3>ipatch_container_remove_connect ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> ipatch_container_remove_connect (<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *child,
<a
href="../libinstpatch/IpatchContainer.html#IpatchContainerCallback"
>IpatchContainerCallback</a> callback,
<a
href="../libinstpatch/IpatchContainer.html#IpatchContainerDisconnect"
>IpatchContainerDisconnect</a> disconnect,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);</pre>
<p>
Adds a callback which gets called when a container item remove operation
occurs and the container matches <em class="parameter"><code>container</code></em> and child item matches <em class="parameter"><code>child</code></em>.
The <em class="parameter"><code>container</code></em> and/or <em class="parameter"><code>child</code></em> parameters can be <code class="literal">NULL</code> in which case they are
wildcard. If both are <code class="literal">NULL</code> then <em class="parameter"><code>callback</code></em> will be called for every
container remove operation. Note that specifying only <em class="parameter"><code>child</code></em> or both
<em class="parameter"><code>container</code></em> and <em class="parameter"><code>child</code></em> is the same, since a child belongs to only one container.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
<td> Container to match (<code class="literal">NULL</code> for wildcard)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>child</code></em> :</span></p></td>
<td> Child item to match (<code class="literal">NULL</code> for wildcard)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td> Callback function to call on match
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>disconnect</code></em> :</span></p></td>
<td> Function to call when callback is disconnected or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td> User defined data pointer to pass to <em class="parameter"><code>callback</code></em> and <em class="parameter"><code>disconnect</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Handler ID which can be used to disconnect the callback or
0 on error (only occurs on invalid function parameters).
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_container_add_disconnect ()">
<a name="ipatch-container-add-disconnect"></a><h3>ipatch_container_add_disconnect ()</h3>
<pre class="programlisting">void ipatch_container_add_disconnect (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> handler_id);</pre>
<p>
Disconnects a container add callback previously connected with
<a
href="../libinstpatch/IpatchContainer.html#ipatch-container-add-connect"
><code class="function">ipatch_container_add_connect()</code></a> by handler ID. The
<a
href="../libinstpatch/IpatchContainer.html#ipatch-container-add-disconnect-matched"
><code class="function">ipatch_container_add_disconnect_matched()</code></a> function can be used instead to
disconnect by original callback criteria and is actually faster.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>handler_id</code></em> :</span></p></td>
<td> ID of callback handler
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_container_add_disconnect_matched ()">
<a name="ipatch-container-add-disconnect-matched"></a><h3>ipatch_container_add_disconnect_matched ()</h3>
<pre class="programlisting">void ipatch_container_add_disconnect_matched
(<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/IpatchContainer.html#IpatchContainerCallback"
>IpatchContainerCallback</a> callback,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);</pre>
<p>
Disconnects a container add callback previously connected with
<a
href="../libinstpatch/IpatchContainer.html#ipatch-container-add-connect"
><code class="function">ipatch_container_add_connect()</code></a> by match criteria.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
<td> Container to match
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td> Callback function to match
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td> User data to match
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_container_remove_disconnect ()">
<a name="ipatch-container-remove-disconnect"></a><h3>ipatch_container_remove_disconnect ()</h3>
<pre class="programlisting">void ipatch_container_remove_disconnect (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> handler_id);</pre>
<p>
Disconnects a container remove callback previously connected with
<a
href="../libinstpatch/IpatchContainer.html#ipatch-container-remove-connect"
><code class="function">ipatch_container_remove_connect()</code></a> by handler ID. The
<a
href="../libinstpatch/IpatchContainer.html#ipatch-container-remove-disconnect-matched"
><code class="function">ipatch_container_remove_disconnect_matched()</code></a> function can be used instead to
disconnect by original callback criteria and is actually faster.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>handler_id</code></em> :</span></p></td>
<td> ID of callback handler
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_container_remove_disconnect_matched ()">
<a name="ipatch-container-remove-disconnect-matched"></a><h3>ipatch_container_remove_disconnect_matched ()</h3>
<pre class="programlisting">void ipatch_container_remove_disconnect_matched
(<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a> *container,
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *child,
<a
href="../libinstpatch/IpatchContainer.html#IpatchContainerCallback"
>IpatchContainerCallback</a> callback,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);</pre>
<p>
Disconnects a handler previously connected with
<a
href="../libinstpatch/IpatchContainer.html#ipatch-container-remove-connect"
><code class="function">ipatch_container_remove_connect()</code></a> by match criteria.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
<td> Container to match
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>child</code></em> :</span></p></td>
<td> Child item to match
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td> Callback function to match
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td> User data to match
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
</body>
</html>
|