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 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352
// 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::Accessible;
use crate::AccessibleRole;
use crate::Align;
use crate::Buildable;
use crate::ConstraintTarget;
use crate::Justification;
use crate::LayoutManager;
use crate::MovementStep;
#[cfg(any(feature = "v4_6", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_6")))]
use crate::NaturalWrapMode;
use crate::Overflow;
use crate::Widget;
use glib::object::Cast;
use glib::object::IsA;
use glib::object::ObjectExt;
use glib::object::ObjectType as ObjectType_;
use glib::signal::connect_raw;
use glib::signal::SignalHandlerId;
use glib::translate::*;
use glib::StaticType;
use glib::ToValue;
use std::boxed::Box as Box_;
use std::fmt;
use std::mem;
use std::mem::transmute;
glib::wrapper! {
/// The [`Label`][crate::Label] widget displays a small amount of text.
///
/// As the name implies, most labels are used to label another widget
/// such as a [`Button`][crate::Button].
///
/// 
///
/// # CSS nodes
///
/// ```text
/// label
/// ├── [selection]
/// ├── [link]
/// ┊
/// ╰── [link]
/// ```
///
/// [`Label`][crate::Label] has a single CSS node with the name label. A wide variety
/// of style classes may be applied to labels, such as .title, .subtitle,
/// .dim-label, etc. In the [`ShortcutsWindow`][crate::ShortcutsWindow], labels are used with the
/// .keycap style class.
///
/// If the label has a selection, it gets a subnode with name selection.
///
/// If the label has links, there is one subnode per link. These subnodes
/// carry the link or visited state depending on whether they have been
/// visited. In this case, label node also gets a .link style class.
///
/// # GtkLabel as GtkBuildable
///
/// The GtkLabel implementation of the GtkBuildable interface supports a
/// custom <attributes> element, which supports any number of <attribute>
/// elements. The <attribute> element has attributes named “name“, “value“,
/// “start“ and “end“ and allows you to specify `Pango::Attribute`
/// values for this label.
///
/// An example of a UI definition fragment specifying Pango attributes:
/// ```xml
/// <object class="GtkLabel">
/// <attributes>
/// <attribute name="weight" value="PANGO_WEIGHT_BOLD"/>
/// <attribute name="background" value="red" start="5" end="10"/>
/// </attributes>
/// </object>
/// ```
///
/// The start and end attributes specify the range of characters to which the
/// Pango attribute applies. If start and end are not specified, the attribute is
/// applied to the whole text. Note that specifying ranges does not make much
/// sense with translatable attributes. Use markup embedded in the translatable
/// content instead.
///
/// # Accessibility
///
/// [`Label`][crate::Label] uses the [`AccessibleRole::Label`][crate::AccessibleRole::Label] role.
///
/// # Mnemonics
///
/// Labels may contain “mnemonics”. Mnemonics are underlined characters in the
/// label, used for keyboard navigation. Mnemonics are created by providing a
/// string with an underscore before the mnemonic character, such as `"_File"`,
/// to the functions [`with_mnemonic()`][Self::with_mnemonic()] or
/// [`set_text_with_mnemonic()`][Self::set_text_with_mnemonic()].
///
/// Mnemonics automatically activate any activatable widget the label is
/// inside, such as a [`Button`][crate::Button]; if the label is not inside the
/// mnemonic’s target widget, you have to tell the label about the target
/// using [class@Gtk.Label.set_mnemonic_widget]. Here’s a simple example where
/// the label is inside a button:
///
/// **⚠️ The following code is in c ⚠️**
///
/// ```c
/// // Pressing Alt+H will activate this button
/// GtkWidget *button = gtk_button_new ();
/// GtkWidget *label = gtk_label_new_with_mnemonic ("_Hello");
/// gtk_button_set_child (GTK_BUTTON (button), label);
/// ```
///
/// There’s a convenience function to create buttons with a mnemonic label
/// already inside:
///
/// **⚠️ The following code is in c ⚠️**
///
/// ```c
/// // Pressing Alt+H will activate this button
/// GtkWidget *button = gtk_button_new_with_mnemonic ("_Hello");
/// ```
///
/// To create a mnemonic for a widget alongside the label, such as a
/// [`Entry`][crate::Entry], you have to point the label at the entry with
/// [`set_mnemonic_widget()`][Self::set_mnemonic_widget()]:
///
/// **⚠️ The following code is in c ⚠️**
///
/// ```c
/// // Pressing Alt+H will focus the entry
/// GtkWidget *entry = gtk_entry_new ();
/// GtkWidget *label = gtk_label_new_with_mnemonic ("_Hello");
/// gtk_label_set_mnemonic_widget (GTK_LABEL (label), entry);
/// ```
///
/// # Markup (styled text)
///
/// To make it easy to format text in a label (changing colors,
/// fonts, etc.), label text can be provided in a simple
/// markup format:
///
/// Here’s how to create a label with a small font:
/// **⚠️ The following code is in c ⚠️**
///
/// ```c
/// GtkWidget *label = gtk_label_new (NULL);
/// gtk_label_set_markup (GTK_LABEL (label), "<small>Small text</small>");
/// ```
///
/// (See the Pango manual for complete documentation] of available
/// tags, `parse_markup()`)
///
/// The markup passed to gtk_label_set_markup() must be valid; for example,
/// literal <, > and & characters must be escaped as <, >, and &.
/// If you pass text obtained from the user, file, or a network to
/// [`set_markup()`][Self::set_markup()], you’ll want to escape it with
/// g_markup_escape_text() or g_markup_printf_escaped().
///
/// Markup strings are just a convenient way to set the [`pango::AttrList`][crate::pango::AttrList]
/// on a label; [`set_attributes()`][Self::set_attributes()] may be a simpler way to set
/// attributes in some cases. Be careful though; [`pango::AttrList`][crate::pango::AttrList] tends
/// to cause internationalization problems, unless you’re applying attributes
/// to the entire string (i.e. unless you set the range of each attribute
/// to [0, `G_MAXINT`)). The reason is that specifying the start_index and
/// end_index for a `Pango::Attribute` requires knowledge of the exact
/// string being displayed, so translations will cause problems.
///
/// # Selectable labels
///
/// Labels can be made selectable with [`set_selectable()`][Self::set_selectable()].
/// Selectable labels allow the user to copy the label contents to
/// the clipboard. Only labels that contain useful-to-copy information
/// — such as error messages — should be made selectable.
///
/// # Text layout
///
/// A label can contain any number of paragraphs, but will have
/// performance problems if it contains more than a small number.
/// Paragraphs are separated by newlines or other paragraph separators
/// understood by Pango.
///
/// Labels can automatically wrap text if you call [`set_wrap()`][Self::set_wrap()].
///
/// [`set_justify()`][Self::set_justify()] sets how the lines in a label align
/// with one another. If you want to set how the label as a whole aligns
/// in its available space, see the `property::Widget::halign` and
/// `property::Widget::valign` properties.
///
/// The `property::Label::width-chars` and `property::Label::max-width-chars`
/// properties can be used to control the size allocation of ellipsized or
/// wrapped labels. For ellipsizing labels, if either is specified (and less
/// than the actual text size), it is used as the minimum width, and the actual
/// text size is used as the natural width of the label. For wrapping labels,
/// width-chars is used as the minimum width, if specified, and max-width-chars
/// is used as the natural width. Even if max-width-chars specified, wrapping
/// labels will be rewrapped to use all of the available width.
///
/// # Links
///
/// GTK supports markup for clickable hyperlinks in addition to regular Pango
/// markup. The markup for links is borrowed from HTML, using the `<a>` with
/// “href“, “title“ and “class“ attributes. GTK renders links similar to the
/// way they appear in web browsers, with colored, underlined text. The “title“
/// attribute is displayed as a tooltip on the link. The “class“ attribute is
/// used as style class on the CSS node for the link.
///
/// An example looks like this:
///
/// **⚠️ The following code is in c ⚠️**
///
/// ```c
/// const char *text =
/// "Go to the "
/// "<a href=\"https://www.gtk.org\" title=\"<i>Our</i> website\">"
/// "GTK website</a> for more...";
/// GtkWidget *label = gtk_label_new (NULL);
/// gtk_label_set_markup (GTK_LABEL (label), text);
/// ```
///
/// It is possible to implement custom handling for links and their tooltips
/// with the `signal::Label::activate-link` signal and the
/// [`current_uri()`][Self::current_uri()] function.
///
/// # 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 = "GtkLabel")]
pub struct Label(Object<ffi::GtkLabel>) @extends Widget, @implements Accessible, Buildable, ConstraintTarget;
match fn {
type_ => || ffi::gtk_label_get_type(),
}
}
impl Label {
/// Creates a new label with the given text inside it.
///
/// You can pass [`None`] to get an empty label widget.
/// ## `str`
/// The text of the label
///
/// # Returns
///
/// the new [`Label`][crate::Label]
#[doc(alias = "gtk_label_new")]
pub fn new(str: Option<&str>) -> Label {
assert_initialized_main_thread!();
unsafe { Widget::from_glib_none(ffi::gtk_label_new(str.to_glib_none().0)).unsafe_cast() }
}
/// Creates a new [`Label`][crate::Label], containing the text in @str.
///
/// If characters in @str are preceded by an underscore, they are
/// underlined. If you need a literal underscore character in a label, use
/// '__' (two underscores). The first underlined character represents a
/// keyboard accelerator called a mnemonic. The mnemonic key can be used
/// to activate another widget, chosen automatically, or explicitly using
/// [`set_mnemonic_widget()`][Self::set_mnemonic_widget()].
///
/// If [`set_mnemonic_widget()`][Self::set_mnemonic_widget()] is not called, then the first
/// activatable ancestor of the [`Label`][crate::Label] will be chosen as the mnemonic
/// widget. For instance, if the label is inside a button or menu item,
/// the button or menu item will automatically become the mnemonic widget
/// and be activated by the mnemonic.
/// ## `str`
/// The text of the label, with an underscore in front of the
/// mnemonic character
///
/// # Returns
///
/// the new [`Label`][crate::Label]
#[doc(alias = "gtk_label_new_with_mnemonic")]
#[doc(alias = "new_with_mnemonic")]
pub fn with_mnemonic(str: &str) -> Label {
assert_initialized_main_thread!();
unsafe {
Widget::from_glib_none(ffi::gtk_label_new_with_mnemonic(str.to_glib_none().0))
.unsafe_cast()
}
}
// rustdoc-stripper-ignore-next
/// Creates a new builder-pattern struct instance to construct [`Label`] objects.
///
/// This method returns an instance of [`LabelBuilder`](crate::builders::LabelBuilder) which can be used to create [`Label`] objects.
pub fn builder() -> LabelBuilder {
LabelBuilder::default()
}
/// Gets the label's attribute list.
///
/// This is the [`pango::AttrList`][crate::pango::AttrList] that was set on the label using
/// [`set_attributes()`][Self::set_attributes()], if any. This function does not
/// reflect attributes that come from the labels markup (see
/// [`set_markup()`][Self::set_markup()]). If you want to get the effective
/// attributes for the label, use
/// `pango_layout_get_attribute (gtk_label_get_layout (self))`.
///
/// # Returns
///
/// the attribute list
#[doc(alias = "gtk_label_get_attributes")]
#[doc(alias = "get_attributes")]
pub fn attributes(&self) -> Option<pango::AttrList> {
unsafe { from_glib_none(ffi::gtk_label_get_attributes(self.to_glib_none().0)) }
}
/// Returns the URI for the currently active link in the label.
///
/// The active link is the one under the mouse pointer or, in a
/// selectable label, the link in which the text cursor is currently
/// positioned.
///
/// This function is intended for use in a `signal::Label::activate-link`
/// handler or for use in a `signal::Widget::query-tooltip` handler.
///
/// # Returns
///
/// the currently active URI
#[doc(alias = "gtk_label_get_current_uri")]
#[doc(alias = "get_current_uri")]
pub fn current_uri(&self) -> Option<glib::GString> {
unsafe { from_glib_none(ffi::gtk_label_get_current_uri(self.to_glib_none().0)) }
}
/// Returns the ellipsizing position of the label.
///
/// See [`set_ellipsize()`][Self::set_ellipsize()].
///
/// # Returns
///
/// [`pango::EllipsizeMode`][crate::pango::EllipsizeMode]
#[doc(alias = "gtk_label_get_ellipsize")]
#[doc(alias = "get_ellipsize")]
pub fn ellipsize(&self) -> pango::EllipsizeMode {
unsafe { from_glib(ffi::gtk_label_get_ellipsize(self.to_glib_none().0)) }
}
/// Gets the extra menu model of @label.
///
/// See [`set_extra_menu()`][Self::set_extra_menu()].
///
/// # Returns
///
/// the menu model
#[doc(alias = "gtk_label_get_extra_menu")]
#[doc(alias = "get_extra_menu")]
pub fn extra_menu(&self) -> Option<gio::MenuModel> {
unsafe { from_glib_none(ffi::gtk_label_get_extra_menu(self.to_glib_none().0)) }
}
/// Returns the justification of the label.
///
/// See [`set_justify()`][Self::set_justify()].
///
/// # Returns
///
/// [`Justification`][crate::Justification]
#[doc(alias = "gtk_label_get_justify")]
#[doc(alias = "get_justify")]
pub fn justify(&self) -> Justification {
unsafe { from_glib(ffi::gtk_label_get_justify(self.to_glib_none().0)) }
}
/// Fetches the text from a label.
///
/// The returned text includes any embedded underlines indicating
/// mnemonics and Pango markup. (See [`text()`][Self::text()]).
///
/// # Returns
///
/// the text of the label widget. This string is
/// owned by the widget and must not be modified or freed.
#[doc(alias = "gtk_label_get_label")]
#[doc(alias = "get_label")]
pub fn label(&self) -> glib::GString {
unsafe { from_glib_none(ffi::gtk_label_get_label(self.to_glib_none().0)) }
}
/// Gets the [`pango::Layout`][crate::pango::Layout] used to display the label.
///
/// The layout is useful to e.g. convert text positions to pixel
/// positions, in combination with [`layout_offsets()`][Self::layout_offsets()].
/// The returned layout is owned by the @label so need not be
/// freed by the caller. The @label is free to recreate its layout
/// at any time, so it should be considered read-only.
///
/// # Returns
///
/// the [`pango::Layout`][crate::pango::Layout] for this label
#[doc(alias = "gtk_label_get_layout")]
#[doc(alias = "get_layout")]
pub fn layout(&self) -> pango::Layout {
unsafe { from_glib_none(ffi::gtk_label_get_layout(self.to_glib_none().0)) }
}
/// Obtains the coordinates where the label will draw its [`pango::Layout`][crate::pango::Layout].
///
/// The coordinates are useful to convert mouse events into coordinates
/// inside the [`pango::Layout`][crate::pango::Layout], e.g. to take some action if some part
/// of the label is clicked. Remember when using the [`pango::Layout`][crate::pango::Layout]
/// functions you need to convert to and from pixels using PANGO_PIXELS()
/// or `Pango::SCALE`.
///
/// # Returns
///
///
/// ## `x`
/// location to store X offset of layout
///
/// ## `y`
/// location to store Y offset of layout
#[doc(alias = "gtk_label_get_layout_offsets")]
#[doc(alias = "get_layout_offsets")]
pub fn layout_offsets(&self) -> (i32, i32) {
unsafe {
let mut x = mem::MaybeUninit::uninit();
let mut y = mem::MaybeUninit::uninit();
ffi::gtk_label_get_layout_offsets(
self.to_glib_none().0,
x.as_mut_ptr(),
y.as_mut_ptr(),
);
(x.assume_init(), y.assume_init())
}
}
/// Gets the number of lines to which an ellipsized, wrapping
/// label should be limited.
///
/// See [`set_lines()`][Self::set_lines()].
///
/// # Returns
///
/// The number of lines
#[doc(alias = "gtk_label_get_lines")]
#[doc(alias = "get_lines")]
pub fn lines(&self) -> i32 {
unsafe { ffi::gtk_label_get_lines(self.to_glib_none().0) }
}
/// Retrieves the desired maximum width of @label, in characters.
///
/// See [`set_width_chars()`][Self::set_width_chars()].
///
/// # Returns
///
/// the maximum width of the label in characters.
#[doc(alias = "gtk_label_get_max_width_chars")]
#[doc(alias = "get_max_width_chars")]
pub fn max_width_chars(&self) -> i32 {
unsafe { ffi::gtk_label_get_max_width_chars(self.to_glib_none().0) }
}
/// Retrieves the target of the mnemonic (keyboard shortcut) of this
/// label.
///
/// See [`set_mnemonic_widget()`][Self::set_mnemonic_widget()].
///
/// # Returns
///
/// the target of the label’s mnemonic,
/// or [`None`] if none has been set and the default algorithm will be used.
#[doc(alias = "gtk_label_get_mnemonic_widget")]
#[doc(alias = "get_mnemonic_widget")]
pub fn mnemonic_widget(&self) -> Option<Widget> {
unsafe { from_glib_none(ffi::gtk_label_get_mnemonic_widget(self.to_glib_none().0)) }
}
/// Returns line wrap mode used by the label.
///
/// See [`set_natural_wrap_mode()`][Self::set_natural_wrap_mode()].
///
/// # Returns
///
/// the natural line wrap mode
#[cfg(any(feature = "v4_6", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_6")))]
#[doc(alias = "gtk_label_get_natural_wrap_mode")]
#[doc(alias = "get_natural_wrap_mode")]
pub fn natural_wrap_mode(&self) -> NaturalWrapMode {
unsafe { from_glib(ffi::gtk_label_get_natural_wrap_mode(self.to_glib_none().0)) }
}
/// Returns whether the label is selectable.
///
/// # Returns
///
/// [`true`] if the user can copy text from the label
#[doc(alias = "gtk_label_get_selectable")]
#[doc(alias = "get_selectable")]
pub fn is_selectable(&self) -> bool {
unsafe { from_glib(ffi::gtk_label_get_selectable(self.to_glib_none().0)) }
}
/// Gets the selected range of characters in the label.
///
/// # Returns
///
/// [`true`] if selection is non-empty
///
/// ## `start`
/// return location for start of selection, as a character offset
///
/// ## `end`
/// return location for end of selection, as a character offset
#[doc(alias = "gtk_label_get_selection_bounds")]
#[doc(alias = "get_selection_bounds")]
pub fn selection_bounds(&self) -> Option<(i32, i32)> {
unsafe {
let mut start = mem::MaybeUninit::uninit();
let mut end = mem::MaybeUninit::uninit();
let ret = from_glib(ffi::gtk_label_get_selection_bounds(
self.to_glib_none().0,
start.as_mut_ptr(),
end.as_mut_ptr(),
));
if ret {
Some((start.assume_init(), end.assume_init()))
} else {
None
}
}
}
/// Returns whether the label is in single line mode.
///
/// # Returns
///
/// [`true`] when the label is in single line mode.
#[doc(alias = "gtk_label_get_single_line_mode")]
#[doc(alias = "get_single_line_mode")]
pub fn is_single_line_mode(&self) -> bool {
unsafe { from_glib(ffi::gtk_label_get_single_line_mode(self.to_glib_none().0)) }
}
/// Gets the tabs for @self.
///
/// The returned array will be [`None`] if “standard” (8-space) tabs are used.
/// Free the return value with `Pango::TabArray::free()`.
///
/// # Returns
///
/// copy of default tab array,
/// or [`None`] if standard tabs are used; must be freed with
/// `Pango::TabArray::free()`.
#[cfg(any(feature = "v4_8", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_8")))]
#[doc(alias = "gtk_label_get_tabs")]
#[doc(alias = "get_tabs")]
pub fn tabs(&self) -> Option<pango::TabArray> {
unsafe { from_glib_full(ffi::gtk_label_get_tabs(self.to_glib_none().0)) }
}
/// Fetches the text from a label.
///
/// The returned text is as it appears on screen. This does not include
/// any embedded underlines indicating mnemonics or Pango markup. (See
/// [`label()`][Self::label()])
///
/// # Returns
///
/// the text in the label widget. This is the internal
/// string used by the label, and must not be modified.
#[doc(alias = "gtk_label_get_text")]
#[doc(alias = "get_text")]
pub fn text(&self) -> glib::GString {
unsafe { from_glib_none(ffi::gtk_label_get_text(self.to_glib_none().0)) }
}
/// Returns whether the label’s text is interpreted as Pango markup.
///
/// See [`set_use_markup()`][Self::set_use_markup()].
///
/// # Returns
///
/// [`true`] if the label’s text will be parsed for markup.
#[doc(alias = "gtk_label_get_use_markup")]
#[doc(alias = "get_use_markup")]
pub fn uses_markup(&self) -> bool {
unsafe { from_glib(ffi::gtk_label_get_use_markup(self.to_glib_none().0)) }
}
/// Returns whether an embedded underlines in the label indicate mnemonics.
///
/// See [`set_use_underline()`][Self::set_use_underline()].
///
/// # Returns
///
/// [`true`] whether an embedded underline in the label indicates
/// the mnemonic accelerator keys.
#[doc(alias = "gtk_label_get_use_underline")]
#[doc(alias = "get_use_underline")]
pub fn uses_underline(&self) -> bool {
unsafe { from_glib(ffi::gtk_label_get_use_underline(self.to_glib_none().0)) }
}
/// Retrieves the desired width of @label, in characters.
///
/// See [`set_width_chars()`][Self::set_width_chars()].
///
/// # Returns
///
/// the width of the label in characters.
#[doc(alias = "gtk_label_get_width_chars")]
#[doc(alias = "get_width_chars")]
pub fn width_chars(&self) -> i32 {
unsafe { ffi::gtk_label_get_width_chars(self.to_glib_none().0) }
}
/// Returns whether lines in the label are automatically wrapped.
///
/// See [`set_wrap()`][Self::set_wrap()].
///
/// # Returns
///
/// [`true`] if the lines of the label are automatically wrapped.
#[doc(alias = "gtk_label_get_wrap")]
#[doc(alias = "get_wrap")]
pub fn wraps(&self) -> bool {
unsafe { from_glib(ffi::gtk_label_get_wrap(self.to_glib_none().0)) }
}
/// Returns line wrap mode used by the label.
///
/// See [`set_wrap_mode()`][Self::set_wrap_mode()].
///
/// # Returns
///
/// the line wrap mode
#[doc(alias = "gtk_label_get_wrap_mode")]
#[doc(alias = "get_wrap_mode")]
pub fn wrap_mode(&self) -> pango::WrapMode {
unsafe { from_glib(ffi::gtk_label_get_wrap_mode(self.to_glib_none().0)) }
}
/// Gets the `xalign` of the label.
///
/// See the `property::Label::xalign` property.
///
/// # Returns
///
/// the xalign property
#[doc(alias = "gtk_label_get_xalign")]
#[doc(alias = "get_xalign")]
pub fn xalign(&self) -> f32 {
unsafe { ffi::gtk_label_get_xalign(self.to_glib_none().0) }
}
/// Gets the `yalign` of the label.
///
/// See the `property::Label::yalign` property.
///
/// # Returns
///
/// the yalign property
#[doc(alias = "gtk_label_get_yalign")]
#[doc(alias = "get_yalign")]
pub fn yalign(&self) -> f32 {
unsafe { ffi::gtk_label_get_yalign(self.to_glib_none().0) }
}
/// Selects a range of characters in the label, if the label is selectable.
///
/// See [`set_selectable()`][Self::set_selectable()]. If the label is not selectable,
/// this function has no effect. If @start_offset or
/// @end_offset are -1, then the end of the label will be substituted.
/// ## `start_offset`
/// start offset (in characters not bytes)
/// ## `end_offset`
/// end offset (in characters not bytes)
#[doc(alias = "gtk_label_select_region")]
pub fn select_region(&self, start_offset: i32, end_offset: i32) {
unsafe {
ffi::gtk_label_select_region(self.to_glib_none().0, start_offset, end_offset);
}
}
/// Apply attributes to the label text.
///
/// The attributes set with this function will be applied and merged with
/// any other attributes previously effected by way of the
/// `property::Label::use-underline` or `property::Label::use-markup`
/// properties. While it is not recommended to mix markup strings with
/// manually set attributes, if you must; know that the attributes will
/// be applied to the label after the markup string is parsed.
/// ## `attrs`
/// a [`pango::AttrList`][crate::pango::AttrList]
#[doc(alias = "gtk_label_set_attributes")]
pub fn set_attributes(&self, attrs: Option<&pango::AttrList>) {
unsafe {
ffi::gtk_label_set_attributes(self.to_glib_none().0, attrs.to_glib_none().0);
}
}
/// Sets the mode used to ellipsizei the text.
///
/// The text will be ellipsized if there is not enough space
/// to render the entire string.
/// ## `mode`
/// a [`pango::EllipsizeMode`][crate::pango::EllipsizeMode]
#[doc(alias = "gtk_label_set_ellipsize")]
pub fn set_ellipsize(&self, mode: pango::EllipsizeMode) {
unsafe {
ffi::gtk_label_set_ellipsize(self.to_glib_none().0, mode.into_glib());
}
}
/// Sets a menu model to add when constructing
/// the context menu for @label.
/// ## `model`
/// a `GMenuModel`
#[doc(alias = "gtk_label_set_extra_menu")]
pub fn set_extra_menu(&self, model: Option<&impl IsA<gio::MenuModel>>) {
unsafe {
ffi::gtk_label_set_extra_menu(
self.to_glib_none().0,
model.map(|p| p.as_ref()).to_glib_none().0,
);
}
}
/// Sets the alignment of the lines in the text of the label relative to
/// each other.
///
/// [`Justification::Left`][crate::Justification::Left] is the default value when the widget is first created
/// with [`new()`][Self::new()]. If you instead want to set the alignment of
/// the label as a whole, use [`WidgetExt::set_halign()`][crate::prelude::WidgetExt::set_halign()] instead.
/// [`set_justify()`][Self::set_justify()] has no effect on labels containing
/// only a single line.
/// ## `jtype`
/// a [`Justification`][crate::Justification]
#[doc(alias = "gtk_label_set_justify")]
pub fn set_justify(&self, jtype: Justification) {
unsafe {
ffi::gtk_label_set_justify(self.to_glib_none().0, jtype.into_glib());
}
}
/// Sets the text of the label.
///
/// The label is interpreted as including embedded underlines and/or Pango
/// markup depending on the values of the `property::Label::use-underline`
/// and `property::Label::use-markup` properties.
/// ## `str`
/// the new text to set for the label
#[doc(alias = "gtk_label_set_label")]
pub fn set_label(&self, str: &str) {
unsafe {
ffi::gtk_label_set_label(self.to_glib_none().0, str.to_glib_none().0);
}
}
/// Sets the number of lines to which an ellipsized, wrapping label
/// should be limited.
///
/// This has no effect if the label is not wrapping or ellipsized.
/// Set this to -1 if you don’t want to limit the number of lines.
/// ## `lines`
/// the desired number of lines, or -1
#[doc(alias = "gtk_label_set_lines")]
pub fn set_lines(&self, lines: i32) {
unsafe {
ffi::gtk_label_set_lines(self.to_glib_none().0, lines);
}
}
/// Sets the labels text and attributes from markup.
///
/// The string must be marked up with Pango markup
/// (see `parse_markup()`).
///
/// If the @str is external data, you may need to escape it
/// with g_markup_escape_text() or g_markup_printf_escaped():
///
/// **⚠️ The following code is in c ⚠️**
///
/// ```c
/// GtkWidget *self = gtk_label_new (NULL);
/// const char *str = "...";
/// const char *format = "<span style=\"italic\">\%s</span>";
/// char *markup;
///
/// markup = g_markup_printf_escaped (format, str);
/// gtk_label_set_markup (GTK_LABEL (self), markup);
/// g_free (markup);
/// ```
///
/// This function will set the `property::Label::use-markup` property
/// to [`true`] as a side effect.
///
/// If you set the label contents using the `property::Label::label`
/// property you should also ensure that you set the
/// `property::Label::use-markup` property accordingly.
///
/// See also: [`set_text()`][Self::set_text()]
/// ## `str`
/// a markup string
#[doc(alias = "gtk_label_set_markup")]
pub fn set_markup(&self, str: &str) {
unsafe {
ffi::gtk_label_set_markup(self.to_glib_none().0, str.to_glib_none().0);
}
}
/// Sets the labels text, attributes and mnemonic from markup.
///
/// Parses @str which is marked up with Pango markup (see `parse_markup()`),
/// setting the label’s text and attribute list based on the parse results.
/// If characters in @str are preceded by an underscore, they are underlined
/// indicating that they represent a keyboard accelerator called a mnemonic.
///
/// The mnemonic key can be used to activate another widget, chosen
/// automatically, or explicitly using [`set_mnemonic_widget()`][Self::set_mnemonic_widget()].
/// ## `str`
/// a markup string
#[doc(alias = "gtk_label_set_markup_with_mnemonic")]
pub fn set_markup_with_mnemonic(&self, str: &str) {
unsafe {
ffi::gtk_label_set_markup_with_mnemonic(self.to_glib_none().0, str.to_glib_none().0);
}
}
/// Sets the desired maximum width in characters of @label to @n_chars.
/// ## `n_chars`
/// the new desired maximum width, in characters.
#[doc(alias = "gtk_label_set_max_width_chars")]
pub fn set_max_width_chars(&self, n_chars: i32) {
unsafe {
ffi::gtk_label_set_max_width_chars(self.to_glib_none().0, n_chars);
}
}
/// Associate the label with its mnemonic target.
///
/// If the label has been set so that it has a mnemonic key (using
/// i.e. [`set_markup_with_mnemonic()`][Self::set_markup_with_mnemonic()],
/// [`set_text_with_mnemonic()`][Self::set_text_with_mnemonic()],
/// [`with_mnemonic()`][Self::with_mnemonic()]
/// or the `property::Label::use_underline` property) the label can be
/// associated with a widget that is the target of the mnemonic. When the
/// label is inside a widget (like a [`Button`][crate::Button] or a
/// [`Notebook`][crate::Notebook] tab) it is automatically associated with the correct
/// widget, but sometimes (i.e. when the target is a [`Entry`][crate::Entry] next to
/// the label) you need to set it explicitly using this function.
///
/// The target widget will be accelerated by emitting the
/// `signal::GtkWidget::mnemonic-activate` signal on it. The default handler for
/// this signal will activate the widget if there are no mnemonic collisions
/// and toggle focus between the colliding widgets otherwise.
/// ## `widget`
/// the target [`Widget`][crate::Widget], or [`None`] to unset
#[doc(alias = "gtk_label_set_mnemonic_widget")]
pub fn set_mnemonic_widget(&self, widget: Option<&impl IsA<Widget>>) {
unsafe {
ffi::gtk_label_set_mnemonic_widget(
self.to_glib_none().0,
widget.map(|p| p.as_ref()).to_glib_none().0,
);
}
}
/// Select the line wrapping for the natural size request.
///
/// This only affects the natural size requested, for the actual wrapping used,
/// see the `property::Label::wrap-mode` property.
/// ## `wrap_mode`
/// the line wrapping mode
#[cfg(any(feature = "v4_6", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_6")))]
#[doc(alias = "gtk_label_set_natural_wrap_mode")]
pub fn set_natural_wrap_mode(&self, wrap_mode: NaturalWrapMode) {
unsafe {
ffi::gtk_label_set_natural_wrap_mode(self.to_glib_none().0, wrap_mode.into_glib());
}
}
/// Makes text in the label selectable.
///
/// Selectable labels allow the user to select text from the label,
/// for copy-and-paste.
/// ## `setting`
/// [`true`] to allow selecting text in the label
#[doc(alias = "gtk_label_set_selectable")]
pub fn set_selectable(&self, setting: bool) {
unsafe {
ffi::gtk_label_set_selectable(self.to_glib_none().0, setting.into_glib());
}
}
/// Sets whether the label is in single line mode.
/// ## `single_line_mode`
/// [`true`] if the label should be in single line mode
#[doc(alias = "gtk_label_set_single_line_mode")]
pub fn set_single_line_mode(&self, single_line_mode: bool) {
unsafe {
ffi::gtk_label_set_single_line_mode(
self.to_glib_none().0,
single_line_mode.into_glib(),
);
}
}
/// Sets the default tab stops for paragraphs in @self.
/// ## `tabs`
/// tabs as a [`pango::TabArray`][crate::pango::TabArray]
#[cfg(any(feature = "v4_8", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_8")))]
#[doc(alias = "gtk_label_set_tabs")]
pub fn set_tabs(&self, tabs: Option<&pango::TabArray>) {
unsafe {
ffi::gtk_label_set_tabs(self.to_glib_none().0, mut_override(tabs.to_glib_none().0));
}
}
/// Sets the text within the [`Label`][crate::Label] widget.
///
/// It overwrites any text that was there before.
///
/// This function will clear any previously set mnemonic accelerators,
/// and set the `property::Label::use-underline` property to [`false`] as
/// a side effect.
///
/// This function will set the `property::Label::use-markup` property
/// to [`false`] as a side effect.
///
/// See also: [`set_markup()`][Self::set_markup()]
/// ## `str`
/// The text you want to set
#[doc(alias = "gtk_label_set_text")]
pub fn set_text(&self, str: &str) {
unsafe {
ffi::gtk_label_set_text(self.to_glib_none().0, str.to_glib_none().0);
}
}
/// Sets the label’s text from the string @str.
///
/// If characters in @str are preceded by an underscore, they are underlined
/// indicating that they represent a keyboard accelerator called a mnemonic.
/// The mnemonic key can be used to activate another widget, chosen
/// automatically, or explicitly using [`set_mnemonic_widget()`][Self::set_mnemonic_widget()].
/// ## `str`
/// a string
#[doc(alias = "gtk_label_set_text_with_mnemonic")]
pub fn set_text_with_mnemonic(&self, str: &str) {
unsafe {
ffi::gtk_label_set_text_with_mnemonic(self.to_glib_none().0, str.to_glib_none().0);
}
}
/// Sets whether the text of the label contains markup.
///
/// See [`set_markup()`][Self::set_markup()].
/// ## `setting`
/// [`true`] if the label’s text should be parsed for markup.
#[doc(alias = "gtk_label_set_use_markup")]
pub fn set_use_markup(&self, setting: bool) {
unsafe {
ffi::gtk_label_set_use_markup(self.to_glib_none().0, setting.into_glib());
}
}
/// Sets whether underlines in the text indicate mnemonics.
/// ## `setting`
/// [`true`] if underlines in the text indicate mnemonics
#[doc(alias = "gtk_label_set_use_underline")]
pub fn set_use_underline(&self, setting: bool) {
unsafe {
ffi::gtk_label_set_use_underline(self.to_glib_none().0, setting.into_glib());
}
}
/// Sets the desired width in characters of @label to @n_chars.
/// ## `n_chars`
/// the new desired width, in characters.
#[doc(alias = "gtk_label_set_width_chars")]
pub fn set_width_chars(&self, n_chars: i32) {
unsafe {
ffi::gtk_label_set_width_chars(self.to_glib_none().0, n_chars);
}
}
/// Toggles line wrapping within the [`Label`][crate::Label] widget.
///
/// [`true`] makes it break lines if text exceeds the widget’s size.
/// [`false`] lets the text get cut off by the edge of the widget if
/// it exceeds the widget size.
///
/// Note that setting line wrapping to [`true`] does not make the label
/// wrap at its parent container’s width, because GTK widgets
/// conceptually can’t make their requisition depend on the parent
/// container’s size. For a label that wraps at a specific position,
/// set the label’s width using [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()].
/// ## `wrap`
/// the setting
#[doc(alias = "gtk_label_set_wrap")]
pub fn set_wrap(&self, wrap: bool) {
unsafe {
ffi::gtk_label_set_wrap(self.to_glib_none().0, wrap.into_glib());
}
}
/// Controls how line wrapping is done.
///
/// This only affects the label if line wrapping is on. (See
/// [`set_wrap()`][Self::set_wrap()]) The default is [`pango::WrapMode::Word`][crate::pango::WrapMode::Word]
/// which means wrap on word boundaries.
///
/// For sizing behavior, also consider the `property::Label::natural-wrap-mode`
/// property.
/// ## `wrap_mode`
/// the line wrapping mode
#[doc(alias = "gtk_label_set_wrap_mode")]
pub fn set_wrap_mode(&self, wrap_mode: pango::WrapMode) {
unsafe {
ffi::gtk_label_set_wrap_mode(self.to_glib_none().0, wrap_mode.into_glib());
}
}
/// Sets the `xalign` of the label.
///
/// See the `property::Label::xalign` property.
/// ## `xalign`
/// the new xalign value, between 0 and 1
#[doc(alias = "gtk_label_set_xalign")]
pub fn set_xalign(&self, xalign: f32) {
unsafe {
ffi::gtk_label_set_xalign(self.to_glib_none().0, xalign);
}
}
/// Sets the `yalign` of the label.
///
/// See the `property::Label::yalign` property.
/// ## `yalign`
/// the new yalign value, between 0 and 1
#[doc(alias = "gtk_label_set_yalign")]
pub fn set_yalign(&self, yalign: f32) {
unsafe {
ffi::gtk_label_set_yalign(self.to_glib_none().0, yalign);
}
}
/// Gets emitted when the user activates a link in the label.
///
/// The ::activate-current-link is a [keybinding signal](class.SignalAction.html).
///
/// Applications may also emit the signal with g_signal_emit_by_name()
/// if they need to control activation of URIs programmatically.
///
/// The default bindings for this signal are all forms of the Enter key.
#[doc(alias = "activate-current-link")]
pub fn connect_activate_current_link<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn activate_current_link_trampoline<F: Fn(&Label) + 'static>(
this: *mut ffi::GtkLabel,
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-current-link\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
activate_current_link_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
pub fn emit_activate_current_link(&self) {
self.emit_by_name::<()>("activate-current-link", &[]);
}
/// Gets emitted to activate a URI.
///
/// Applications may connect to it to override the default behaviour,
/// which is to call [`FileLauncher::launch()`][crate::FileLauncher::launch()].
/// ## `uri`
/// the URI that is activated
///
/// # Returns
///
/// [`true`] if the link has been activated
#[doc(alias = "activate-link")]
pub fn connect_activate_link<F: Fn(&Self, &str) -> glib::signal::Inhibit + 'static>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn activate_link_trampoline<
F: Fn(&Label, &str) -> glib::signal::Inhibit + 'static,
>(
this: *mut ffi::GtkLabel,
uri: *mut libc::c_char,
f: glib::ffi::gpointer,
) -> glib::ffi::gboolean {
let f: &F = &*(f as *const F);
f(
&from_glib_borrow(this),
&glib::GString::from_glib_borrow(uri),
)
.into_glib()
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"activate-link\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
activate_link_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
/// Gets emitted to copy the selection to the clipboard.
///
/// The ::copy-clipboard signal is a [keybinding signal](class.SignalAction.html).
///
/// The default binding for this signal is Ctrl-c.
#[doc(alias = "copy-clipboard")]
pub fn connect_copy_clipboard<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn copy_clipboard_trampoline<F: Fn(&Label) + 'static>(
this: *mut ffi::GtkLabel,
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"copy-clipboard\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
copy_clipboard_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
pub fn emit_copy_clipboard(&self) {
self.emit_by_name::<()>("copy-clipboard", &[]);
}
/// Gets emitted when the user initiates a cursor movement.
///
/// The ::move-cursor signal is a [keybinding signal](class.SignalAction.html).
/// If the cursor is not visible in @entry, this signal causes the viewport to
/// be moved instead.
///
/// Applications should not connect to it, but may emit it with
/// g_signal_emit_by_name() if they need to control the cursor
/// programmatically.
///
/// 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.
/// - Arrow keys move by individual characters/lines
/// - Ctrl-arrow key combinations move by words/paragraphs
/// - Home/End keys move to the ends of the buffer
/// ## `step`
/// the granularity of the move, as a [`MovementStep`][crate::MovementStep]
/// ## `count`
/// the number of @step units to move
/// ## `extend_selection`
/// [`true`] if the move should extend the selection
#[doc(alias = "move-cursor")]
pub fn connect_move_cursor<F: Fn(&Self, MovementStep, i32, bool) + 'static>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn move_cursor_trampoline<
F: Fn(&Label, MovementStep, i32, bool) + 'static,
>(
this: *mut ffi::GtkLabel,
step: ffi::GtkMovementStep,
count: libc::c_int,
extend_selection: 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_selection),
)
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"move-cursor\0".as_ptr() as *const _,
Some(transmute::<_, 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_selection: bool) {
self.emit_by_name::<()>("move-cursor", &[&step, &count, &extend_selection]);
}
#[doc(alias = "attributes")]
pub fn connect_attributes_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_attributes_trampoline<F: Fn(&Label) + 'static>(
this: *mut ffi::GtkLabel,
_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::attributes\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_attributes_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "ellipsize")]
pub fn connect_ellipsize_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_ellipsize_trampoline<F: Fn(&Label) + 'static>(
this: *mut ffi::GtkLabel,
_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::ellipsize\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_ellipsize_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "extra-menu")]
pub fn connect_extra_menu_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_extra_menu_trampoline<F: Fn(&Label) + 'static>(
this: *mut ffi::GtkLabel,
_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::extra-menu\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_extra_menu_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "justify")]
pub fn connect_justify_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_justify_trampoline<F: Fn(&Label) + 'static>(
this: *mut ffi::GtkLabel,
_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::justify\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_justify_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "label")]
pub fn connect_label_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_label_trampoline<F: Fn(&Label) + 'static>(
this: *mut ffi::GtkLabel,
_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::label\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_label_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "lines")]
pub fn connect_lines_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_lines_trampoline<F: Fn(&Label) + 'static>(
this: *mut ffi::GtkLabel,
_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::lines\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_lines_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "max-width-chars")]
pub fn connect_max_width_chars_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_max_width_chars_trampoline<F: Fn(&Label) + 'static>(
this: *mut ffi::GtkLabel,
_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::max-width-chars\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_max_width_chars_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "mnemonic-keyval")]
pub fn connect_mnemonic_keyval_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_mnemonic_keyval_trampoline<F: Fn(&Label) + 'static>(
this: *mut ffi::GtkLabel,
_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::mnemonic-keyval\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_mnemonic_keyval_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "mnemonic-widget")]
pub fn connect_mnemonic_widget_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_mnemonic_widget_trampoline<F: Fn(&Label) + 'static>(
this: *mut ffi::GtkLabel,
_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::mnemonic-widget\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_mnemonic_widget_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[cfg(any(feature = "v4_6", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_6")))]
#[doc(alias = "natural-wrap-mode")]
pub fn connect_natural_wrap_mode_notify<F: Fn(&Self) + 'static>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn notify_natural_wrap_mode_trampoline<F: Fn(&Label) + 'static>(
this: *mut ffi::GtkLabel,
_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::natural-wrap-mode\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_natural_wrap_mode_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "selectable")]
pub fn connect_selectable_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_selectable_trampoline<F: Fn(&Label) + 'static>(
this: *mut ffi::GtkLabel,
_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::selectable\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_selectable_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "single-line-mode")]
pub fn connect_single_line_mode_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_single_line_mode_trampoline<F: Fn(&Label) + 'static>(
this: *mut ffi::GtkLabel,
_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::single-line-mode\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_single_line_mode_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[cfg(any(feature = "v4_8", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_8")))]
#[doc(alias = "tabs")]
pub fn connect_tabs_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_tabs_trampoline<F: Fn(&Label) + 'static>(
this: *mut ffi::GtkLabel,
_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::tabs\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_tabs_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "use-markup")]
pub fn connect_use_markup_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_use_markup_trampoline<F: Fn(&Label) + 'static>(
this: *mut ffi::GtkLabel,
_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::use-markup\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_use_markup_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "use-underline")]
pub fn connect_use_underline_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_use_underline_trampoline<F: Fn(&Label) + 'static>(
this: *mut ffi::GtkLabel,
_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::use-underline\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_use_underline_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "width-chars")]
pub fn connect_width_chars_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_width_chars_trampoline<F: Fn(&Label) + 'static>(
this: *mut ffi::GtkLabel,
_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::width-chars\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_width_chars_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "wrap")]
pub fn connect_wrap_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_wrap_trampoline<F: Fn(&Label) + 'static>(
this: *mut ffi::GtkLabel,
_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::wrap\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_wrap_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "wrap-mode")]
pub fn connect_wrap_mode_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_wrap_mode_trampoline<F: Fn(&Label) + 'static>(
this: *mut ffi::GtkLabel,
_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::wrap-mode\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_wrap_mode_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "xalign")]
pub fn connect_xalign_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_xalign_trampoline<F: Fn(&Label) + 'static>(
this: *mut ffi::GtkLabel,
_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::xalign\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_xalign_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "yalign")]
pub fn connect_yalign_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_yalign_trampoline<F: Fn(&Label) + 'static>(
this: *mut ffi::GtkLabel,
_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::yalign\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_yalign_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl Default for Label {
fn default() -> Self {
glib::object::Object::new::<Self>(&[])
}
}
#[derive(Clone, Default)]
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`Label`] 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 LabelBuilder {
attributes: Option<pango::AttrList>,
ellipsize: Option<pango::EllipsizeMode>,
extra_menu: Option<gio::MenuModel>,
justify: Option<Justification>,
label: Option<String>,
lines: Option<i32>,
max_width_chars: Option<i32>,
mnemonic_widget: Option<Widget>,
#[cfg(any(feature = "v4_6", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_6")))]
natural_wrap_mode: Option<NaturalWrapMode>,
selectable: Option<bool>,
single_line_mode: Option<bool>,
#[cfg(any(feature = "v4_8", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_8")))]
tabs: Option<pango::TabArray>,
use_markup: Option<bool>,
use_underline: Option<bool>,
width_chars: Option<i32>,
wrap: Option<bool>,
wrap_mode: Option<pango::WrapMode>,
xalign: Option<f32>,
yalign: Option<f32>,
can_focus: Option<bool>,
can_target: Option<bool>,
css_classes: Option<Vec<String>>,
css_name: Option<String>,
cursor: Option<gdk::Cursor>,
focus_on_click: Option<bool>,
focusable: Option<bool>,
halign: Option<Align>,
has_tooltip: Option<bool>,
height_request: Option<i32>,
hexpand: Option<bool>,
hexpand_set: Option<bool>,
layout_manager: Option<LayoutManager>,
margin_bottom: Option<i32>,
margin_end: Option<i32>,
margin_start: Option<i32>,
margin_top: Option<i32>,
name: Option<String>,
opacity: Option<f64>,
overflow: Option<Overflow>,
receives_default: Option<bool>,
sensitive: Option<bool>,
tooltip_markup: Option<String>,
tooltip_text: Option<String>,
valign: Option<Align>,
vexpand: Option<bool>,
vexpand_set: Option<bool>,
visible: Option<bool>,
width_request: Option<i32>,
accessible_role: Option<AccessibleRole>,
}
impl LabelBuilder {
// rustdoc-stripper-ignore-next
/// Create a new [`LabelBuilder`].
pub fn new() -> Self {
Self::default()
}
// rustdoc-stripper-ignore-next
/// Build the [`Label`].
#[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
pub fn build(self) -> Label {
let mut properties: Vec<(&str, &dyn ToValue)> = vec![];
if let Some(ref attributes) = self.attributes {
properties.push(("attributes", attributes));
}
if let Some(ref ellipsize) = self.ellipsize {
properties.push(("ellipsize", ellipsize));
}
if let Some(ref extra_menu) = self.extra_menu {
properties.push(("extra-menu", extra_menu));
}
if let Some(ref justify) = self.justify {
properties.push(("justify", justify));
}
if let Some(ref label) = self.label {
properties.push(("label", label));
}
if let Some(ref lines) = self.lines {
properties.push(("lines", lines));
}
if let Some(ref max_width_chars) = self.max_width_chars {
properties.push(("max-width-chars", max_width_chars));
}
if let Some(ref mnemonic_widget) = self.mnemonic_widget {
properties.push(("mnemonic-widget", mnemonic_widget));
}
#[cfg(any(feature = "v4_6", feature = "dox"))]
if let Some(ref natural_wrap_mode) = self.natural_wrap_mode {
properties.push(("natural-wrap-mode", natural_wrap_mode));
}
if let Some(ref selectable) = self.selectable {
properties.push(("selectable", selectable));
}
if let Some(ref single_line_mode) = self.single_line_mode {
properties.push(("single-line-mode", single_line_mode));
}
#[cfg(any(feature = "v4_8", feature = "dox"))]
if let Some(ref tabs) = self.tabs {
properties.push(("tabs", tabs));
}
if let Some(ref use_markup) = self.use_markup {
properties.push(("use-markup", use_markup));
}
if let Some(ref use_underline) = self.use_underline {
properties.push(("use-underline", use_underline));
}
if let Some(ref width_chars) = self.width_chars {
properties.push(("width-chars", width_chars));
}
if let Some(ref wrap) = self.wrap {
properties.push(("wrap", wrap));
}
if let Some(ref wrap_mode) = self.wrap_mode {
properties.push(("wrap-mode", wrap_mode));
}
if let Some(ref xalign) = self.xalign {
properties.push(("xalign", xalign));
}
if let Some(ref yalign) = self.yalign {
properties.push(("yalign", yalign));
}
if let Some(ref can_focus) = self.can_focus {
properties.push(("can-focus", can_focus));
}
if let Some(ref can_target) = self.can_target {
properties.push(("can-target", can_target));
}
if let Some(ref css_classes) = self.css_classes {
properties.push(("css-classes", css_classes));
}
if let Some(ref css_name) = self.css_name {
properties.push(("css-name", css_name));
}
if let Some(ref cursor) = self.cursor {
properties.push(("cursor", cursor));
}
if let Some(ref focus_on_click) = self.focus_on_click {
properties.push(("focus-on-click", focus_on_click));
}
if let Some(ref focusable) = self.focusable {
properties.push(("focusable", focusable));
}
if let Some(ref halign) = self.halign {
properties.push(("halign", halign));
}
if let Some(ref has_tooltip) = self.has_tooltip {
properties.push(("has-tooltip", has_tooltip));
}
if let Some(ref height_request) = self.height_request {
properties.push(("height-request", height_request));
}
if let Some(ref hexpand) = self.hexpand {
properties.push(("hexpand", hexpand));
}
if let Some(ref hexpand_set) = self.hexpand_set {
properties.push(("hexpand-set", hexpand_set));
}
if let Some(ref layout_manager) = self.layout_manager {
properties.push(("layout-manager", layout_manager));
}
if let Some(ref margin_bottom) = self.margin_bottom {
properties.push(("margin-bottom", margin_bottom));
}
if let Some(ref margin_end) = self.margin_end {
properties.push(("margin-end", margin_end));
}
if let Some(ref margin_start) = self.margin_start {
properties.push(("margin-start", margin_start));
}
if let Some(ref margin_top) = self.margin_top {
properties.push(("margin-top", margin_top));
}
if let Some(ref name) = self.name {
properties.push(("name", name));
}
if let Some(ref opacity) = self.opacity {
properties.push(("opacity", opacity));
}
if let Some(ref overflow) = self.overflow {
properties.push(("overflow", overflow));
}
if let Some(ref receives_default) = self.receives_default {
properties.push(("receives-default", receives_default));
}
if let Some(ref sensitive) = self.sensitive {
properties.push(("sensitive", sensitive));
}
if let Some(ref tooltip_markup) = self.tooltip_markup {
properties.push(("tooltip-markup", tooltip_markup));
}
if let Some(ref tooltip_text) = self.tooltip_text {
properties.push(("tooltip-text", tooltip_text));
}
if let Some(ref valign) = self.valign {
properties.push(("valign", valign));
}
if let Some(ref vexpand) = self.vexpand {
properties.push(("vexpand", vexpand));
}
if let Some(ref vexpand_set) = self.vexpand_set {
properties.push(("vexpand-set", vexpand_set));
}
if let Some(ref visible) = self.visible {
properties.push(("visible", visible));
}
if let Some(ref width_request) = self.width_request {
properties.push(("width-request", width_request));
}
if let Some(ref accessible_role) = self.accessible_role {
properties.push(("accessible-role", accessible_role));
}
glib::Object::new::<Label>(&properties)
}
/// A list of style attributes to apply to the text of the label.
pub fn attributes(mut self, attributes: &pango::AttrList) -> Self {
self.attributes = Some(attributes.clone());
self
}
/// The preferred place to ellipsize the string, if the label does
/// not have enough room to display the entire string.
///
/// Note that setting this property to a value other than
/// [`pango::EllipsizeMode::None`][crate::pango::EllipsizeMode::None] has the side-effect that the label requests
/// only enough space to display the ellipsis "...". In particular, this
/// means that ellipsizing labels do not work well in notebook tabs, unless
/// the `property::NotebookPage::tab-expand` child property is set to [`true`].
/// Other ways to set a label's width are [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()]
/// and [`Label::set_width_chars()`][crate::Label::set_width_chars()].
pub fn ellipsize(mut self, ellipsize: pango::EllipsizeMode) -> Self {
self.ellipsize = Some(ellipsize);
self
}
/// A menu model whose contents will be appended to the context menu.
pub fn extra_menu(mut self, extra_menu: &impl IsA<gio::MenuModel>) -> Self {
self.extra_menu = Some(extra_menu.clone().upcast());
self
}
/// The alignment of the lines in the text of the label, relative to each other.
///
/// This does *not* affect the alignment of the label within its allocation.
/// See `property::Label::xalign` for that.
pub fn justify(mut self, justify: Justification) -> Self {
self.justify = Some(justify);
self
}
/// The contents of the label.
///
/// If the string contains Pango markup (see `parse_markup()`),
/// you will have to set the `property::Label::use-markup` property to
/// [`true`] in order for the label to display the markup attributes. See also
/// [`Label::set_markup()`][crate::Label::set_markup()] for a convenience function that sets both
/// this property and the `property::Label::use-markup` property at the
/// same time.
///
/// If the string contains underlines acting as mnemonics, you will have to
/// set the `property::Label::use-underline` property to [`true`] in order
/// for the label to display them.
pub fn label(mut self, label: &str) -> Self {
self.label = Some(label.to_string());
self
}
/// The number of lines to which an ellipsized, wrapping label
/// should be limited.
///
/// This property has no effect if the label is not wrapping or ellipsized.
/// Set this property to -1 if you don't want to limit the number of lines.
pub fn lines(mut self, lines: i32) -> Self {
self.lines = Some(lines);
self
}
/// The desired maximum width of the label, in characters.
///
/// If this property is set to -1, the width will be calculated automatically.
///
/// See the section on [text layout](class.Label.html#text-layout) for details of how
/// `property::Label::width-chars` and `property::Label::max-width-chars`
/// determine the width of ellipsized and wrapped labels.
pub fn max_width_chars(mut self, max_width_chars: i32) -> Self {
self.max_width_chars = Some(max_width_chars);
self
}
/// The widget to be activated when the labels mnemonic key is pressed.
pub fn mnemonic_widget(mut self, mnemonic_widget: &impl IsA<Widget>) -> Self {
self.mnemonic_widget = Some(mnemonic_widget.clone().upcast());
self
}
/// Select the line wrapping for the natural size request.
///
/// This only affects the natural size requested. For the actual wrapping used,
/// see the `property::Label::wrap-mode` property.
///
/// The default is [`NaturalWrapMode::Inherit`][crate::NaturalWrapMode::Inherit], which inherits the behavior of the
/// `property::Label::wrap-mode` property.
#[cfg(any(feature = "v4_6", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_6")))]
pub fn natural_wrap_mode(mut self, natural_wrap_mode: NaturalWrapMode) -> Self {
self.natural_wrap_mode = Some(natural_wrap_mode);
self
}
/// Whether the label text can be selected with the mouse.
pub fn selectable(mut self, selectable: bool) -> Self {
self.selectable = Some(selectable);
self
}
/// Whether the label is in single line mode.
///
/// In single line mode, the height of the label does not depend on the
/// actual text, it is always set to ascent + descent of the font. This
/// can be an advantage in situations where resizing the label because
/// of text changes would be distracting, e.g. in a statusbar.
pub fn single_line_mode(mut self, single_line_mode: bool) -> Self {
self.single_line_mode = Some(single_line_mode);
self
}
/// Custom tabs for this label.
#[cfg(any(feature = "v4_8", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_8")))]
pub fn tabs(mut self, tabs: &pango::TabArray) -> Self {
self.tabs = Some(tabs.clone());
self
}
/// [`true`] if the text of the label includes Pango markup.
///
/// See `parse_markup()`.
pub fn use_markup(mut self, use_markup: bool) -> Self {
self.use_markup = Some(use_markup);
self
}
/// [`true`] if the text of the label indicates a mnemonic with _.
pub fn use_underline(mut self, use_underline: bool) -> Self {
self.use_underline = Some(use_underline);
self
}
/// The desired width of the label, in characters.
///
/// If this property is set to -1, the width will be calculated automatically.
///
/// See the section on [text layout](class.Label.html#text-layout) for details of how
/// `property::Label::width-chars` and `property::Label::max-width-chars`
/// determine the width of ellipsized and wrapped labels.
pub fn width_chars(mut self, width_chars: i32) -> Self {
self.width_chars = Some(width_chars);
self
}
/// [`true`] if the label text will wrap if it gets too wide.
pub fn wrap(mut self, wrap: bool) -> Self {
self.wrap = Some(wrap);
self
}
/// Controls how the line wrapping is done.
///
/// This only affects the formatting if line wrapping is on (see the
/// `property::Label::wrap` property). The default is [`pango::WrapMode::Word`][crate::pango::WrapMode::Word],
/// which means wrap on word boundaries.
///
/// For sizing behavior, also consider the `property::Label::natural-wrap-mode`
/// property.
pub fn wrap_mode(mut self, wrap_mode: pango::WrapMode) -> Self {
self.wrap_mode = Some(wrap_mode);
self
}
/// The horizontal alignment of the label text inside its size allocation.
///
/// Compare this to `property::Widget::halign`, which determines how the
/// labels size allocation is positioned in the space available for the label.
pub fn xalign(mut self, xalign: f32) -> Self {
self.xalign = Some(xalign);
self
}
/// The vertical alignment of the label text inside its size allocation.
///
/// Compare this to `property::Widget::valign`, which determines how the
/// labels size allocation is positioned in the space available for the label.
pub fn yalign(mut self, yalign: f32) -> Self {
self.yalign = Some(yalign);
self
}
/// 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(mut self, can_focus: bool) -> Self {
self.can_focus = Some(can_focus);
self
}
/// Whether the widget can receive pointer events.
pub fn can_target(mut self, can_target: bool) -> Self {
self.can_target = Some(can_target);
self
}
/// A list of css classes applied to this widget.
pub fn css_classes(mut self, css_classes: Vec<String>) -> Self {
self.css_classes = Some(css_classes);
self
}
/// 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(mut self, css_name: &str) -> Self {
self.css_name = Some(css_name.to_string());
self
}
/// The cursor used by @widget.
pub fn cursor(mut self, cursor: &gdk::Cursor) -> Self {
self.cursor = Some(cursor.clone());
self
}
/// 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(mut self, focus_on_click: bool) -> Self {
self.focus_on_click = Some(focus_on_click);
self
}
/// Whether this widget itself will accept the input focus.
pub fn focusable(mut self, focusable: bool) -> Self {
self.focusable = Some(focusable);
self
}
/// How to distribute horizontal space if widget gets extra space.
pub fn halign(mut self, halign: Align) -> Self {
self.halign = Some(halign);
self
}
/// 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 `signal::Widget::query-tooltip` to
/// determine whether it will provide a tooltip or not.
pub fn has_tooltip(mut self, has_tooltip: bool) -> Self {
self.has_tooltip = Some(has_tooltip);
self
}
/// Override for height request of the widget.
///
/// If this is -1, the natural request will be used.
pub fn height_request(mut self, height_request: i32) -> Self {
self.height_request = Some(height_request);
self
}
/// Whether to expand horizontally.
pub fn hexpand(mut self, hexpand: bool) -> Self {
self.hexpand = Some(hexpand);
self
}
/// Whether to use the `hexpand` property.
pub fn hexpand_set(mut self, hexpand_set: bool) -> Self {
self.hexpand_set = Some(hexpand_set);
self
}
/// 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(mut self, layout_manager: &impl IsA<LayoutManager>) -> Self {
self.layout_manager = Some(layout_manager.clone().upcast());
self
}
/// 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(mut self, margin_bottom: i32) -> Self {
self.margin_bottom = Some(margin_bottom);
self
}
/// 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(mut self, margin_end: i32) -> Self {
self.margin_end = Some(margin_end);
self
}
/// 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(mut self, margin_start: i32) -> Self {
self.margin_start = Some(margin_start);
self
}
/// 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(mut self, margin_top: i32) -> Self {
self.margin_top = Some(margin_top);
self
}
/// The name of the widget.
pub fn name(mut self, name: &str) -> Self {
self.name = Some(name.to_string());
self
}
/// The requested opacity of the widget.
pub fn opacity(mut self, opacity: f64) -> Self {
self.opacity = Some(opacity);
self
}
/// 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(mut self, overflow: Overflow) -> Self {
self.overflow = Some(overflow);
self
}
/// Whether the widget will receive the default action when it is focused.
pub fn receives_default(mut self, receives_default: bool) -> Self {
self.receives_default = Some(receives_default);
self
}
/// Whether the widget responds to input.
pub fn sensitive(mut self, sensitive: bool) -> Self {
self.sensitive = Some(sensitive);
self
}
/// 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`]:
/// `property::Widget::has-tooltip` will automatically be set to [`true`]
/// and there will be taken care of `signal::Widget::query-tooltip` in
/// the default signal handler.
///
/// Note that if both `property::Widget::tooltip-text` and
/// `property::Widget::tooltip-markup` are set, the last one wins.
pub fn tooltip_markup(mut self, tooltip_markup: &str) -> Self {
self.tooltip_markup = Some(tooltip_markup.to_string());
self
}
/// 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`]:
/// `property::Widget::has-tooltip` will automatically be set to [`true`]
/// and there will be taken care of `signal::Widget::query-tooltip` in
/// the default signal handler.
///
/// Note that if both `property::Widget::tooltip-text` and
/// `property::Widget::tooltip-markup` are set, the last one wins.
pub fn tooltip_text(mut self, tooltip_text: &str) -> Self {
self.tooltip_text = Some(tooltip_text.to_string());
self
}
/// How to distribute vertical space if widget gets extra space.
pub fn valign(mut self, valign: Align) -> Self {
self.valign = Some(valign);
self
}
/// Whether to expand vertically.
pub fn vexpand(mut self, vexpand: bool) -> Self {
self.vexpand = Some(vexpand);
self
}
/// Whether to use the `vexpand` property.
pub fn vexpand_set(mut self, vexpand_set: bool) -> Self {
self.vexpand_set = Some(vexpand_set);
self
}
/// Whether the widget is visible.
pub fn visible(mut self, visible: bool) -> Self {
self.visible = Some(visible);
self
}
/// Override for width request of the widget.
///
/// If this is -1, the natural request will be used.
pub fn width_request(mut self, width_request: i32) -> Self {
self.width_request = Some(width_request);
self
}
/// The accessible role of the given [`Accessible`][crate::Accessible] implementation.
///
/// The accessible role cannot be changed once set.
pub fn accessible_role(mut self, accessible_role: AccessibleRole) -> Self {
self.accessible_role = Some(accessible_role);
self
}
}
impl fmt::Display for Label {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("Label")
}
}