gtk4/auto/list_box.rs
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
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT
use crate::{
ffi, Accessible, AccessibleRole, Adjustment, Align, Buildable, ConstraintTarget, LayoutManager,
ListBoxRow, MovementStep, Overflow, SelectionMode, Widget,
};
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::boxed::Box as Box_;
glib::wrapper! {
/// [`ListBox`][crate::ListBox] is a vertical list.
///
/// A [`ListBox`][crate::ListBox] only contains [`ListBoxRow`][crate::ListBoxRow] children. These rows can
/// by dynamically sorted and filtered, and headers can be added dynamically
/// depending on the row content. It also allows keyboard and mouse navigation
/// and selection like a typical list.
///
/// Using [`ListBox`][crate::ListBox] is often an alternative to [`TreeView`][crate::TreeView], especially
/// when the list contents has a more complicated layout than what is allowed
/// by a [`CellRenderer`][crate::CellRenderer], or when the contents is interactive (i.e. has a
/// button in it).
///
/// Although a [`ListBox`][crate::ListBox] must have only [`ListBoxRow`][crate::ListBoxRow] children, you can
/// add any kind of widget to it via [`prepend()`][Self::prepend()],
/// [`append()`][Self::append()] and [`insert()`][Self::insert()] and a
/// [`ListBoxRow`][crate::ListBoxRow] widget will automatically be inserted between the list
/// and the widget.
///
/// `GtkListBoxRows` can be marked as activatable or selectable. If a row is
/// activatable, [`row-activated`][struct@crate::ListBox#row-activated] will be emitted for it when
/// the user tries to activate it. If it is selectable, the row will be marked
/// as selected when the user tries to select it.
///
/// # GtkListBox as GtkBuildable
///
/// The [`ListBox`][crate::ListBox] implementation of the [`Buildable`][crate::Buildable] interface supports
/// setting a child as the placeholder by specifying “placeholder” as the “type”
/// attribute of a `<child>` element. See [`set_placeholder()`][Self::set_placeholder()]
/// for info.
///
/// # Shortcuts and Gestures
///
/// The following signals have default keybindings:
///
/// - [`move-cursor`][struct@crate::ListBox#move-cursor]
/// - [`select-all`][struct@crate::ListBox#select-all]
/// - [`toggle-cursor-row`][struct@crate::ListBox#toggle-cursor-row]
/// - [`unselect-all`][struct@crate::ListBox#unselect-all]
///
/// # CSS nodes
///
///
///
/// **⚠️ The following code is in plain ⚠️**
///
/// ```plain
/// list[.separators][.rich-list][.navigation-sidebar][.boxed-list]
/// ╰── row[.activatable]
/// ```
///
/// [`ListBox`][crate::ListBox] uses a single CSS node named list. It may carry the .separators
/// style class, when the [`show-separators`][struct@crate::ListBox#show-separators] property is set.
/// Each [`ListBoxRow`][crate::ListBoxRow] uses a single CSS node named row. The row nodes get the
/// .activatable style class added when appropriate.
///
/// It may also carry the .boxed-list style class. In this case, the list will be
/// automatically surrounded by a frame and have separators.
///
/// The main list node may also carry style classes to select
/// the style of [list presentation](section-list-widget.html#list-styles):
/// .rich-list, .navigation-sidebar or .data-table.
///
/// # Accessibility
///
/// [`ListBox`][crate::ListBox] uses the [`AccessibleRole::List`][crate::AccessibleRole::List] role and [`ListBoxRow`][crate::ListBoxRow] uses
/// the [`AccessibleRole::ListItem`][crate::AccessibleRole::ListItem] role.
///
/// ## Properties
///
///
/// #### `accept-unpaired-release`
/// Whether to accept unpaired release events.
///
/// Readable | Writeable
///
///
/// #### `activate-on-single-click`
/// Determines whether children can be activated with a single
/// click, or require a double-click.
///
/// Readable | Writeable
///
///
/// #### `selection-mode`
/// The selection mode used by the list box.
///
/// Readable | Writeable
///
///
/// #### `show-separators`
/// Whether to show separators between rows.
///
/// Readable | Writeable
/// <details><summary><h4>Widget</h4></summary>
///
///
/// #### `can-focus`
/// Whether the widget or any of its descendents can accept
/// the input focus.
///
/// This property is meant to be set by widget implementations,
/// typically in their instance init function.
///
/// Readable | Writeable
///
///
/// #### `can-target`
/// Whether the widget can receive pointer events.
///
/// Readable | Writeable
///
///
/// #### `css-classes`
/// A list of css classes applied to this widget.
///
/// Readable | Writeable
///
///
/// #### `css-name`
/// The name of this widget in the CSS tree.
///
/// This property is meant to be set by widget implementations,
/// typically in their instance init function.
///
/// Readable | Writeable | Construct Only
///
///
/// #### `cursor`
/// The cursor used by @widget.
///
/// Readable | Writeable
///
///
/// #### `focus-on-click`
/// Whether the widget should grab focus when it is clicked with the mouse.
///
/// This property is only relevant for widgets that can take focus.
///
/// Readable | Writeable
///
///
/// #### `focusable`
/// Whether this widget itself will accept the input focus.
///
/// Readable | Writeable
///
///
/// #### `halign`
/// How to distribute horizontal space if widget gets extra space.
///
/// Readable | Writeable
///
///
/// #### `has-default`
/// Whether the widget is the default widget.
///
/// Readable
///
///
/// #### `has-focus`
/// Whether the widget has the input focus.
///
/// Readable
///
///
/// #### `has-tooltip`
/// Enables or disables the emission of the ::query-tooltip signal on @widget.
///
/// A value of [`true`] indicates that @widget can have a tooltip, in this case
/// the widget will be queried using [`query-tooltip`][struct@crate::Widget#query-tooltip] to
/// determine whether it will provide a tooltip or not.
///
/// Readable | Writeable
///
///
/// #### `height-request`
/// Override for height request of the widget.
///
/// If this is -1, the natural request will be used.
///
/// Readable | Writeable
///
///
/// #### `hexpand`
/// Whether to expand horizontally.
///
/// Readable | Writeable
///
///
/// #### `hexpand-set`
/// Whether to use the `hexpand` property.
///
/// Readable | Writeable
///
///
/// #### `layout-manager`
/// The [`LayoutManager`][crate::LayoutManager] instance to use to compute the preferred size
/// of the widget, and allocate its children.
///
/// This property is meant to be set by widget implementations,
/// typically in their instance init function.
///
/// Readable | Writeable
///
///
/// #### `margin-bottom`
/// Margin on bottom side of widget.
///
/// This property adds margin outside of the widget's normal size
/// request, the margin will be added in addition to the size from
/// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
///
/// Readable | Writeable
///
///
/// #### `margin-end`
/// Margin on end of widget, horizontally.
///
/// This property supports left-to-right and right-to-left text
/// directions.
///
/// This property adds margin outside of the widget's normal size
/// request, the margin will be added in addition to the size from
/// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
///
/// Readable | Writeable
///
///
/// #### `margin-start`
/// Margin on start of widget, horizontally.
///
/// This property supports left-to-right and right-to-left text
/// directions.
///
/// This property adds margin outside of the widget's normal size
/// request, the margin will be added in addition to the size from
/// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
///
/// Readable | Writeable
///
///
/// #### `margin-top`
/// Margin on top side of widget.
///
/// This property adds margin outside of the widget's normal size
/// request, the margin will be added in addition to the size from
/// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
///
/// Readable | Writeable
///
///
/// #### `name`
/// The name of the widget.
///
/// Readable | Writeable
///
///
/// #### `opacity`
/// The requested opacity of the widget.
///
/// Readable | Writeable
///
///
/// #### `overflow`
/// How content outside the widget's content area is treated.
///
/// This property is meant to be set by widget implementations,
/// typically in their instance init function.
///
/// Readable | Writeable
///
///
/// #### `parent`
/// The parent widget of this widget.
///
/// Readable
///
///
/// #### `receives-default`
/// Whether the widget will receive the default action when it is focused.
///
/// Readable | Writeable
///
///
/// #### `root`
/// The [`Root`][crate::Root] widget of the widget tree containing this widget.
///
/// This will be [`None`] if the widget is not contained in a root widget.
///
/// Readable
///
///
/// #### `scale-factor`
/// The scale factor of the widget.
///
/// Readable
///
///
/// #### `sensitive`
/// Whether the widget responds to input.
///
/// Readable | Writeable
///
///
/// #### `tooltip-markup`
/// Sets the text of tooltip to be the given string, which is marked up
/// with Pango markup.
///
/// Also see [`Tooltip::set_markup()`][crate::Tooltip::set_markup()].
///
/// This is a convenience property which will take care of getting the
/// tooltip shown if the given string is not [`None`]:
/// [`has-tooltip`][struct@crate::Widget#has-tooltip] will automatically be set to [`true`]
/// and there will be taken care of [`query-tooltip`][struct@crate::Widget#query-tooltip] in
/// the default signal handler.
///
/// Note that if both [`tooltip-text`][struct@crate::Widget#tooltip-text] and
/// [`tooltip-markup`][struct@crate::Widget#tooltip-markup] are set, the last one wins.
///
/// Readable | Writeable
///
///
/// #### `tooltip-text`
/// Sets the text of tooltip to be the given string.
///
/// Also see [`Tooltip::set_text()`][crate::Tooltip::set_text()].
///
/// This is a convenience property which will take care of getting the
/// tooltip shown if the given string is not [`None`]:
/// [`has-tooltip`][struct@crate::Widget#has-tooltip] will automatically be set to [`true`]
/// and there will be taken care of [`query-tooltip`][struct@crate::Widget#query-tooltip] in
/// the default signal handler.
///
/// Note that if both [`tooltip-text`][struct@crate::Widget#tooltip-text] and
/// [`tooltip-markup`][struct@crate::Widget#tooltip-markup] are set, the last one wins.
///
/// Readable | Writeable
///
///
/// #### `valign`
/// How to distribute vertical space if widget gets extra space.
///
/// Readable | Writeable
///
///
/// #### `vexpand`
/// Whether to expand vertically.
///
/// Readable | Writeable
///
///
/// #### `vexpand-set`
/// Whether to use the `vexpand` property.
///
/// Readable | Writeable
///
///
/// #### `visible`
/// Whether the widget is visible.
///
/// Readable | Writeable
///
///
/// #### `width-request`
/// Override for width request of the widget.
///
/// If this is -1, the natural request will be used.
///
/// Readable | Writeable
/// </details>
/// <details><summary><h4>Accessible</h4></summary>
///
///
/// #### `accessible-role`
/// The accessible role of the given [`Accessible`][crate::Accessible] implementation.
///
/// The accessible role cannot be changed once set.
///
/// Readable | Writeable
/// </details>
///
/// ## Signals
///
///
/// #### `activate-cursor-row`
/// Emitted when the cursor row is activated.
///
/// Action
///
///
/// #### `move-cursor`
/// Emitted when the user initiates a cursor movement.
///
/// The default bindings for this signal come in two variants, the variant with
/// the Shift modifier extends the selection, the variant without the Shift
/// modifier does not. There are too many key combinations to list them all
/// here.
///
/// - <kbd>←</kbd>, <kbd>→</kbd>, <kbd>↑</kbd>, <kbd>↓</kbd>
/// move by individual children
/// - <kbd>Home</kbd>, <kbd>End</kbd> move to the ends of the box
/// - <kbd>PgUp</kbd>, <kbd>PgDn</kbd> move vertically by pages
///
/// Action
///
///
/// #### `row-activated`
/// Emitted when a row has been activated by the user.
///
///
///
///
/// #### `row-selected`
/// Emitted when a new row is selected, or (with a [`None`] @row)
/// when the selection is cleared.
///
/// When the @box_ is using [`SelectionMode::Multiple`][crate::SelectionMode::Multiple], this signal will not
/// give you the full picture of selection changes, and you should use
/// the [`selected-rows-changed`][struct@crate::ListBox#selected-rows-changed] signal instead.
///
///
///
///
/// #### `select-all`
/// Emitted to select all children of the box, if the selection
/// mode permits it.
///
/// This is a [keybinding signal](class.SignalAction.html).
///
/// The default binding for this signal is <kbd>Ctrl</kbd>-<kbd>a</kbd>.
///
/// Action
///
///
/// #### `selected-rows-changed`
/// Emitted when the set of selected rows changes.
///
///
///
///
/// #### `toggle-cursor-row`
/// Emitted when the cursor row is toggled.
///
/// The default bindings for this signal is <kbd>Ctrl</kbd>+<kbd>␣</kbd>.
///
/// Action
///
///
/// #### `unselect-all`
/// Emitted to unselect all children of the box, if the selection
/// mode permits it.
///
/// This is a [keybinding signal](class.SignalAction.html).
///
/// The default binding for this signal is
/// <kbd>Ctrl</kbd>-<kbd>Shift</kbd>-<kbd>a</kbd>.
///
/// Action
/// <details><summary><h4>Widget</h4></summary>
///
///
/// #### `destroy`
/// Signals that all holders of a reference to the widget should release
/// the reference that they hold.
///
/// May result in finalization of the widget if all references are released.
///
/// This signal is not suitable for saving widget state.
///
///
///
///
/// #### `direction-changed`
/// Emitted when the text direction of a widget changes.
///
///
///
///
/// #### `hide`
/// Emitted when @widget is hidden.
///
///
///
///
/// #### `keynav-failed`
/// Emitted if keyboard navigation fails.
///
/// See [`WidgetExt::keynav_failed()`][crate::prelude::WidgetExt::keynav_failed()] for details.
///
///
///
///
/// #### `map`
/// Emitted when @widget is going to be mapped.
///
/// A widget is mapped when the widget is visible (which is controlled with
/// [`visible`][struct@crate::Widget#visible]) and all its parents up to the toplevel widget
/// are also visible.
///
/// The ::map signal can be used to determine whether a widget will be drawn,
/// for instance it can resume an animation that was stopped during the
/// emission of [`unmap`][struct@crate::Widget#unmap].
///
///
///
///
/// #### `mnemonic-activate`
/// Emitted when a widget is activated via a mnemonic.
///
/// The default handler for this signal activates @widget if @group_cycling
/// is [`false`], or just makes @widget grab focus if @group_cycling is [`true`].
///
///
///
///
/// #### `move-focus`
/// Emitted when the focus is moved.
///
/// The ::move-focus signal is a [keybinding signal](class.SignalAction.html).
///
/// The default bindings for this signal are <kbd>Tab</kbd> to move forward,
/// and <kbd>Shift</kbd>+<kbd>Tab</kbd> to move backward.
///
/// Action
///
///
/// #### `query-tooltip`
/// Emitted when the widget’s tooltip is about to be shown.
///
/// This happens when the [`has-tooltip`][struct@crate::Widget#has-tooltip] property
/// is [`true`] and the hover timeout has expired with the cursor hovering
/// "above" @widget; or emitted when @widget got focus in keyboard mode.
///
/// Using the given coordinates, the signal handler should determine
/// whether a tooltip should be shown for @widget. If this is the case
/// [`true`] should be returned, [`false`] otherwise. Note that if
/// @keyboard_mode is [`true`], the values of @x and @y are undefined and
/// should not be used.
///
/// The signal handler is free to manipulate @tooltip with the therefore
/// destined function calls.
///
///
///
///
/// #### `realize`
/// Emitted when @widget is associated with a [`gdk::Surface`][crate::gdk::Surface].
///
/// This means that [`WidgetExt::realize()`][crate::prelude::WidgetExt::realize()] has been called
/// or the widget has been mapped (that is, it is going to be drawn).
///
///
///
///
/// #### `show`
/// Emitted when @widget is shown.
///
///
///
///
/// #### `state-flags-changed`
/// Emitted when the widget state changes.
///
/// See [`WidgetExt::state_flags()`][crate::prelude::WidgetExt::state_flags()].
///
///
///
///
/// #### `unmap`
/// Emitted when @widget is going to be unmapped.
///
/// A widget is unmapped when either it or any of its parents up to the
/// toplevel widget have been set as hidden.
///
/// As ::unmap indicates that a widget will not be shown any longer,
/// it can be used to, for example, stop an animation on the widget.
///
///
///
///
/// #### `unrealize`
/// Emitted when the [`gdk::Surface`][crate::gdk::Surface] associated with @widget is destroyed.
///
/// This means that [`WidgetExt::unrealize()`][crate::prelude::WidgetExt::unrealize()] has been called
/// or the widget has been unmapped (that is, it is going to be hidden).
///
///
/// </details>
///
/// # Implements
///
/// [`WidgetExt`][trait@crate::prelude::WidgetExt], [`trait@glib::ObjectExt`], [`AccessibleExt`][trait@crate::prelude::AccessibleExt], [`BuildableExt`][trait@crate::prelude::BuildableExt], [`ConstraintTargetExt`][trait@crate::prelude::ConstraintTargetExt], [`WidgetExtManual`][trait@crate::prelude::WidgetExtManual], [`AccessibleExtManual`][trait@crate::prelude::AccessibleExtManual]
#[doc(alias = "GtkListBox")]
pub struct ListBox(Object<ffi::GtkListBox>) @extends Widget, @implements Accessible, Buildable, ConstraintTarget;
match fn {
type_ => || ffi::gtk_list_box_get_type(),
}
}
impl ListBox {
/// Creates a new [`ListBox`][crate::ListBox] container.
///
/// # Returns
///
/// a new [`ListBox`][crate::ListBox]
#[doc(alias = "gtk_list_box_new")]
pub fn new() -> ListBox {
assert_initialized_main_thread!();
unsafe { Widget::from_glib_none(ffi::gtk_list_box_new()).unsafe_cast() }
}
// rustdoc-stripper-ignore-next
/// Creates a new builder-pattern struct instance to construct [`ListBox`] objects.
///
/// This method returns an instance of [`ListBoxBuilder`](crate::builders::ListBoxBuilder) which can be used to create [`ListBox`] objects.
pub fn builder() -> ListBoxBuilder {
ListBoxBuilder::new()
}
/// Append a widget to the list.
///
/// If a sort function is set, the widget will
/// actually be inserted at the calculated position.
/// ## `child`
/// the [`Widget`][crate::Widget] to add
#[doc(alias = "gtk_list_box_append")]
pub fn append(&self, child: &impl IsA<Widget>) {
unsafe {
ffi::gtk_list_box_append(self.to_glib_none().0, child.as_ref().to_glib_none().0);
}
}
/// Binds @model to @self.
///
/// If @self was already bound to a model, that previous binding is
/// destroyed.
///
/// The contents of @self are cleared and then filled with widgets that
/// represent items from @model. @self is updated whenever @model changes.
/// If @model is [`None`], @self is left empty.
///
/// It is undefined to add or remove widgets directly (for example, with
/// [`insert()`][Self::insert()]) while @self is bound to a model.
///
/// Note that using a model is incompatible with the filtering and sorting
/// functionality in [`ListBox`][crate::ListBox]. When using a model, filtering and sorting
/// should be implemented by the model.
/// ## `model`
/// the `GListModel` to be bound to @self
/// ## `create_widget_func`
/// a function
/// that creates widgets for items or [`None`] in case you also passed [`None`] as @model
#[doc(alias = "gtk_list_box_bind_model")]
pub fn bind_model<P: Fn(&glib::Object) -> Widget + 'static>(
&self,
model: Option<&impl IsA<gio::ListModel>>,
create_widget_func: P,
) {
let create_widget_func_data: Box_<P> = Box_::new(create_widget_func);
unsafe extern "C" fn create_widget_func_func<P: Fn(&glib::Object) -> Widget + 'static>(
item: *mut glib::gobject_ffi::GObject,
user_data: glib::ffi::gpointer,
) -> *mut ffi::GtkWidget {
let item = from_glib_borrow(item);
let callback = &*(user_data as *mut P);
(*callback)(&item).to_glib_full()
}
let create_widget_func = Some(create_widget_func_func::<P> as _);
unsafe extern "C" fn user_data_free_func_func<P: Fn(&glib::Object) -> Widget + 'static>(
data: glib::ffi::gpointer,
) {
let _callback = Box_::from_raw(data as *mut P);
}
let destroy_call4 = Some(user_data_free_func_func::<P> as _);
let super_callback0: Box_<P> = create_widget_func_data;
unsafe {
ffi::gtk_list_box_bind_model(
self.to_glib_none().0,
model.map(|p| p.as_ref()).to_glib_none().0,
create_widget_func,
Box_::into_raw(super_callback0) as *mut _,
destroy_call4,
);
}
}
/// Add a drag highlight to a row.
///
/// This is a helper function for implementing DnD onto a [`ListBox`][crate::ListBox].
/// The passed in @row will be highlighted by setting the
/// [`StateFlags::DROP_ACTIVE`][crate::StateFlags::DROP_ACTIVE] state and any previously highlighted
/// row will be unhighlighted.
///
/// The row will also be unhighlighted when the widget gets
/// a drag leave event.
/// ## `row`
/// a [`ListBoxRow`][crate::ListBoxRow]
#[doc(alias = "gtk_list_box_drag_highlight_row")]
pub fn drag_highlight_row(&self, row: &impl IsA<ListBoxRow>) {
unsafe {
ffi::gtk_list_box_drag_highlight_row(
self.to_glib_none().0,
row.as_ref().to_glib_none().0,
);
}
}
/// If a row has previously been highlighted via gtk_list_box_drag_highlight_row(),
/// it will have the highlight removed.
#[doc(alias = "gtk_list_box_drag_unhighlight_row")]
pub fn drag_unhighlight_row(&self) {
unsafe {
ffi::gtk_list_box_drag_unhighlight_row(self.to_glib_none().0);
}
}
/// Returns whether rows activate on single clicks.
///
/// # Returns
///
/// [`true`] if rows are activated on single click, [`false`] otherwise
#[doc(alias = "gtk_list_box_get_activate_on_single_click")]
#[doc(alias = "get_activate_on_single_click")]
#[doc(alias = "activate-on-single-click")]
pub fn activates_on_single_click(&self) -> bool {
unsafe {
from_glib(ffi::gtk_list_box_get_activate_on_single_click(
self.to_glib_none().0,
))
}
}
/// Gets the adjustment (if any) that the widget uses to
/// for vertical scrolling.
///
/// # Returns
///
/// the adjustment
#[doc(alias = "gtk_list_box_get_adjustment")]
#[doc(alias = "get_adjustment")]
pub fn adjustment(&self) -> Option<Adjustment> {
unsafe { from_glib_none(ffi::gtk_list_box_get_adjustment(self.to_glib_none().0)) }
}
/// Gets the n-th child in the list (not counting headers).
///
/// If @index_ is negative or larger than the number of items in the
/// list, [`None`] is returned.
/// ## `index_`
/// the index of the row
///
/// # Returns
///
/// the child [`Widget`][crate::Widget]
#[doc(alias = "gtk_list_box_get_row_at_index")]
#[doc(alias = "get_row_at_index")]
pub fn row_at_index(&self, index_: i32) -> Option<ListBoxRow> {
unsafe {
from_glib_none(ffi::gtk_list_box_get_row_at_index(
self.to_glib_none().0,
index_,
))
}
}
/// Gets the row at the @y position.
/// ## `y`
/// position
///
/// # Returns
///
/// the row
#[doc(alias = "gtk_list_box_get_row_at_y")]
#[doc(alias = "get_row_at_y")]
pub fn row_at_y(&self, y: i32) -> Option<ListBoxRow> {
unsafe { from_glib_none(ffi::gtk_list_box_get_row_at_y(self.to_glib_none().0, y)) }
}
/// Gets the selected row, or [`None`] if no rows are selected.
///
/// Note that the box may allow multiple selection, in which
/// case you should use [`selected_foreach()`][Self::selected_foreach()] to
/// find all selected rows.
///
/// # Returns
///
/// the selected row
#[doc(alias = "gtk_list_box_get_selected_row")]
#[doc(alias = "get_selected_row")]
pub fn selected_row(&self) -> Option<ListBoxRow> {
unsafe { from_glib_none(ffi::gtk_list_box_get_selected_row(self.to_glib_none().0)) }
}
/// Creates a list of all selected children.
///
/// # Returns
///
///
/// A `GList` containing the [`Widget`][crate::Widget] for each selected child.
/// Free with g_list_free() when done.
#[doc(alias = "gtk_list_box_get_selected_rows")]
#[doc(alias = "get_selected_rows")]
pub fn selected_rows(&self) -> Vec<ListBoxRow> {
unsafe {
FromGlibPtrContainer::from_glib_container(ffi::gtk_list_box_get_selected_rows(
self.to_glib_none().0,
))
}
}
/// Gets the selection mode of the listbox.
///
/// # Returns
///
/// a [`SelectionMode`][crate::SelectionMode]
#[doc(alias = "gtk_list_box_get_selection_mode")]
#[doc(alias = "get_selection_mode")]
#[doc(alias = "selection-mode")]
pub fn selection_mode(&self) -> SelectionMode {
unsafe { from_glib(ffi::gtk_list_box_get_selection_mode(self.to_glib_none().0)) }
}
/// Returns whether the list box should show separators
/// between rows.
///
/// # Returns
///
/// [`true`] if the list box shows separators
#[doc(alias = "gtk_list_box_get_show_separators")]
#[doc(alias = "get_show_separators")]
#[doc(alias = "show-separators")]
pub fn shows_separators(&self) -> bool {
unsafe { from_glib(ffi::gtk_list_box_get_show_separators(self.to_glib_none().0)) }
}
/// Insert the @child into the @self at @position.
///
/// If a sort function is
/// set, the widget will actually be inserted at the calculated position.
///
/// If @position is -1, or larger than the total number of items in the
/// @self, then the @child will be appended to the end.
/// ## `child`
/// the [`Widget`][crate::Widget] to add
/// ## `position`
/// the position to insert @child in
#[doc(alias = "gtk_list_box_insert")]
pub fn insert(&self, child: &impl IsA<Widget>, position: i32) {
unsafe {
ffi::gtk_list_box_insert(
self.to_glib_none().0,
child.as_ref().to_glib_none().0,
position,
);
}
}
/// Update the filtering for all rows.
///
/// Call this when result
/// of the filter function on the @self is changed due
/// to an external factor. For instance, this would be used
/// if the filter function just looked for a specific search
/// string and the entry with the search string has changed.
#[doc(alias = "gtk_list_box_invalidate_filter")]
pub fn invalidate_filter(&self) {
unsafe {
ffi::gtk_list_box_invalidate_filter(self.to_glib_none().0);
}
}
/// Update the separators for all rows.
///
/// Call this when result
/// of the header function on the @self is changed due
/// to an external factor.
#[doc(alias = "gtk_list_box_invalidate_headers")]
pub fn invalidate_headers(&self) {
unsafe {
ffi::gtk_list_box_invalidate_headers(self.to_glib_none().0);
}
}
/// Update the sorting for all rows.
///
/// Call this when result
/// of the sort function on the @self is changed due
/// to an external factor.
#[doc(alias = "gtk_list_box_invalidate_sort")]
pub fn invalidate_sort(&self) {
unsafe {
ffi::gtk_list_box_invalidate_sort(self.to_glib_none().0);
}
}
/// Prepend a widget to the list.
///
/// If a sort function is set, the widget will
/// actually be inserted at the calculated position.
/// ## `child`
/// the [`Widget`][crate::Widget] to add
#[doc(alias = "gtk_list_box_prepend")]
pub fn prepend(&self, child: &impl IsA<Widget>) {
unsafe {
ffi::gtk_list_box_prepend(self.to_glib_none().0, child.as_ref().to_glib_none().0);
}
}
/// Removes a child from @self.
/// ## `child`
/// the child to remove
#[doc(alias = "gtk_list_box_remove")]
pub fn remove(&self, child: &impl IsA<Widget>) {
unsafe {
ffi::gtk_list_box_remove(self.to_glib_none().0, child.as_ref().to_glib_none().0);
}
}
/// Removes all rows from @self.
///
/// This function does nothing if @self is backed by a model.
#[cfg(feature = "v4_12")]
#[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
#[doc(alias = "gtk_list_box_remove_all")]
pub fn remove_all(&self) {
unsafe {
ffi::gtk_list_box_remove_all(self.to_glib_none().0);
}
}
/// Select all children of @self, if the selection mode allows it.
#[doc(alias = "gtk_list_box_select_all")]
pub fn select_all(&self) {
unsafe {
ffi::gtk_list_box_select_all(self.to_glib_none().0);
}
}
/// Make @row the currently selected row.
/// ## `row`
/// The row to select
#[doc(alias = "gtk_list_box_select_row")]
pub fn select_row(&self, row: Option<&impl IsA<ListBoxRow>>) {
unsafe {
ffi::gtk_list_box_select_row(
self.to_glib_none().0,
row.map(|p| p.as_ref()).to_glib_none().0,
);
}
}
/// Calls a function for each selected child.
///
/// Note that the selection cannot be modified from within this function.
/// ## `func`
/// the function to call for each selected child
#[doc(alias = "gtk_list_box_selected_foreach")]
pub fn selected_foreach<P: FnMut(&ListBox, &ListBoxRow)>(&self, func: P) {
let func_data: P = func;
unsafe extern "C" fn func_func<P: FnMut(&ListBox, &ListBoxRow)>(
box_: *mut ffi::GtkListBox,
row: *mut ffi::GtkListBoxRow,
user_data: glib::ffi::gpointer,
) {
let box_ = from_glib_borrow(box_);
let row = from_glib_borrow(row);
let callback = user_data as *mut P;
(*callback)(&box_, &row)
}
let func = Some(func_func::<P> as _);
let super_callback0: &P = &func_data;
unsafe {
ffi::gtk_list_box_selected_foreach(
self.to_glib_none().0,
func,
super_callback0 as *const _ as *mut _,
);
}
}
/// If @single is [`true`], rows will be activated when you click on them,
/// otherwise you need to double-click.
/// ## `single`
/// a boolean
#[doc(alias = "gtk_list_box_set_activate_on_single_click")]
#[doc(alias = "activate-on-single-click")]
pub fn set_activate_on_single_click(&self, single: bool) {
unsafe {
ffi::gtk_list_box_set_activate_on_single_click(
self.to_glib_none().0,
single.into_glib(),
);
}
}
/// Sets the adjustment (if any) that the widget uses to
/// for vertical scrolling.
///
/// For instance, this is used to get the page size for
/// PageUp/Down key handling.
///
/// In the normal case when the @self is packed inside
/// a [`ScrolledWindow`][crate::ScrolledWindow] the adjustment from that will
/// be picked up automatically, so there is no need
/// to manually do that.
/// ## `adjustment`
/// the adjustment
#[doc(alias = "gtk_list_box_set_adjustment")]
pub fn set_adjustment(&self, adjustment: Option<&impl IsA<Adjustment>>) {
unsafe {
ffi::gtk_list_box_set_adjustment(
self.to_glib_none().0,
adjustment.map(|p| p.as_ref()).to_glib_none().0,
);
}
}
/// By setting a filter function on the @self one can decide dynamically which
/// of the rows to show.
///
/// For instance, to implement a search function on a list that
/// filters the original list to only show the matching rows.
///
/// The @filter_func will be called for each row after the call, and
/// it will continue to be called each time a row changes (via
/// [`ListBoxRowExt::changed()`][crate::prelude::ListBoxRowExt::changed()]) or when [`invalidate_filter()`][Self::invalidate_filter()]
/// is called.
///
/// Note that using a filter function is incompatible with using a model
/// (see [`bind_model()`][Self::bind_model()]).
/// ## `filter_func`
/// callback
/// that lets you filter which rows to show
#[doc(alias = "gtk_list_box_set_filter_func")]
pub fn set_filter_func<P: Fn(&ListBoxRow) -> bool + 'static>(&self, filter_func: P) {
let filter_func_data: Box_<P> = Box_::new(filter_func);
unsafe extern "C" fn filter_func_func<P: Fn(&ListBoxRow) -> bool + 'static>(
row: *mut ffi::GtkListBoxRow,
user_data: glib::ffi::gpointer,
) -> glib::ffi::gboolean {
let row = from_glib_borrow(row);
let callback = &*(user_data as *mut P);
(*callback)(&row).into_glib()
}
let filter_func = Some(filter_func_func::<P> as _);
unsafe extern "C" fn destroy_func<P: Fn(&ListBoxRow) -> bool + 'static>(
data: glib::ffi::gpointer,
) {
let _callback = Box_::from_raw(data as *mut P);
}
let destroy_call3 = Some(destroy_func::<P> as _);
let super_callback0: Box_<P> = filter_func_data;
unsafe {
ffi::gtk_list_box_set_filter_func(
self.to_glib_none().0,
filter_func,
Box_::into_raw(super_callback0) as *mut _,
destroy_call3,
);
}
}
/// Sets a header function.
///
/// By setting a header function on the @self one can dynamically add headers
/// in front of rows, depending on the contents of the row and its position
/// in the list.
///
/// For instance, one could use it to add headers in front of the first item
/// of a new kind, in a list sorted by the kind.
///
/// The @update_header can look at the current header widget using
/// [`ListBoxRowExt::header()`][crate::prelude::ListBoxRowExt::header()] and either update the state of the widget
/// as needed, or set a new one using [`ListBoxRowExt::set_header()`][crate::prelude::ListBoxRowExt::set_header()]. If no
/// header is needed, set the header to [`None`].
///
/// Note that you may get many calls @update_header to this for a particular
/// row when e.g. changing things that don’t affect the header. In this case
/// it is important for performance to not blindly replace an existing header
/// with an identical one.
///
/// The @update_header function will be called for each row after the call,
/// and it will continue to be called each time a row changes (via
/// [`ListBoxRowExt::changed()`][crate::prelude::ListBoxRowExt::changed()]) and when the row before changes (either
/// by [`ListBoxRowExt::changed()`][crate::prelude::ListBoxRowExt::changed()] on the previous row, or when the previous
/// row becomes a different row). It is also called for all rows when
/// [`invalidate_headers()`][Self::invalidate_headers()] is called.
/// ## `update_header`
/// callback
/// that lets you add row headers
#[doc(alias = "gtk_list_box_set_header_func")]
pub fn set_header_func<P: Fn(&ListBoxRow, Option<&ListBoxRow>) + 'static>(
&self,
update_header: P,
) {
let update_header_data: Box_<P> = Box_::new(update_header);
unsafe extern "C" fn update_header_func<
P: Fn(&ListBoxRow, Option<&ListBoxRow>) + 'static,
>(
row: *mut ffi::GtkListBoxRow,
before: *mut ffi::GtkListBoxRow,
user_data: glib::ffi::gpointer,
) {
let row = from_glib_borrow(row);
let before: Borrowed<Option<ListBoxRow>> = from_glib_borrow(before);
let callback = &*(user_data as *mut P);
(*callback)(&row, before.as_ref().as_ref())
}
let update_header = Some(update_header_func::<P> as _);
unsafe extern "C" fn destroy_func<P: Fn(&ListBoxRow, Option<&ListBoxRow>) + 'static>(
data: glib::ffi::gpointer,
) {
let _callback = Box_::from_raw(data as *mut P);
}
let destroy_call3 = Some(destroy_func::<P> as _);
let super_callback0: Box_<P> = update_header_data;
unsafe {
ffi::gtk_list_box_set_header_func(
self.to_glib_none().0,
update_header,
Box_::into_raw(super_callback0) as *mut _,
destroy_call3,
);
}
}
/// Sets the placeholder widget that is shown in the list when
/// it doesn't display any visible children.
/// ## `placeholder`
/// a [`Widget`][crate::Widget]
#[doc(alias = "gtk_list_box_set_placeholder")]
pub fn set_placeholder(&self, placeholder: Option<&impl IsA<Widget>>) {
unsafe {
ffi::gtk_list_box_set_placeholder(
self.to_glib_none().0,
placeholder.map(|p| p.as_ref()).to_glib_none().0,
);
}
}
/// Sets how selection works in the listbox.
/// ## `mode`
/// The [`SelectionMode`][crate::SelectionMode]
#[doc(alias = "gtk_list_box_set_selection_mode")]
#[doc(alias = "selection-mode")]
pub fn set_selection_mode(&self, mode: SelectionMode) {
unsafe {
ffi::gtk_list_box_set_selection_mode(self.to_glib_none().0, mode.into_glib());
}
}
/// Sets whether the list box should show separators
/// between rows.
/// ## `show_separators`
/// [`true`] to show separators
#[doc(alias = "gtk_list_box_set_show_separators")]
#[doc(alias = "show-separators")]
pub fn set_show_separators(&self, show_separators: bool) {
unsafe {
ffi::gtk_list_box_set_show_separators(
self.to_glib_none().0,
show_separators.into_glib(),
);
}
}
/// Unselect all children of @self, if the selection mode allows it.
#[doc(alias = "gtk_list_box_unselect_all")]
pub fn unselect_all(&self) {
unsafe {
ffi::gtk_list_box_unselect_all(self.to_glib_none().0);
}
}
/// Unselects a single row of @self, if the selection mode allows it.
/// ## `row`
/// the row to unselect
#[doc(alias = "gtk_list_box_unselect_row")]
pub fn unselect_row(&self, row: &impl IsA<ListBoxRow>) {
unsafe {
ffi::gtk_list_box_unselect_row(self.to_glib_none().0, row.as_ref().to_glib_none().0);
}
}
/// Whether to accept unpaired release events.
#[doc(alias = "accept-unpaired-release")]
pub fn accepts_unpaired_release(&self) -> bool {
ObjectExt::property(self, "accept-unpaired-release")
}
/// Whether to accept unpaired release events.
#[doc(alias = "accept-unpaired-release")]
pub fn set_accept_unpaired_release(&self, accept_unpaired_release: bool) {
ObjectExt::set_property(self, "accept-unpaired-release", accept_unpaired_release)
}
/// Emitted when the cursor row is activated.
#[doc(alias = "activate-cursor-row")]
pub fn connect_activate_cursor_row<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn activate_cursor_row_trampoline<F: Fn(&ListBox) + 'static>(
this: *mut ffi::GtkListBox,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"activate-cursor-row\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
activate_cursor_row_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
pub fn emit_activate_cursor_row(&self) {
self.emit_by_name::<()>("activate-cursor-row", &[]);
}
/// Emitted when the user initiates a cursor movement.
///
/// The default bindings for this signal come in two variants, the variant with
/// the Shift modifier extends the selection, the variant without the Shift
/// modifier does not. There are too many key combinations to list them all
/// here.
///
/// - <kbd>←</kbd>, <kbd>→</kbd>, <kbd>↑</kbd>, <kbd>↓</kbd>
/// move by individual children
/// - <kbd>Home</kbd>, <kbd>End</kbd> move to the ends of the box
/// - <kbd>PgUp</kbd>, <kbd>PgDn</kbd> move vertically by pages
/// ## `step`
/// the granularity of the move, as a [`MovementStep`][crate::MovementStep]
/// ## `count`
/// the number of @step units to move
/// ## `extend`
/// whether to extend the selection
/// ## `modify`
/// whether to modify the selection
#[doc(alias = "move-cursor")]
pub fn connect_move_cursor<F: Fn(&Self, MovementStep, i32, bool, bool) + 'static>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn move_cursor_trampoline<
F: Fn(&ListBox, MovementStep, i32, bool, bool) + 'static,
>(
this: *mut ffi::GtkListBox,
step: ffi::GtkMovementStep,
count: std::ffi::c_int,
extend: glib::ffi::gboolean,
modify: glib::ffi::gboolean,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(
&from_glib_borrow(this),
from_glib(step),
count,
from_glib(extend),
from_glib(modify),
)
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"move-cursor\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
move_cursor_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
pub fn emit_move_cursor(&self, step: MovementStep, count: i32, extend: bool, modify: bool) {
self.emit_by_name::<()>("move-cursor", &[&step, &count, &extend, &modify]);
}
/// Emitted when a row has been activated by the user.
/// ## `row`
/// the activated row
#[doc(alias = "row-activated")]
pub fn connect_row_activated<F: Fn(&Self, &ListBoxRow) + 'static>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn row_activated_trampoline<F: Fn(&ListBox, &ListBoxRow) + 'static>(
this: *mut ffi::GtkListBox,
row: *mut ffi::GtkListBoxRow,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this), &from_glib_borrow(row))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"row-activated\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
row_activated_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
/// Emitted when a new row is selected, or (with a [`None`] @row)
/// when the selection is cleared.
///
/// When the @box_ is using [`SelectionMode::Multiple`][crate::SelectionMode::Multiple], this signal will not
/// give you the full picture of selection changes, and you should use
/// the [`selected-rows-changed`][struct@crate::ListBox#selected-rows-changed] signal instead.
/// ## `row`
/// the selected row
#[doc(alias = "row-selected")]
pub fn connect_row_selected<F: Fn(&Self, Option<&ListBoxRow>) + 'static>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn row_selected_trampoline<
F: Fn(&ListBox, Option<&ListBoxRow>) + 'static,
>(
this: *mut ffi::GtkListBox,
row: *mut ffi::GtkListBoxRow,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(
&from_glib_borrow(this),
Option::<ListBoxRow>::from_glib_borrow(row)
.as_ref()
.as_ref(),
)
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"row-selected\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
row_selected_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
/// Emitted to select all children of the box, if the selection
/// mode permits it.
///
/// This is a [keybinding signal](class.SignalAction.html).
///
/// The default binding for this signal is <kbd>Ctrl</kbd>-<kbd>a</kbd>.
#[doc(alias = "select-all")]
pub fn connect_select_all<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn select_all_trampoline<F: Fn(&ListBox) + 'static>(
this: *mut ffi::GtkListBox,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"select-all\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
select_all_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
pub fn emit_select_all(&self) {
self.emit_by_name::<()>("select-all", &[]);
}
/// Emitted when the set of selected rows changes.
#[doc(alias = "selected-rows-changed")]
pub fn connect_selected_rows_changed<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn selected_rows_changed_trampoline<F: Fn(&ListBox) + 'static>(
this: *mut ffi::GtkListBox,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"selected-rows-changed\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
selected_rows_changed_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
/// Emitted when the cursor row is toggled.
///
/// The default bindings for this signal is <kbd>Ctrl</kbd>+<kbd>␣</kbd>.
#[doc(alias = "toggle-cursor-row")]
pub fn connect_toggle_cursor_row<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn toggle_cursor_row_trampoline<F: Fn(&ListBox) + 'static>(
this: *mut ffi::GtkListBox,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"toggle-cursor-row\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
toggle_cursor_row_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
pub fn emit_toggle_cursor_row(&self) {
self.emit_by_name::<()>("toggle-cursor-row", &[]);
}
/// Emitted to unselect all children of the box, if the selection
/// mode permits it.
///
/// This is a [keybinding signal](class.SignalAction.html).
///
/// The default binding for this signal is
/// <kbd>Ctrl</kbd>-<kbd>Shift</kbd>-<kbd>a</kbd>.
#[doc(alias = "unselect-all")]
pub fn connect_unselect_all<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn unselect_all_trampoline<F: Fn(&ListBox) + 'static>(
this: *mut ffi::GtkListBox,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"unselect-all\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
unselect_all_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
pub fn emit_unselect_all(&self) {
self.emit_by_name::<()>("unselect-all", &[]);
}
#[doc(alias = "accept-unpaired-release")]
pub fn connect_accept_unpaired_release_notify<F: Fn(&Self) + 'static>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn notify_accept_unpaired_release_trampoline<
F: Fn(&ListBox) + 'static,
>(
this: *mut ffi::GtkListBox,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::accept-unpaired-release\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_accept_unpaired_release_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "activate-on-single-click")]
pub fn connect_activate_on_single_click_notify<F: Fn(&Self) + 'static>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn notify_activate_on_single_click_trampoline<
F: Fn(&ListBox) + 'static,
>(
this: *mut ffi::GtkListBox,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::activate-on-single-click\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_activate_on_single_click_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "selection-mode")]
pub fn connect_selection_mode_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_selection_mode_trampoline<F: Fn(&ListBox) + 'static>(
this: *mut ffi::GtkListBox,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::selection-mode\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_selection_mode_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "show-separators")]
pub fn connect_show_separators_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_show_separators_trampoline<F: Fn(&ListBox) + 'static>(
this: *mut ffi::GtkListBox,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::show-separators\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_show_separators_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl Default for ListBox {
fn default() -> Self {
Self::new()
}
}
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`ListBox`] objects.
///
/// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
#[must_use = "The builder must be built to be used"]
pub struct ListBoxBuilder {
builder: glib::object::ObjectBuilder<'static, ListBox>,
}
impl ListBoxBuilder {
fn new() -> Self {
Self {
builder: glib::object::Object::builder(),
}
}
/// Whether to accept unpaired release events.
pub fn accept_unpaired_release(self, accept_unpaired_release: bool) -> Self {
Self {
builder: self
.builder
.property("accept-unpaired-release", accept_unpaired_release),
}
}
/// Determines whether children can be activated with a single
/// click, or require a double-click.
pub fn activate_on_single_click(self, activate_on_single_click: bool) -> Self {
Self {
builder: self
.builder
.property("activate-on-single-click", activate_on_single_click),
}
}
/// The selection mode used by the list box.
pub fn selection_mode(self, selection_mode: SelectionMode) -> Self {
Self {
builder: self.builder.property("selection-mode", selection_mode),
}
}
/// Whether to show separators between rows.
pub fn show_separators(self, show_separators: bool) -> Self {
Self {
builder: self.builder.property("show-separators", show_separators),
}
}
/// Whether the widget or any of its descendents can accept
/// the input focus.
///
/// This property is meant to be set by widget implementations,
/// typically in their instance init function.
pub fn can_focus(self, can_focus: bool) -> Self {
Self {
builder: self.builder.property("can-focus", can_focus),
}
}
/// Whether the widget can receive pointer events.
pub fn can_target(self, can_target: bool) -> Self {
Self {
builder: self.builder.property("can-target", can_target),
}
}
/// A list of css classes applied to this widget.
pub fn css_classes(self, css_classes: impl Into<glib::StrV>) -> Self {
Self {
builder: self.builder.property("css-classes", css_classes.into()),
}
}
/// The name of this widget in the CSS tree.
///
/// This property is meant to be set by widget implementations,
/// typically in their instance init function.
pub fn css_name(self, css_name: impl Into<glib::GString>) -> Self {
Self {
builder: self.builder.property("css-name", css_name.into()),
}
}
/// The cursor used by @widget.
pub fn cursor(self, cursor: &gdk::Cursor) -> Self {
Self {
builder: self.builder.property("cursor", cursor.clone()),
}
}
/// Whether the widget should grab focus when it is clicked with the mouse.
///
/// This property is only relevant for widgets that can take focus.
pub fn focus_on_click(self, focus_on_click: bool) -> Self {
Self {
builder: self.builder.property("focus-on-click", focus_on_click),
}
}
/// Whether this widget itself will accept the input focus.
pub fn focusable(self, focusable: bool) -> Self {
Self {
builder: self.builder.property("focusable", focusable),
}
}
/// How to distribute horizontal space if widget gets extra space.
pub fn halign(self, halign: Align) -> Self {
Self {
builder: self.builder.property("halign", halign),
}
}
/// Enables or disables the emission of the ::query-tooltip signal on @widget.
///
/// A value of [`true`] indicates that @widget can have a tooltip, in this case
/// the widget will be queried using [`query-tooltip`][struct@crate::Widget#query-tooltip] to
/// determine whether it will provide a tooltip or not.
pub fn has_tooltip(self, has_tooltip: bool) -> Self {
Self {
builder: self.builder.property("has-tooltip", has_tooltip),
}
}
/// Override for height request of the widget.
///
/// If this is -1, the natural request will be used.
pub fn height_request(self, height_request: i32) -> Self {
Self {
builder: self.builder.property("height-request", height_request),
}
}
/// Whether to expand horizontally.
pub fn hexpand(self, hexpand: bool) -> Self {
Self {
builder: self.builder.property("hexpand", hexpand),
}
}
/// Whether to use the `hexpand` property.
pub fn hexpand_set(self, hexpand_set: bool) -> Self {
Self {
builder: self.builder.property("hexpand-set", hexpand_set),
}
}
/// The [`LayoutManager`][crate::LayoutManager] instance to use to compute the preferred size
/// of the widget, and allocate its children.
///
/// This property is meant to be set by widget implementations,
/// typically in their instance init function.
pub fn layout_manager(self, layout_manager: &impl IsA<LayoutManager>) -> Self {
Self {
builder: self
.builder
.property("layout-manager", layout_manager.clone().upcast()),
}
}
/// Margin on bottom side of widget.
///
/// This property adds margin outside of the widget's normal size
/// request, the margin will be added in addition to the size from
/// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
pub fn margin_bottom(self, margin_bottom: i32) -> Self {
Self {
builder: self.builder.property("margin-bottom", margin_bottom),
}
}
/// Margin on end of widget, horizontally.
///
/// This property supports left-to-right and right-to-left text
/// directions.
///
/// This property adds margin outside of the widget's normal size
/// request, the margin will be added in addition to the size from
/// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
pub fn margin_end(self, margin_end: i32) -> Self {
Self {
builder: self.builder.property("margin-end", margin_end),
}
}
/// Margin on start of widget, horizontally.
///
/// This property supports left-to-right and right-to-left text
/// directions.
///
/// This property adds margin outside of the widget's normal size
/// request, the margin will be added in addition to the size from
/// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
pub fn margin_start(self, margin_start: i32) -> Self {
Self {
builder: self.builder.property("margin-start", margin_start),
}
}
/// Margin on top side of widget.
///
/// This property adds margin outside of the widget's normal size
/// request, the margin will be added in addition to the size from
/// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
pub fn margin_top(self, margin_top: i32) -> Self {
Self {
builder: self.builder.property("margin-top", margin_top),
}
}
/// The name of the widget.
pub fn name(self, name: impl Into<glib::GString>) -> Self {
Self {
builder: self.builder.property("name", name.into()),
}
}
/// The requested opacity of the widget.
pub fn opacity(self, opacity: f64) -> Self {
Self {
builder: self.builder.property("opacity", opacity),
}
}
/// How content outside the widget's content area is treated.
///
/// This property is meant to be set by widget implementations,
/// typically in their instance init function.
pub fn overflow(self, overflow: Overflow) -> Self {
Self {
builder: self.builder.property("overflow", overflow),
}
}
/// Whether the widget will receive the default action when it is focused.
pub fn receives_default(self, receives_default: bool) -> Self {
Self {
builder: self.builder.property("receives-default", receives_default),
}
}
/// Whether the widget responds to input.
pub fn sensitive(self, sensitive: bool) -> Self {
Self {
builder: self.builder.property("sensitive", sensitive),
}
}
/// Sets the text of tooltip to be the given string, which is marked up
/// with Pango markup.
///
/// Also see [`Tooltip::set_markup()`][crate::Tooltip::set_markup()].
///
/// This is a convenience property which will take care of getting the
/// tooltip shown if the given string is not [`None`]:
/// [`has-tooltip`][struct@crate::Widget#has-tooltip] will automatically be set to [`true`]
/// and there will be taken care of [`query-tooltip`][struct@crate::Widget#query-tooltip] in
/// the default signal handler.
///
/// Note that if both [`tooltip-text`][struct@crate::Widget#tooltip-text] and
/// [`tooltip-markup`][struct@crate::Widget#tooltip-markup] are set, the last one wins.
pub fn tooltip_markup(self, tooltip_markup: impl Into<glib::GString>) -> Self {
Self {
builder: self
.builder
.property("tooltip-markup", tooltip_markup.into()),
}
}
/// Sets the text of tooltip to be the given string.
///
/// Also see [`Tooltip::set_text()`][crate::Tooltip::set_text()].
///
/// This is a convenience property which will take care of getting the
/// tooltip shown if the given string is not [`None`]:
/// [`has-tooltip`][struct@crate::Widget#has-tooltip] will automatically be set to [`true`]
/// and there will be taken care of [`query-tooltip`][struct@crate::Widget#query-tooltip] in
/// the default signal handler.
///
/// Note that if both [`tooltip-text`][struct@crate::Widget#tooltip-text] and
/// [`tooltip-markup`][struct@crate::Widget#tooltip-markup] are set, the last one wins.
pub fn tooltip_text(self, tooltip_text: impl Into<glib::GString>) -> Self {
Self {
builder: self.builder.property("tooltip-text", tooltip_text.into()),
}
}
/// How to distribute vertical space if widget gets extra space.
pub fn valign(self, valign: Align) -> Self {
Self {
builder: self.builder.property("valign", valign),
}
}
/// Whether to expand vertically.
pub fn vexpand(self, vexpand: bool) -> Self {
Self {
builder: self.builder.property("vexpand", vexpand),
}
}
/// Whether to use the `vexpand` property.
pub fn vexpand_set(self, vexpand_set: bool) -> Self {
Self {
builder: self.builder.property("vexpand-set", vexpand_set),
}
}
/// Whether the widget is visible.
pub fn visible(self, visible: bool) -> Self {
Self {
builder: self.builder.property("visible", visible),
}
}
/// Override for width request of the widget.
///
/// If this is -1, the natural request will be used.
pub fn width_request(self, width_request: i32) -> Self {
Self {
builder: self.builder.property("width-request", width_request),
}
}
/// The accessible role of the given [`Accessible`][crate::Accessible] implementation.
///
/// The accessible role cannot be changed once set.
pub fn accessible_role(self, accessible_role: AccessibleRole) -> Self {
Self {
builder: self.builder.property("accessible-role", accessible_role),
}
}
// rustdoc-stripper-ignore-next
/// Build the [`ListBox`].
#[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
pub fn build(self) -> ListBox {
self.builder.build()
}
}