/usr/share/gir-1.0/Peas-1.0.gir is in libpeas-dev 1.16.0-1ubuntu2.
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 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 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 | <?xml version="1.0"?>
<!-- This file was automatically generated from C sources - DO NOT EDIT!
To affect the contents of this file, edit the original C definitions,
and/or use gtk-doc annotations. -->
<repository version="1.2"
xmlns="http://www.gtk.org/introspection/core/1.0"
xmlns:c="http://www.gtk.org/introspection/c/1.0"
xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
<include name="GIRepository" version="2.0"/>
<include name="GModule" version="2.0"/>
<include name="GObject" version="2.0"/>
<include name="Gio" version="2.0"/>
<package name="libpeas-1.0"/>
<c:include name="libpeas/peas.h"/>
<namespace name="Peas"
version="1.0"
shared-library="libpeas-1.0.so.0"
c:identifier-prefixes="Peas"
c:symbol-prefixes="peas">
<alias name="Extension" c:type="PeasExtension">
<doc xml:space="preserve">A proxy class to access the actual plugin.</doc>
<type name="GObject.Object" c:type="GObject"/>
</alias>
<interface name="Activatable"
c:symbol-prefix="activatable"
c:type="PeasActivatable"
glib:type-name="PeasActivatable"
glib:get-type="peas_activatable_get_type"
glib:type-struct="ActivatableInterface">
<doc xml:space="preserve">Interface for activatable plugins.</doc>
<virtual-method name="activate" invoker="activate">
<doc xml:space="preserve">Activates the extension on the targetted object.
On activation, the extension should hook itself to the object
where it makes sense.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="activatable" transfer-ownership="none">
<doc xml:space="preserve">A #PeasActivatable.</doc>
<type name="Activatable" c:type="PeasActivatable*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="deactivate" invoker="deactivate">
<doc xml:space="preserve">Deactivates the extension on the targetted object.
On deactivation, an extension should remove itself from all the hooks it
used and should perform any cleanup required, so it can be unreffed safely
and without any more effect on the host application.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="activatable" transfer-ownership="none">
<doc xml:space="preserve">A #PeasActivatable.</doc>
<type name="Activatable" c:type="PeasActivatable*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="update_state" invoker="update_state">
<doc xml:space="preserve">Triggers an update of the extension internal state to take into account
state changes in the targetted object, due to some event or user action.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="activatable" transfer-ownership="none">
<doc xml:space="preserve">A #PeasActivatable.</doc>
<type name="Activatable" c:type="PeasActivatable*"/>
</instance-parameter>
</parameters>
</virtual-method>
<method name="activate" c:identifier="peas_activatable_activate">
<doc xml:space="preserve">Activates the extension on the targetted object.
On activation, the extension should hook itself to the object
where it makes sense.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="activatable" transfer-ownership="none">
<doc xml:space="preserve">A #PeasActivatable.</doc>
<type name="Activatable" c:type="PeasActivatable*"/>
</instance-parameter>
</parameters>
</method>
<method name="deactivate" c:identifier="peas_activatable_deactivate">
<doc xml:space="preserve">Deactivates the extension on the targetted object.
On deactivation, an extension should remove itself from all the hooks it
used and should perform any cleanup required, so it can be unreffed safely
and without any more effect on the host application.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="activatable" transfer-ownership="none">
<doc xml:space="preserve">A #PeasActivatable.</doc>
<type name="Activatable" c:type="PeasActivatable*"/>
</instance-parameter>
</parameters>
</method>
<method name="update_state" c:identifier="peas_activatable_update_state">
<doc xml:space="preserve">Triggers an update of the extension internal state to take into account
state changes in the targetted object, due to some event or user action.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="activatable" transfer-ownership="none">
<doc xml:space="preserve">A #PeasActivatable.</doc>
<type name="Activatable" c:type="PeasActivatable*"/>
</instance-parameter>
</parameters>
</method>
<property name="object"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve">The object property contains the targetted object for this
#PeasActivatable instance, for example a toplevel window in a typical
windowed application. It is set at construction time and won't change.</doc>
<type name="GObject.Object"/>
</property>
</interface>
<record name="ActivatableInterface"
c:type="PeasActivatableInterface"
glib:is-gtype-struct-for="Activatable">
<doc xml:space="preserve">Provides an interface for activatable plugins.</doc>
<field name="g_iface">
<doc xml:space="preserve">The parent interface.</doc>
<type name="GObject.TypeInterface" c:type="GTypeInterface"/>
</field>
<field name="activate">
<callback name="activate">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="activatable" transfer-ownership="none">
<doc xml:space="preserve">A #PeasActivatable.</doc>
<type name="Activatable" c:type="PeasActivatable*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="deactivate">
<callback name="deactivate">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="activatable" transfer-ownership="none">
<doc xml:space="preserve">A #PeasActivatable.</doc>
<type name="Activatable" c:type="PeasActivatable*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="update_state">
<callback name="update_state">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="activatable" transfer-ownership="none">
<doc xml:space="preserve">A #PeasActivatable.</doc>
<type name="Activatable" c:type="PeasActivatable*"/>
</parameter>
</parameters>
</callback>
</field>
</record>
<class name="Engine"
c:symbol-prefix="engine"
c:type="PeasEngine"
parent="GObject.Object"
glib:type-name="PeasEngine"
glib:get-type="peas_engine_get_type"
glib:type-struct="EngineClass">
<doc xml:space="preserve">The #PeasEngine structure contains only private data and should only be
accessed using the provided API.</doc>
<constructor name="new" c:identifier="peas_engine_new">
<doc xml:space="preserve">Return a new instance of #PeasEngine.
If no default #PeasEngine has been instantiated yet,
the first call of this function will set the default
engine as the new instance of #PeasEngine.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new instance of #PeasEngine.</doc>
<type name="Engine" c:type="PeasEngine*"/>
</return-value>
</constructor>
<constructor name="new_with_nonglobal_loaders"
c:identifier="peas_engine_new_with_nonglobal_loaders"
version="1.14">
<doc xml:space="preserve">Return a new instance of #PeasEngine which will use non-global
plugin loaders instead of the default global ones. This allows
multiple threads to each have a #PeasEngine and be used without
internal locking.
Note: due to CPython's GIL the python and python3
plugin loaders are always global.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new instance of #PeasEngine that uses non-global loaders.</doc>
<type name="Engine" c:type="PeasEngine*"/>
</return-value>
</constructor>
<function name="get_default" c:identifier="peas_engine_get_default">
<doc xml:space="preserve">Return the existing instance of #PeasEngine or a subclass of it.
If no #PeasEngine subclass has been instantiated yet, the first call
of this function will return a new instance of #PeasEngine.
Note: this function should never be used when multiple threads are
using libpeas API as it is not thread-safe.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the existing instance of #PeasEngine.</doc>
<type name="Engine" c:type="PeasEngine*"/>
</return-value>
</function>
<virtual-method name="load_plugin" invoker="load_plugin">
<doc xml:space="preserve">Loads the plugin corresponding to @info if it's not currently loaded.
Emits the "load-plugin" signal; loading the plugin
actually occurs in the default signal handler.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">whether the plugin has been successfully loaded.</doc>
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="engine" transfer-ownership="none">
<doc xml:space="preserve">A #PeasEngine.</doc>
<type name="Engine" c:type="PeasEngine*"/>
</instance-parameter>
<parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A #PeasPluginInfo.</doc>
<type name="PluginInfo" c:type="PeasPluginInfo*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="unload_plugin" invoker="unload_plugin">
<doc xml:space="preserve">Unloads the plugin corresponding to @info.
Emits the "unload-plugin" signal; unloading the plugin
actually occurs in the default signal handler.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">whether the plugin has been successfully unloaded.</doc>
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="engine" transfer-ownership="none">
<doc xml:space="preserve">A #PeasEngine.</doc>
<type name="Engine" c:type="PeasEngine*"/>
</instance-parameter>
<parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A #PeasPluginInfo.</doc>
<type name="PluginInfo" c:type="PeasPluginInfo*"/>
</parameter>
</parameters>
</virtual-method>
<method name="add_search_path"
c:identifier="peas_engine_add_search_path">
<doc xml:space="preserve">This function appends a search path to the list of paths where to
look for plugins.
A so-called "search path" actually consists of both a
module directory (where the shared libraries or language modules
lie) and a data directory (where the plugin data is).
The plugin will be able to use a correct data dir depending on
where it is installed, hence allowing to keep the plugin agnostic
when it comes to installation location: the same plugin can be
installed either in the system path or in the user's home directory,
without taking other special care than using
peas_plugin_info_get_data_dir() when looking for its data files.
If @data_dir is %NULL, then it is set to the same value as
@module_dir.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="engine" transfer-ownership="none">
<doc xml:space="preserve">A #PeasEngine.</doc>
<type name="Engine" c:type="PeasEngine*"/>
</instance-parameter>
<parameter name="module_dir" transfer-ownership="none">
<doc xml:space="preserve">the plugin module directory.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="data_dir"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the plugin data directory.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="create_extension"
c:identifier="peas_engine_create_extension"
shadowed-by="create_extensionv"
introspectable="0">
<doc xml:space="preserve">If the plugin identified by @info implements the @extension_type interface,
then this function will return a new instance of this implementation,
wrapped in a new #PeasExtension instance. Otherwise, it will return %NULL.
When creating the new instance of the @extension_type subtype, the
provided construct properties will be passed to the extension construction
handler (exactly like if you had called g_object_new() yourself).
The new extension instance produced by this function will always be
returned wrapped in a #PeasExtension proxy, following the current libpeas
principle of never giving you the actual object (also because it might as
well *not* be an actual object).</doc>
<return-value>
<doc xml:space="preserve">a new instance of #PeasExtension wrapping
the @extension_type instance, or %NULL.</doc>
<type name="Extension" c:type="PeasExtension*"/>
</return-value>
<parameters>
<instance-parameter name="engine" transfer-ownership="none">
<doc xml:space="preserve">A #PeasEngine.</doc>
<type name="Engine" c:type="PeasEngine*"/>
</instance-parameter>
<parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A loaded #PeasPluginInfo.</doc>
<type name="PluginInfo" c:type="PeasPluginInfo*"/>
</parameter>
<parameter name="extension_type" transfer-ownership="none">
<doc xml:space="preserve">The implemented extension #GType.</doc>
<type name="GType" c:type="GType"/>
</parameter>
<parameter name="first_property" transfer-ownership="none">
<doc xml:space="preserve">the name of the first property.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">the value of the first property, followed optionally by more
name/value pairs, followed by %NULL.</doc>
<varargs/>
</parameter>
</parameters>
</method>
<method name="create_extension_valist"
c:identifier="peas_engine_create_extension_valist"
introspectable="0">
<doc xml:space="preserve">If the plugin identified by @info implements the @extension_type interface,
then this function will return a new instance of this implementation,
wrapped in a new #PeasExtension instance. Otherwise, it will return %NULL.
See peas_engine_create_extension() for more information.</doc>
<return-value>
<doc xml:space="preserve">a new instance of #PeasExtension wrapping
the @extension_type instance, or %NULL.</doc>
<type name="Extension" c:type="PeasExtension*"/>
</return-value>
<parameters>
<instance-parameter name="engine" transfer-ownership="none">
<doc xml:space="preserve">A #PeasEngine.</doc>
<type name="Engine" c:type="PeasEngine*"/>
</instance-parameter>
<parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A loaded #PeasPluginInfo.</doc>
<type name="PluginInfo" c:type="PeasPluginInfo*"/>
</parameter>
<parameter name="extension_type" transfer-ownership="none">
<doc xml:space="preserve">The implemented extension #GType.</doc>
<type name="GType" c:type="GType"/>
</parameter>
<parameter name="first_property" transfer-ownership="none">
<doc xml:space="preserve">the name of the first property.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="var_args" transfer-ownership="none">
<doc xml:space="preserve">the value of the first property, followed optionally by more
name/value pairs, followed by %NULL.</doc>
<type name="va_list" c:type="va_list"/>
</parameter>
</parameters>
</method>
<method name="create_extensionv"
c:identifier="peas_engine_create_extensionv"
shadows="create_extension">
<doc xml:space="preserve">If the plugin identified by @info implements the @extension_type interface,
then this function will return a new instance of this implementation,
wrapped in a new #PeasExtension instance. Otherwise, it will return %NULL.
See peas_engine_create_extension() for more information.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new instance of #PeasExtension wrapping
the @extension_type instance, or %NULL.</doc>
<type name="Extension" c:type="PeasExtension*"/>
</return-value>
<parameters>
<instance-parameter name="engine" transfer-ownership="none">
<doc xml:space="preserve">A #PeasEngine.</doc>
<type name="Engine" c:type="PeasEngine*"/>
</instance-parameter>
<parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A loaded #PeasPluginInfo.</doc>
<type name="PluginInfo" c:type="PeasPluginInfo*"/>
</parameter>
<parameter name="extension_type" transfer-ownership="none">
<doc xml:space="preserve">The implemented extension #GType.</doc>
<type name="GType" c:type="GType"/>
</parameter>
<parameter name="n_parameters" transfer-ownership="none">
<doc xml:space="preserve">the length of the @parameters array.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="parameters"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">
an array of #GParameter.</doc>
<array length="2" zero-terminated="0" c:type="GParameter*">
<type name="GObject.Parameter" c:type="GParameter"/>
</array>
</parameter>
</parameters>
</method>
<method name="enable_loader" c:identifier="peas_engine_enable_loader">
<doc xml:space="preserve">Enable a loader, enables a loader for plugins.
The C plugin loader is always enabled. The other plugin
loaders are: lua5.1 and python and python3.
For instance, the following code will enable python plugins
to be loaded:
|[
peas_engine_enable_loader (engine, "python");
]|
Note: plugin loaders used to be shared across #PeasEngines so enabling
a loader on one #PeasEngine would enable it on all #PeasEngines.
This behavior has been kept to avoid breaking applications,
however a warning has been added to help applications transition.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="engine" transfer-ownership="none">
<doc xml:space="preserve">A #PeasEngine.</doc>
<type name="Engine" c:type="PeasEngine*"/>
</instance-parameter>
<parameter name="loader_name" transfer-ownership="none">
<doc xml:space="preserve">The name of the loader to enable.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="garbage_collect"
c:identifier="peas_engine_garbage_collect">
<doc xml:space="preserve">This function triggers garbage collection on all the loaders currently
owned by the #PeasEngine. This can be used to force the loaders to destroy
managed objects that still hold references to objects that are about to
disappear.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="engine" transfer-ownership="none">
<doc xml:space="preserve">A #PeasEngine.</doc>
<type name="Engine" c:type="PeasEngine*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_loaded_plugins"
c:identifier="peas_engine_get_loaded_plugins">
<doc xml:space="preserve">Returns the list of the names of all the loaded plugins, or an array
containing a single %NULL element if there is no plugin currently loaded.
Please note that the returned array is a newly allocated one: you will need
to free it using g_strfreev().</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly-allocated
%NULL-terminated array of strings.</doc>
<array c:type="gchar**">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="engine" transfer-ownership="none">
<doc xml:space="preserve">A #PeasEngine.</doc>
<type name="Engine" c:type="PeasEngine*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_plugin_info"
c:identifier="peas_engine_get_plugin_info">
<doc xml:space="preserve">Gets the #PeasPluginInfo corresponding with @plugin_name,
or %NULL if @plugin_name was not found.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the #PeasPluginInfo corresponding with
a given plugin module name.</doc>
<type name="PluginInfo" c:type="PeasPluginInfo*"/>
</return-value>
<parameters>
<instance-parameter name="engine" transfer-ownership="none">
<doc xml:space="preserve">A #PeasEngine.</doc>
<type name="Engine" c:type="PeasEngine*"/>
</instance-parameter>
<parameter name="plugin_name" transfer-ownership="none">
<doc xml:space="preserve">A plugin name.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_plugin_list"
c:identifier="peas_engine_get_plugin_list">
<doc xml:space="preserve">Returns the list of #PeasPluginInfo known to the engine.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GList of
#PeasPluginInfo. Note that the list belongs to the engine and should
not be freed.</doc>
<type name="GLib.List" c:type="const GList*">
<type name="PluginInfo"/>
</type>
</return-value>
<parameters>
<instance-parameter name="engine" transfer-ownership="none">
<doc xml:space="preserve">A #PeasEngine.</doc>
<type name="Engine" c:type="PeasEngine*"/>
</instance-parameter>
</parameters>
</method>
<method name="load_plugin" c:identifier="peas_engine_load_plugin">
<doc xml:space="preserve">Loads the plugin corresponding to @info if it's not currently loaded.
Emits the "load-plugin" signal; loading the plugin
actually occurs in the default signal handler.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">whether the plugin has been successfully loaded.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="engine" transfer-ownership="none">
<doc xml:space="preserve">A #PeasEngine.</doc>
<type name="Engine" c:type="PeasEngine*"/>
</instance-parameter>
<parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A #PeasPluginInfo.</doc>
<type name="PluginInfo" c:type="PeasPluginInfo*"/>
</parameter>
</parameters>
</method>
<method name="prepend_search_path"
c:identifier="peas_engine_prepend_search_path"
version="1.6">
<doc xml:space="preserve">This function prepends a search path to the list of paths where to
look for plugins.
See Also: peas_engine_add_search_path()</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="engine" transfer-ownership="none">
<doc xml:space="preserve">A #PeasEngine.</doc>
<type name="Engine" c:type="PeasEngine*"/>
</instance-parameter>
<parameter name="module_dir" transfer-ownership="none">
<doc xml:space="preserve">the plugin module directory.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="data_dir"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the plugin data directory.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="provides_extension"
c:identifier="peas_engine_provides_extension">
<doc xml:space="preserve">Returns if @info provides an extension for @extension_type.
If the @info is not loaded than %FALSE will always be returned.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">if @info provides an extension for @extension_type.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="engine" transfer-ownership="none">
<doc xml:space="preserve">A #PeasEngine.</doc>
<type name="Engine" c:type="PeasEngine*"/>
</instance-parameter>
<parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A #PeasPluginInfo.</doc>
<type name="PluginInfo" c:type="PeasPluginInfo*"/>
</parameter>
<parameter name="extension_type" transfer-ownership="none">
<doc xml:space="preserve">The extension #GType.</doc>
<type name="GType" c:type="GType"/>
</parameter>
</parameters>
</method>
<method name="rescan_plugins" c:identifier="peas_engine_rescan_plugins">
<doc xml:space="preserve">Rescan all the registered directories to find new or updated plugins.
Calling this function will make the newly installed plugin infos
be loaded by the engine, so the new plugins can be used without
restarting the application.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="engine" transfer-ownership="none">
<doc xml:space="preserve">A #PeasEngine.</doc>
<type name="Engine" c:type="PeasEngine*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_loaded_plugins"
c:identifier="peas_engine_set_loaded_plugins">
<doc xml:space="preserve">Sets the list of loaded plugins for @engine. When this function is called,
the #PeasEngine will load all the plugins whose names are in @plugin_names,
and ensures all other active plugins are unloaded.
If @plugin_names is %NULL, all plugins will be unloaded.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="engine" transfer-ownership="none">
<doc xml:space="preserve">A #PeasEngine.</doc>
<type name="Engine" c:type="PeasEngine*"/>
</instance-parameter>
<parameter name="plugin_names"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A %NULL-terminated
array of plugin names, or %NULL.</doc>
<array c:type="gchar**">
<type name="utf8" c:type="gchar*"/>
</array>
</parameter>
</parameters>
</method>
<method name="unload_plugin" c:identifier="peas_engine_unload_plugin">
<doc xml:space="preserve">Unloads the plugin corresponding to @info.
Emits the "unload-plugin" signal; unloading the plugin
actually occurs in the default signal handler.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">whether the plugin has been successfully unloaded.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="engine" transfer-ownership="none">
<doc xml:space="preserve">A #PeasEngine.</doc>
<type name="Engine" c:type="PeasEngine*"/>
</instance-parameter>
<parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A #PeasPluginInfo.</doc>
<type name="PluginInfo" c:type="PeasPluginInfo*"/>
</parameter>
</parameters>
</method>
<property name="loaded-plugins" writable="1" transfer-ownership="none">
<doc xml:space="preserve">The list of loaded plugins.
This will be modified when peas_engine_load_plugin() or
peas_engine_unload_plugin() is called.
This can be used with GSettings to save the loaded plugins by binding
to this property after instantiating the engine by doing:
|[
g_settings_bind (gsettings_object,
LOADED_PLUGINS_KEY,
engine,
"loaded-plugins",
G_SETTINGS_BIND_DEFAULT);
]|
Note: notify will not be called when the engine is being destroyed.</doc>
<array>
<type name="utf8"/>
</array>
</property>
<property name="nonglobal-loaders"
version="1.14"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve">If non-global plugin loaders should be used.
See peas_engine_new_with_nonglobal_loaders() for more information.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="plugin-list" transfer-ownership="none">
<doc xml:space="preserve">The list of found plugins.
This will be modified when peas_engine_rescan_plugins() is called.
Note that the list belongs to the engine and should not be modified
or freed.</doc>
<type name="gpointer" c:type="gpointer"/>
</property>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
<field name="priv" readable="0" private="1">
<type name="EnginePrivate" c:type="PeasEnginePrivate*"/>
</field>
<glib:signal name="load-plugin" when="last">
<doc xml:space="preserve">The load-plugin signal is emitted when a plugin is being loaded.
The plugin is being loaded in the default handler. Hence, if you want to
perform some action before the plugin is loaded, you should use
g_signal_connect(), but if you want to perform some action *after* the
plugin is loaded (the most common case), you should use
g_signal_connect_after().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A #PeasPluginInfo.</doc>
<type name="PluginInfo"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="unload-plugin" when="last">
<doc xml:space="preserve">The unload-plugin signal is emitted when a plugin is being unloaded.
The plugin is being unloaded in the default handler. Hence, if you want
to perform some action before the plugin is unloaded (the most common
case), you should use g_signal_connect(), but if you want to perform some
action after the plugin is unloaded (the most common case), you should
use g_signal_connect_after().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A #PeasPluginInfo.</doc>
<type name="PluginInfo"/>
</parameter>
</parameters>
</glib:signal>
</class>
<record name="EngineClass"
c:type="PeasEngineClass"
glib:is-gtype-struct-for="Engine">
<doc xml:space="preserve">Class structure for #PeasEngine.</doc>
<field name="parent_class">
<doc xml:space="preserve">The parent class.</doc>
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="load_plugin">
<callback name="load_plugin">
<return-value transfer-ownership="none">
<doc xml:space="preserve">whether the plugin has been successfully loaded.</doc>
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="engine" transfer-ownership="none">
<doc xml:space="preserve">A #PeasEngine.</doc>
<type name="Engine" c:type="PeasEngine*"/>
</parameter>
<parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A #PeasPluginInfo.</doc>
<type name="PluginInfo" c:type="PeasPluginInfo*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="unload_plugin">
<callback name="unload_plugin">
<return-value transfer-ownership="none">
<doc xml:space="preserve">whether the plugin has been successfully unloaded.</doc>
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="engine" transfer-ownership="none">
<doc xml:space="preserve">A #PeasEngine.</doc>
<type name="Engine" c:type="PeasEngine*"/>
</parameter>
<parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A #PeasPluginInfo.</doc>
<type name="PluginInfo" c:type="PeasPluginInfo*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="padding" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="8">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<record name="EnginePrivate" c:type="PeasEnginePrivate" disguised="1">
</record>
<class name="ExtensionBase"
c:symbol-prefix="extension_base"
c:type="PeasExtensionBase"
parent="GObject.Object"
abstract="1"
glib:type-name="PeasExtensionBase"
glib:get-type="peas_extension_base_get_type"
glib:type-struct="ExtensionBaseClass">
<doc xml:space="preserve">Base class for C extensions.</doc>
<method name="get_data_dir"
c:identifier="peas_extension_base_get_data_dir">
<doc xml:space="preserve">Get the path of the directory where the plugin should look for
its data files.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A newly allocated string with the path of the
directory where the plugin should look for its data files</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<instance-parameter name="extbase" transfer-ownership="none">
<doc xml:space="preserve">A #PeasExtensionBase.</doc>
<type name="ExtensionBase" c:type="PeasExtensionBase*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_plugin_info"
c:identifier="peas_extension_base_get_plugin_info">
<doc xml:space="preserve">Get information relative to @extbase.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the #PeasPluginInfo relative
to the #PeasExtensionBase.</doc>
<type name="PluginInfo" c:type="PeasPluginInfo*"/>
</return-value>
<parameters>
<instance-parameter name="extbase" transfer-ownership="none">
<doc xml:space="preserve">A #PeasExtensionBase.</doc>
<type name="ExtensionBase" c:type="PeasExtensionBase*"/>
</instance-parameter>
</parameters>
</method>
<property name="data-dir" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="plugin-info"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="PluginInfo"/>
</property>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
<field name="priv">
<type name="ExtensionBasePrivate" c:type="PeasExtensionBasePrivate*"/>
</field>
</class>
<record name="ExtensionBaseClass"
c:type="PeasExtensionBaseClass"
glib:is-gtype-struct-for="ExtensionBase">
<doc xml:space="preserve">The class structure of #PeasExtensionBase.</doc>
<field name="parent_class">
<doc xml:space="preserve">The parent class.</doc>
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="padding" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="8">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<record name="ExtensionBasePrivate"
c:type="PeasExtensionBasePrivate"
disguised="1">
</record>
<class name="ExtensionSet"
c:symbol-prefix="extension_set"
c:type="PeasExtensionSet"
parent="GObject.Object"
glib:type-name="PeasExtensionSet"
glib:get-type="peas_extension_set_get_type"
glib:type-struct="ExtensionSetClass">
<doc xml:space="preserve">The #PeasExtensionSet structure contains only private data and should only
be accessed using the provided API.</doc>
<constructor name="new"
c:identifier="peas_extension_set_new"
shadowed-by="newv"
introspectable="0">
<doc xml:space="preserve">Create a new #PeasExtensionSet for the @exten_type extension type.
At any moment, the #PeasExtensionSet will contain an extension instance for
each loaded plugin which implements the @exten_type extension type. It does
so by connecting to the relevant signals from #PeasEngine.
The property values passed to peas_extension_set_new() will be used for the
construction of new extension instances.
If @engine is %NULL, then the default engine will be used.
See peas_engine_create_extension() for more information.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new instance of #PeasExtensionSet.</doc>
<type name="ExtensionSet" c:type="PeasExtensionSet*"/>
</return-value>
<parameters>
<parameter name="engine"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A #PeasEngine, or %NULL.</doc>
<type name="Engine" c:type="PeasEngine*"/>
</parameter>
<parameter name="exten_type" transfer-ownership="none">
<doc xml:space="preserve">the extension #GType.</doc>
<type name="GType" c:type="GType"/>
</parameter>
<parameter name="first_property" transfer-ownership="none">
<doc xml:space="preserve">the name of the first property.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">the value of the first property, followed optionally by more
name/value pairs, followed by %NULL.</doc>
<varargs/>
</parameter>
</parameters>
</constructor>
<constructor name="new_valist"
c:identifier="peas_extension_set_new_valist"
introspectable="0">
<doc xml:space="preserve">Create a new #PeasExtensionSet for the @exten_type extension type.
If @engine is %NULL, then the default engine will be used.
See peas_extension_set_new() for more information.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new instance of #PeasExtensionSet.</doc>
<type name="ExtensionSet" c:type="PeasExtensionSet*"/>
</return-value>
<parameters>
<parameter name="engine"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A #PeasEngine, or %NULL.</doc>
<type name="Engine" c:type="PeasEngine*"/>
</parameter>
<parameter name="exten_type" transfer-ownership="none">
<doc xml:space="preserve">the extension #GType.</doc>
<type name="GType" c:type="GType"/>
</parameter>
<parameter name="first_property" transfer-ownership="none">
<doc xml:space="preserve">the name of the first property.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="var_args" transfer-ownership="none">
<doc xml:space="preserve">the value of the first property, followed optionally by more
name/value pairs, followed by %NULL.</doc>
<type name="va_list" c:type="va_list"/>
</parameter>
</parameters>
</constructor>
<constructor name="newv"
c:identifier="peas_extension_set_newv"
shadows="new">
<doc xml:space="preserve">Create a new #PeasExtensionSet for the @exten_type extension type.
If @engine is %NULL, then the default engine will be used.
See peas_extension_set_new() for more information.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new instance of #PeasExtensionSet.</doc>
<type name="ExtensionSet" c:type="PeasExtensionSet*"/>
</return-value>
<parameters>
<parameter name="engine"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A #PeasEngine, or %NULL.</doc>
<type name="Engine" c:type="PeasEngine*"/>
</parameter>
<parameter name="exten_type" transfer-ownership="none">
<doc xml:space="preserve">the extension #GType.</doc>
<type name="GType" c:type="GType"/>
</parameter>
<parameter name="n_parameters" transfer-ownership="none">
<doc xml:space="preserve">the length of the @parameters array.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="parameters" transfer-ownership="none">
<doc xml:space="preserve">an array of #GParameter.</doc>
<array length="2" zero-terminated="0" c:type="GParameter*">
<type name="GObject.Parameter" c:type="GParameter"/>
</array>
</parameter>
</parameters>
</constructor>
<virtual-method name="call">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="set" transfer-ownership="none">
<type name="ExtensionSet" c:type="PeasExtensionSet*"/>
</instance-parameter>
<parameter name="method_name" transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="args" transfer-ownership="none">
<type name="GIRepository.Argument" c:type="GIArgument*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="extension_added">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="set" transfer-ownership="none">
<type name="ExtensionSet" c:type="PeasExtensionSet*"/>
</instance-parameter>
<parameter name="info" transfer-ownership="none">
<type name="PluginInfo" c:type="PeasPluginInfo*"/>
</parameter>
<parameter name="exten" transfer-ownership="none">
<type name="Extension" c:type="PeasExtension*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="extension_removed">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="set" transfer-ownership="none">
<type name="ExtensionSet" c:type="PeasExtensionSet*"/>
</instance-parameter>
<parameter name="info" transfer-ownership="none">
<type name="PluginInfo" c:type="PeasPluginInfo*"/>
</parameter>
<parameter name="exten" transfer-ownership="none">
<type name="Extension" c:type="PeasExtension*"/>
</parameter>
</parameters>
</virtual-method>
<method name="foreach"
c:identifier="peas_extension_set_foreach"
version="1.2">
<doc xml:space="preserve">Calls @func for each #PeasExtension.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="set" transfer-ownership="none">
<doc xml:space="preserve">A #PeasExtensionSet.</doc>
<type name="ExtensionSet" c:type="PeasExtensionSet*"/>
</instance-parameter>
<parameter name="func"
transfer-ownership="none"
scope="call"
closure="1">
<doc xml:space="preserve">A function call for each extension.</doc>
<type name="ExtensionSetForeachFunc"
c:type="PeasExtensionSetForeachFunc"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">Optional data to be passed to the function or %NULL.</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</method>
<method name="get_extension"
c:identifier="peas_extension_set_get_extension">
<doc xml:space="preserve">Returns the #PeasExtension object corresponding to @info, or %NULL
if the plugin doesn't provide such an extension.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a reference to a #PeasExtension or %NULL</doc>
<type name="Extension" c:type="PeasExtension*"/>
</return-value>
<parameters>
<instance-parameter name="set" transfer-ownership="none">
<doc xml:space="preserve">A #PeasExtensionSet</doc>
<type name="ExtensionSet" c:type="PeasExtensionSet*"/>
</instance-parameter>
<parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #PeasPluginInfo</doc>
<type name="PluginInfo" c:type="PeasPluginInfo*"/>
</parameter>
</parameters>
</method>
<property name="construct-properties"
readable="0"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</property>
<property name="engine"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="Engine"/>
</property>
<property name="extension-type"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="GType" c:type="GType"/>
</property>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
<field name="priv">
<type name="ExtensionSetPrivate" c:type="PeasExtensionSetPrivate*"/>
</field>
<glib:signal name="extension-added" when="last">
<doc xml:space="preserve">The extension-added signal is emitted when a new extension has been
added to the #PeasExtensionSet. It happens when a new plugin implementing
the extension set's extension type is loaded.
You should connect to this signal in order to set up the extensions when
they are loaded. Note that this signal is not fired for extensions coming
from plugins that were already loaded when the #PeasExtensionSet instance
was created. You should set those up by yourself.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A #PeasPluginInfo.</doc>
<type name="PluginInfo"/>
</parameter>
<parameter name="exten" transfer-ownership="none">
<doc xml:space="preserve">A #PeasExtension.</doc>
<type name="GObject.Object"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="extension-removed" when="last">
<doc xml:space="preserve">The extension-removed signal is emitted when a new extension is about to be
removed from the #PeasExtensionSet. It happens when a plugin implementing
the extension set's extension type is unloaded, or when the
#PeasExtensionSet itself is destroyed.
You should connect to this signal in order to clean up the extensions
when their plugin is unload. Note that this signal is not fired for the
#PeasExtension instances still available when the #PeasExtensionSet
instance is destroyed. You should clean those up by yourself.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A #PeasPluginInfo.</doc>
<type name="PluginInfo"/>
</parameter>
<parameter name="exten" transfer-ownership="none">
<doc xml:space="preserve">A #PeasExtension.</doc>
<type name="GObject.Object"/>
</parameter>
</parameters>
</glib:signal>
</class>
<record name="ExtensionSetClass"
c:type="PeasExtensionSetClass"
glib:is-gtype-struct-for="ExtensionSet">
<doc xml:space="preserve">The class structure for #PeasExtensionSet.</doc>
<field name="parent_class">
<doc xml:space="preserve">The parent class.</doc>
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="call">
<callback name="call">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="set" transfer-ownership="none">
<type name="ExtensionSet" c:type="PeasExtensionSet*"/>
</parameter>
<parameter name="method_name" transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="args" transfer-ownership="none">
<type name="GIRepository.Argument" c:type="GIArgument*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="extension_added">
<callback name="extension_added">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="set" transfer-ownership="none">
<type name="ExtensionSet" c:type="PeasExtensionSet*"/>
</parameter>
<parameter name="info" transfer-ownership="none">
<type name="PluginInfo" c:type="PeasPluginInfo*"/>
</parameter>
<parameter name="exten" transfer-ownership="none">
<type name="Extension" c:type="PeasExtension*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="extension_removed">
<callback name="extension_removed">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="set" transfer-ownership="none">
<type name="ExtensionSet" c:type="PeasExtensionSet*"/>
</parameter>
<parameter name="info" transfer-ownership="none">
<type name="PluginInfo" c:type="PeasPluginInfo*"/>
</parameter>
<parameter name="exten" transfer-ownership="none">
<type name="Extension" c:type="PeasExtension*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="padding" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="8">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<callback name="ExtensionSetForeachFunc"
c:type="PeasExtensionSetForeachFunc"
version="1.2">
<doc xml:space="preserve">This function is passed to peas_extension_set_foreach() and
will be called for each extension in @set.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="set" transfer-ownership="none">
<doc xml:space="preserve">A #PeasExtensionSet.</doc>
<type name="ExtensionSet" c:type="PeasExtensionSet*"/>
</parameter>
<parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A #PeasPluginInfo.</doc>
<type name="PluginInfo" c:type="PeasPluginInfo*"/>
</parameter>
<parameter name="exten" transfer-ownership="none">
<doc xml:space="preserve">A #PeasExtension.</doc>
<type name="Extension" c:type="PeasExtension*"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">Optional data passed to the function.</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<record name="ExtensionSetPrivate"
c:type="PeasExtensionSetPrivate"
disguised="1">
</record>
<callback name="FactoryFunc" c:type="PeasFactoryFunc">
<doc xml:space="preserve">A #PeasFactoryFunc is a factory function which will instanciate a new
extension of a given type. g_object_newv() is such a function.
It is used with peas_object_module_register_extension_factory().</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">The created object.</doc>
<type name="GObject.Object" c:type="GObject*"/>
</return-value>
<parameters>
<parameter name="n_parameters" transfer-ownership="none">
<doc xml:space="preserve">The number of paramteters.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="parameters" transfer-ownership="none">
<doc xml:space="preserve">The parameters.</doc>
<array length="0" zero-terminated="0" c:type="GParameter*">
<type name="GObject.Parameter" c:type="GParameter"/>
</array>
</parameter>
<parameter name="user_data" transfer-ownership="none" closure="2">
<doc xml:space="preserve">Optional data to be passed to the function, or %NULL.</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<class name="ObjectModule"
c:symbol-prefix="object_module"
c:type="PeasObjectModule"
parent="GObject.TypeModule"
glib:type-name="PeasObjectModule"
glib:get-type="peas_object_module_get_type"
glib:type-struct="ObjectModuleClass">
<doc xml:space="preserve">The #PeasObjectModule structure contains only private data and should only
be accessed using the provided API.</doc>
<implements name="GObject.TypePlugin"/>
<constructor name="new"
c:identifier="peas_object_module_new"
introspectable="0">
<doc xml:space="preserve">Creates a new #PeasObjectModule.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #PeasObjectModule.</doc>
<type name="ObjectModule" c:type="PeasObjectModule*"/>
</return-value>
<parameters>
<parameter name="module_name" transfer-ownership="none">
<doc xml:space="preserve">The module name.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="path" transfer-ownership="none">
<doc xml:space="preserve">The path.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="resident" transfer-ownership="none">
<doc xml:space="preserve">If the module should be resident.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_full"
c:identifier="peas_object_module_new_full"
introspectable="0">
<doc xml:space="preserve">Creates a new #PeasObjectModule with local linkage.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #PeasObjectModule.
Since 1.14</doc>
<type name="ObjectModule" c:type="PeasObjectModule*"/>
</return-value>
<parameters>
<parameter name="module_name" transfer-ownership="none">
<doc xml:space="preserve">The module name.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="path" transfer-ownership="none">
<doc xml:space="preserve">The path.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="resident" transfer-ownership="none">
<doc xml:space="preserve">If the module should be resident.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
<parameter name="local_linkage" transfer-ownership="none">
<doc xml:space="preserve">Whether to load the module with local linkage.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</constructor>
<method name="create_object"
c:identifier="peas_object_module_create_object"
introspectable="0">
<doc xml:space="preserve">Creates an object for the @interface passing @n_parameters
and @parameters to the #PeasFactoryFunc. If @module does
not provide a #PeasFactoryFunc for @interface then
%NULL is returned.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">The created object, or %NULL.</doc>
<type name="GObject.Object" c:type="GObject*"/>
</return-value>
<parameters>
<instance-parameter name="module" transfer-ownership="none">
<doc xml:space="preserve">A #PeasObjectModule.</doc>
<type name="ObjectModule" c:type="PeasObjectModule*"/>
</instance-parameter>
<parameter name="interface" transfer-ownership="none">
<doc xml:space="preserve">The #GType of the extension interface.</doc>
<type name="GType" c:type="GType"/>
</parameter>
<parameter name="n_parameters" transfer-ownership="none">
<doc xml:space="preserve">The number of paramteters.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="parameters" transfer-ownership="none">
<doc xml:space="preserve">The parameters.</doc>
<array length="1" zero-terminated="0" c:type="GParameter*">
<type name="GObject.Parameter" c:type="GParameter"/>
</array>
</parameter>
</parameters>
</method>
<method name="get_library"
c:identifier="peas_object_module_get_library"
introspectable="0">
<doc xml:space="preserve">Gets the library.</doc>
<return-value>
<doc xml:space="preserve">the library.</doc>
<type name="GModule.Module" c:type="GModule*"/>
</return-value>
<parameters>
<instance-parameter name="module" transfer-ownership="none">
<doc xml:space="preserve">A #PeasObjectModule.</doc>
<type name="ObjectModule" c:type="PeasObjectModule*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_module_name"
c:identifier="peas_object_module_get_module_name"
introspectable="0">
<doc xml:space="preserve">Gets the module name.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the module name.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="module" transfer-ownership="none">
<doc xml:space="preserve">A #PeasObjectModule.</doc>
<type name="ObjectModule" c:type="PeasObjectModule*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_path"
c:identifier="peas_object_module_get_path"
introspectable="0">
<doc xml:space="preserve">Gets the path.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the path.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="module" transfer-ownership="none">
<doc xml:space="preserve">A #PeasObjectModule.</doc>
<type name="ObjectModule" c:type="PeasObjectModule*"/>
</instance-parameter>
</parameters>
</method>
<method name="provides_object"
c:identifier="peas_object_module_provides_object"
introspectable="0">
<doc xml:space="preserve">Determines if the module provides an extension for @interface.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">if the module provides an extension for @interface.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="module" transfer-ownership="none">
<doc xml:space="preserve">A #PeasObjectModule.</doc>
<type name="ObjectModule" c:type="PeasObjectModule*"/>
</instance-parameter>
<parameter name="interface" transfer-ownership="none">
<doc xml:space="preserve">The #GType of the extension interface.</doc>
<type name="GType" c:type="GType"/>
</parameter>
</parameters>
</method>
<method name="register_extension_factory"
c:identifier="peas_object_module_register_extension_factory">
<doc xml:space="preserve">Register an implementation for an extension type through a factory
function @factory_func which will instantiate the extension when
requested.
This method is primarily meant to be used by native bindings (like gtkmm),
creating native types which cannot be instantiated correctly using
g_object_new(). For other uses, you will usually prefer relying on
peas_object_module_register_extension_type().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="module" transfer-ownership="none">
<doc xml:space="preserve">Your plugin's #PeasObjectModule.</doc>
<type name="ObjectModule" c:type="PeasObjectModule*"/>
</instance-parameter>
<parameter name="iface_type" transfer-ownership="none">
<doc xml:space="preserve">The #GType of the extension interface you implement.</doc>
<type name="GType" c:type="GType"/>
</parameter>
<parameter name="factory_func"
transfer-ownership="none"
scope="notified"
closure="2"
destroy="3">
<doc xml:space="preserve">The #PeasFactoryFunc that will create the @iface_type
instance when requested.</doc>
<type name="FactoryFunc" c:type="PeasFactoryFunc"/>
</parameter>
<parameter name="user_data" transfer-ownership="none">
<doc xml:space="preserve">Data to pass to @func calls.</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="destroy_func"
transfer-ownership="none"
scope="async">
<doc xml:space="preserve">A #GDestroyNotify for @user_data.</doc>
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
</parameter>
</parameters>
</method>
<method name="register_extension_type"
c:identifier="peas_object_module_register_extension_type">
<doc xml:space="preserve">Register an extension type which implements the extension interface
@iface_type.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="module" transfer-ownership="none">
<doc xml:space="preserve">Your plugin's #PeasObjectModule.</doc>
<type name="ObjectModule" c:type="PeasObjectModule*"/>
</instance-parameter>
<parameter name="iface_type" transfer-ownership="none">
<doc xml:space="preserve">The #GType of the extension interface you implement.</doc>
<type name="GType" c:type="GType"/>
</parameter>
<parameter name="extension_type" transfer-ownership="none">
<doc xml:space="preserve">The #GType of your implementation of @iface_type.</doc>
<type name="GType" c:type="GType"/>
</parameter>
</parameters>
</method>
<property name="local-linkage"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve">This property indicates whether the module is loaded with
local linkage, i.e. #G_MODULE_BIND_LOCAL.
Since 1.14</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="module-name"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="path"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="resident"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<field name="parent">
<type name="GObject.TypeModule" c:type="GTypeModule"/>
</field>
<field name="priv">
<type name="ObjectModulePrivate" c:type="PeasObjectModulePrivate*"/>
</field>
</class>
<record name="ObjectModuleClass"
c:type="PeasObjectModuleClass"
glib:is-gtype-struct-for="ObjectModule">
<doc xml:space="preserve">The class structure for #PeasObjectModule.</doc>
<field name="parent_class">
<doc xml:space="preserve">The parent class.</doc>
<type name="GObject.TypeModuleClass" c:type="GTypeModuleClass"/>
</field>
<field name="padding" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="8">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<record name="ObjectModulePrivate"
c:type="PeasObjectModulePrivate"
disguised="1">
</record>
<record name="PluginInfo"
c:type="PeasPluginInfo"
glib:type-name="PeasPluginInfo"
glib:get-type="peas_plugin_info_get_type"
c:symbol-prefix="plugin_info">
<doc xml:space="preserve">The #PeasPluginInfo structure contains only private data and should only
be accessed using the provided API.</doc>
<method name="get_authors" c:identifier="peas_plugin_info_get_authors">
<doc xml:space="preserve">Gets a %NULL-terminated array of strings with the authors of the plugin.
The relevant key in the plugin info file is "Authors".</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the plugin's author list.</doc>
<array c:type="gchar**">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A #PeasPluginInfo.</doc>
<type name="PluginInfo" c:type="const PeasPluginInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_copyright"
c:identifier="peas_plugin_info_get_copyright">
<doc xml:space="preserve">Gets the copyright of the plugin.
The relevant key in the plugin info file is "Copyright".</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the plugin's copyright information.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A #PeasPluginInfo.</doc>
<type name="PluginInfo" c:type="const PeasPluginInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_data_dir" c:identifier="peas_plugin_info_get_data_dir">
<doc xml:space="preserve">Gets the data dir of the plugin.
The module data directory is the directory where a plugin should find its
runtime data. This is not a value read from the #GKeyFile, but rather a
value provided by the #PeasEngine, depending on where the plugin file was
found.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the plugin's data dir.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A #PeasPluginInfo.</doc>
<type name="PluginInfo" c:type="const PeasPluginInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_dependencies"
c:identifier="peas_plugin_info_get_dependencies">
<doc xml:space="preserve">Gets the dependencies of the plugin.
The #PeasEngine will always ensure that the dependencies of a plugin are
loaded when the said plugin is loaded. It means that dependencies are
loaded before the plugin, and unloaded after it. Circular dependencies of
plugins lead to undefined loading order.
The relevant key in the plugin info file is "Depends".</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the plugin's dependencies.</doc>
<array c:type="const gchar**">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A #PeasPluginInfo.</doc>
<type name="PluginInfo" c:type="const PeasPluginInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_description"
c:identifier="peas_plugin_info_get_description">
<doc xml:space="preserve">Gets the description of the plugin.
The description of the plugin should be a string presenting the purpose of
the plugin. It will typically be presented in a plugin's about box.
The relevant key in the plugin info file is "Description".</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the plugin's description.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A #PeasPluginInfo.</doc>
<type name="PluginInfo" c:type="const PeasPluginInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_external_data"
c:identifier="peas_plugin_info_get_external_data"
version="1.6">
<doc xml:space="preserve">Gets external data specified for the plugin.
External data is specified in the plugin info file prefixed with X-. For
example, if a key/value pair X-Peas=1 is specified in the key file, you
can use "Peas" for @key to retrieve the value "1".
Note: that you can omit the X- prefix when retrieving the value,
but not when specifying the value in the file.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the external data, or %NULL if the external data could not be found.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A #PeasPluginInfo.</doc>
<type name="PluginInfo" c:type="const PeasPluginInfo*"/>
</instance-parameter>
<parameter name="key" transfer-ownership="none">
<doc xml:space="preserve">The key to lookup.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_help_uri" c:identifier="peas_plugin_info_get_help_uri">
<doc xml:space="preserve">Gets the help URI of the plugin.
The Help URI of a plugin will typically be presented by the plugin manager
as a "Help" button linking to the URI. It can either be a HTTP URL on some
website or a ghelp: URI if a Gnome help page is available for the plugin.
The relevant key in the plugin info file is "Help". Other platform-specific
keys exist for platform-specific help files. Those are "Help-GNOME",
"Help-Windows" and "Help-MacOS-X".</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the plugin's help URI.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A #PeasPluginInfo.</doc>
<type name="PluginInfo" c:type="const PeasPluginInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_icon_name"
c:identifier="peas_plugin_info_get_icon_name">
<doc xml:space="preserve">Gets the icon name of the plugin.
The icon of the plugin will be presented in the plugin manager UI. If no
icon is specified, the default green puzzle icon will be used.
The relevant key in the plugin info file is "Icon".</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the plugin's icon name.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A #PeasPluginInfo.</doc>
<type name="PluginInfo" c:type="const PeasPluginInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_module_dir"
c:identifier="peas_plugin_info_get_module_dir">
<doc xml:space="preserve">Gets the module directory.
The module directory is the directory where the plugin file was found. This
is not a value from the #GKeyFile, but rather a value provided by the
#PeasEngine.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the module directory.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A #PeasPluginInfo.</doc>
<type name="PluginInfo" c:type="const PeasPluginInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_module_name"
c:identifier="peas_plugin_info_get_module_name">
<doc xml:space="preserve">Gets the module name.
The module name will be used to find the actual plugin. The way this value
will be used depends on the loader (i.e. on the language) of the plugin.
This value is also used to uniquely identify a particular plugin.
The relevant key in the plugin info file is "Module".</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the module name.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A #PeasPluginInfo.</doc>
<type name="PluginInfo" c:type="const PeasPluginInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_name" c:identifier="peas_plugin_info_get_name">
<doc xml:space="preserve">Gets the name of the plugin.
The name of a plugin should be a nice short string to be presented in UIs.
The relevant key in the plugin info file is "Name".</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the plugin's name.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A #PeasPluginInfo.</doc>
<type name="PluginInfo" c:type="const PeasPluginInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_settings"
c:identifier="peas_plugin_info_get_settings"
version="1.4">
<doc xml:space="preserve">Creates a new #GSettings for the given @schema_id and if
gschemas.compiled is not in the module directory an attempt
will be made to create it.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #GSettings, or %NULL.</doc>
<type name="Gio.Settings" c:type="GSettings*"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A #PeasPluginInfo.</doc>
<type name="PluginInfo" c:type="const PeasPluginInfo*"/>
</instance-parameter>
<parameter name="schema_id"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">The schema id.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_version" c:identifier="peas_plugin_info_get_version">
<doc xml:space="preserve">Gets the version of the plugin.
The relevant key in the plugin info file is "Version".</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the plugin's version.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A #PeasPluginInfo.</doc>
<type name="PluginInfo" c:type="const PeasPluginInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_website" c:identifier="peas_plugin_info_get_website">
<doc xml:space="preserve">Gets the website of the plugin.
The relevant key in the plugin info file is "Website".</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the plugin's associated website.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A #PeasPluginInfo.</doc>
<type name="PluginInfo" c:type="const PeasPluginInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="has_dependency"
c:identifier="peas_plugin_info_has_dependency">
<doc xml:space="preserve">Check if the plugin depends on another plugin.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">whether the plugin depends on the plugin @module_name.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A #PeasPluginInfo.</doc>
<type name="PluginInfo" c:type="const PeasPluginInfo*"/>
</instance-parameter>
<parameter name="module_name" transfer-ownership="none">
<doc xml:space="preserve">The name of the plugin to check.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="is_available"
c:identifier="peas_plugin_info_is_available"
throws="1">
<doc xml:space="preserve">Check if the plugin is available.
A plugin is marked as not available when there is no loader available to
load it, or when there has been an error when trying to load it previously.
If not available then @error will be set.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the plugin is available.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A #PeasPluginInfo.</doc>
<type name="PluginInfo" c:type="const PeasPluginInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_builtin" c:identifier="peas_plugin_info_is_builtin">
<doc xml:space="preserve">Check if the plugin is a builtin plugin.
A builtin plugin is a plugin which cannot be enabled or disabled by the
user through a plugin manager (like #PeasGtkPluginManager). Loading or
unloading such plugins is the responsibility of the application alone.
Most applications will usually load those plugins immediately after
the initialization of the #PeasEngine.
The relevant key in the plugin info file is "Builtin".</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the plugin is a builtin plugin, %FALSE
if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A #PeasPluginInfo.</doc>
<type name="PluginInfo" c:type="const PeasPluginInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_hidden" c:identifier="peas_plugin_info_is_hidden">
<doc xml:space="preserve">Check if the plugin is a hidden plugin.
A hidden plugin is a plugin which cannot be seen by a
user through a plugin manager (like #PeasGtkPluginManager). Loading and
unloading such plugins is the responsibility of the application alone or
through plugins that depend on them.
The relevant key in the plugin info file is "Hidden".</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the plugin is a hidden plugin, %FALSE
if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A #PeasPluginInfo.</doc>
<type name="PluginInfo" c:type="const PeasPluginInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_loaded" c:identifier="peas_plugin_info_is_loaded">
<doc xml:space="preserve">Check if the plugin is loaded.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the plugin is loaded.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">A #PeasPluginInfo.</doc>
<type name="PluginInfo" c:type="const PeasPluginInfo*"/>
</instance-parameter>
</parameters>
</method>
<function name="error_quark" c:identifier="peas_plugin_info_error_quark">
<return-value transfer-ownership="none">
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
</record>
<enumeration name="PluginInfoError"
c:type="PeasPluginInfoError"
glib:error-domain="peas-plugin-info-error">
<doc xml:space="preserve">These identify the various errors that can occur while
loading a plugin.</doc>
<member name="loading_failed"
value="0"
c:identifier="PEAS_PLUGIN_INFO_ERROR_LOADING_FAILED">
<doc xml:space="preserve">The plugin failed to load.</doc>
</member>
<member name="loader_not_found"
value="1"
c:identifier="PEAS_PLUGIN_INFO_ERROR_LOADER_NOT_FOUND">
<doc xml:space="preserve">The plugin's loader was not found.</doc>
</member>
<member name="dep_not_found"
value="2"
c:identifier="PEAS_PLUGIN_INFO_ERROR_DEP_NOT_FOUND">
<doc xml:space="preserve">A dependency of the plugin was not found.</doc>
</member>
<member name="dep_loading_failed"
value="3"
c:identifier="PEAS_PLUGIN_INFO_ERROR_DEP_LOADING_FAILED">
<doc xml:space="preserve">A dependency of the plugin failed to load.</doc>
</member>
</enumeration>
<function name="plugin_info_error_quark"
c:identifier="peas_plugin_info_error_quark"
moved-to="PluginInfo.error_quark">
<return-value transfer-ownership="none">
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
</namespace>
</repository>
|