/usr/include/gtkmm-3.0/gtkmm/entry.h is in libgtkmm-3.0-dev 3.22.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 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 | // Generated by gmmproc 2.54.0 -- DO NOT MODIFY!
#ifndef _GTKMM_ENTRY_H
#define _GTKMM_ENTRY_H
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
/*
* Copyright (C) 1998-2002 The gtkmm Development Team
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#include <gtkmm/widget.h>
#include <gtkmm/editable.h>
#include <gtkmm/menu.h>
#include <gtkmm/celleditable.h>
#include <gtkmm/entrycompletion.h>
#include <gtkmm/adjustment.h>
#include <gtkmm/image.h> //For ImageType.
#include <gtkmm/border.h>
#include <gtkmm/entrybuffer.h>
#include <pangomm/attrlist.h>
#include <pangomm/tabarray.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
using GtkEntry = struct _GtkEntry;
using GtkEntryClass = struct _GtkEntryClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Gtk
{ class Entry_Class; } // namespace Gtk
#endif //DOXYGEN_SHOULD_SKIP_THIS
namespace Gtk
{
/** @addtogroup gtkmmEnums gtkmm Enums and Flags */
/**
* @var EntryIconPosition ENTRY_ICON_PRIMARY
* At the beginning of the entry (depending on the text direction).
*
* @var EntryIconPosition ENTRY_ICON_SECONDARY
* At the end of the entry (depending on the text direction).
*
* @enum EntryIconPosition
*
* Specifies the side of the entry at which an icon is placed.
*
* @newin{2,16}
*
* @ingroup gtkmmEnums
*/
enum EntryIconPosition
{
ENTRY_ICON_PRIMARY,
ENTRY_ICON_SECONDARY
};
} // namespace Gtk
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
template <>
class Value<Gtk::EntryIconPosition> : public Glib::Value_Enum<Gtk::EntryIconPosition>
{
public:
static GType value_type() G_GNUC_CONST;
};
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gtk
{
/** A single line text entry field.
*
* The Gtk::Entry widget is a single line text entry widget. A fairly large
* set of key bindings are supported by default. If the entered text is
* longer than the allocation of the widget, the widget will scroll so that
* the cursor position is visible.
*
* The Entry widget looks like this:
* @image html entry1.png
*
* @ingroup Widgets
*/
class Entry
: public Widget,
public Editable,
public CellEditable
{
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef Entry CppObjectType;
typedef Entry_Class CppClassType;
typedef GtkEntry BaseObjectType;
typedef GtkEntryClass BaseClassType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
Entry(Entry&& src) noexcept;
Entry& operator=(Entry&& src) noexcept;
// noncopyable
Entry(const Entry&) = delete;
Entry& operator=(const Entry&) = delete;
~Entry() noexcept override;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
private:
friend class Entry_Class;
static CppClassType entry_class_;
protected:
explicit Entry(const Glib::ConstructParams& construct_params);
explicit Entry(GtkEntry* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
/** Get the GType for this class, for use with the underlying GObject type system.
*/
static GType get_type() G_GNUC_CONST;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
static GType get_base_type() G_GNUC_CONST;
#endif
///Provides access to the underlying C GtkObject.
GtkEntry* gobj() { return reinterpret_cast<GtkEntry*>(gobject_); }
///Provides access to the underlying C GtkObject.
const GtkEntry* gobj() const { return reinterpret_cast<GtkEntry*>(gobject_); }
public:
//C++ methods used to invoke GTK+ virtual functions:
protected:
//GTK+ Virtual Functions (override these to change behaviour):
//Default Signal Handlers::
/// This is a default handler for the signal signal_populate_popup().
virtual void on_populate_popup(Menu* menu);
/// This is a default handler for the signal signal_insert_at_cursor().
virtual void on_insert_at_cursor(const Glib::ustring& str);
/// This is a default handler for the signal signal_activate().
virtual void on_activate();
private:
public:
Entry();
explicit Entry(const Glib::RefPtr<EntryBuffer>& buffer);
/** Get the Gtk::EntryBuffer object which holds the text for
* this widget.
*
* @newin{2,18}
*
* @return A Gtk::EntryBuffer object.
*/
Glib::RefPtr<EntryBuffer> get_buffer();
/** Get the Gtk::EntryBuffer object which holds the text for
* this widget.
*
* @newin{2,18}
*
* @return A Gtk::EntryBuffer object.
*/
Glib::RefPtr<const EntryBuffer> get_buffer() const;
/** Returns the area where the entry's text is drawn.
* This function is useful when drawing something to the entry in a draw callback.
*
* See also get_icon_area().
*
* @result The location for the text area.
*
* @newin{3,0}
**/
Gdk::Rectangle get_text_area() const;
/** Set the Gtk::EntryBuffer object which holds the text for
* this widget.
*
* @newin{2,18}
*
* @param buffer A Gtk::EntryBuffer.
*/
void set_buffer(const Glib::RefPtr<EntryBuffer>& buffer);
/** Sets whether the contents of the entry are visible or not.
* When visibility is set to <tt>false</tt>, characters are displayed
* as the invisible char, and will also appear that way when
* the text in the entry widget is copied elsewhere.
*
* By default, GTK+ picks the best invisible character available
* in the current font, but it can be changed with
* set_invisible_char().
*
* Note that you probably want to set Gtk::Entry::property_input_purpose()
* to Gtk::INPUT_PURPOSE_PASSWORD or Gtk::INPUT_PURPOSE_PIN to
* inform input methods about the purpose of this entry,
* in addition to setting visibility to <tt>false</tt>.
*
* @param visible <tt>true</tt> if the contents of the entry are displayed
* as plaintext.
*/
void set_visibility(bool visible = true);
/** Retrieves whether the text in @a entry is visible. See
* set_visibility().
*
* @return <tt>true</tt> if the text is currently visible.
*/
bool get_visibility() const;
/** Sets the character to use in place of the actual text when
* set_visibility() has been called to set text visibility
* to <tt>false</tt>. i.e. this is the character used in “password mode” to
* show the user how many characters have been typed. By default, GTK+
* picks the best invisible char available in the current font. If you
* set the invisible char to 0, then the user will get no feedback
* at all; there will be no text on the screen as they type.
*
* @param ch A Unicode character.
*/
void set_invisible_char(gunichar ch);
/** Unsets the invisible char previously set with
* set_invisible_char(). So that the
* default invisible char is used again.
*
* @newin{2,16}
*/
void unset_invisible_char();
/** Retrieves the character displayed in place of the real characters
* for entries with visibility set to false. See set_invisible_char().
*
* @return The current invisible char, or 0, if the entry does not
* show invisible text at all.
*/
gunichar get_invisible_char() const;
/** Sets whether the entry has a beveled frame around it.
*
* @param setting New value.
*/
void set_has_frame(bool setting = true);
/** Gets the value set by set_has_frame().
*
* @return Whether the entry has a beveled frame.
*/
bool get_has_frame() const;
#ifndef GTKMM_DISABLE_DEPRECATED
/** Sets %entry’s inner-border property to @a border, or clears it if <tt>nullptr</tt>
* is passed. The inner-border is the area around the entry’s text, but
* inside its frame.
*
* If set, this property overrides the inner-border style property.
* Overriding the style-provided border is useful when you want to do
* in-place editing of some text in a canvas or list widget, where
* pixel-exact positioning of the entry is important.
*
* @newin{2,10}
*
* Deprecated: 3.4: Use the standard border and padding CSS properties (through
* objects like Gtk::StyleContext and Gtk::CssProvider); the value set with
* this function is ignored by Gtk::Entry.
*
* @deprecated Use the standard border and padding CSS properties instead (through classes like StyleContext and CssProvider).
*
* @param border A Gtk::Border, or <tt>nullptr</tt>.
*/
void set_inner_border(const Border& border);
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** This function returns the entry’s Gtk::Entry::property_inner_border() property. See
* set_inner_border() for more information.
*
* @newin{2,10}
*
* Deprecated: 3.4: Use the standard border and padding CSS properties (through
* objects like Gtk::StyleContext and Gtk::CssProvider); the value returned by
* this function is ignored by Gtk::Entry.
*
* @deprecated Use the standard border and padding CSS properties instead (through classes like StyleContext and CssProvider).
*
* @return The entry’s Gtk::Border, or
* <tt>nullptr</tt> if none was set.
*/
Border get_inner_border() const;
#endif // GTKMM_DISABLE_DEPRECATED
/** Sets whether the text is overwritten when typing in the Gtk::Entry.
*
* @newin{2,14}
*
* @param overwrite New value.
*/
void set_overwrite_mode(bool overwrite = true);
/** Gets the value set by set_overwrite_mode().
*
* @newin{2,14}
*
* @return Whether the text is overwritten when typing.
*/
bool get_overwrite_mode() const;
/** Sets the maximum allowed length of the contents of the widget. If
* the current contents are longer than the given length, then they
* will be truncated to fit.
*
* This is equivalent to:
*
*
* [C example ellipted]
*
* @param max The maximum length of the entry, or 0 for no maximum.
* (other than the maximum length of entries.) The value passed in will
* be clamped to the range 0-65536.
*/
void set_max_length(int max);
/** Retrieves the maximum allowed length of the text in
* @a entry. See set_max_length().
*
* This is equivalent to:
*
*
* [C example ellipted]
*
* @return The maximum allowed number of characters
* in Gtk::Entry, or 0 if there is no maximum.
*/
int get_max_length() const;
/** Retrieves the current length of the text in
* @a entry.
*
* This is equivalent to:
*
*
* [C example ellipted]
*
* @newin{2,14}
*
* @return The current number of characters
* in Gtk::Entry, or 0 if there are none.
*/
guint16 get_text_length() const;
/** If @a setting is <tt>true</tt>, pressing Enter in the @a entry will activate the default
* widget for the window containing the entry. This usually means that
* the dialog box containing the entry will be closed, since the default
* widget is usually one of the dialog buttons.
*
* (For experts: if @a setting is <tt>true</tt>, the entry calls
* Gtk::Window::activate_default() on the window containing the entry, in
* the default handler for the Gtk::Entry::signal_activate() signal.)
*
* @param setting <tt>true</tt> to activate window’s default widget on Enter keypress.
*/
void set_activates_default(bool setting = true);
/** Retrieves the value set by set_activates_default().
*
* @return <tt>true</tt> if the entry will activate the default widget.
*/
gboolean get_activates_default() const;
/** Changes the size request of the entry to be about the right size
* for @a n_chars characters. Note that it changes the size
* request, the size can still be affected by
* how you pack the widget into containers. If @a n_chars is -1, the
* size reverts to the default entry size.
*
* @param n_chars Width in chars.
*/
void set_width_chars(int n_chars);
/** Gets the value set by set_width_chars().
*
* @return Number of chars to request space for, or negative if unset.
*/
int get_width_chars() const;
/** Sets the desired maximum width in characters of @a entry.
*
* @newin{3,12}
*
* @param n_chars The new desired maximum width, in characters.
*/
void set_max_width_chars(int n_chars);
/** Retrieves the desired maximum width of @a entry, in characters.
* See set_max_width_chars().
*
* @newin{3,12}
*
* @return The maximum width of the entry, in characters.
*/
int get_max_width_chars() const;
/** Sets the text in the widget to the given
* value, replacing the current contents.
*
* See Gtk::EntryBuffer::set_text().
*
* @param text The new text.
*/
void set_text(const Glib::ustring & text);
/** Retrieves the contents of the entry widget.
* See also Gtk::Editable::get_chars().
*
* @return The contents of the entry widget.
*/
Glib::ustring get_text() const;
/** Gets the Pango::Layout used to display the entry.
* The layout is useful to e.g. convert text positions to
* pixel positions, in combination with get_layout_offsets().
* The returned layout is owned by the entry and must not be
* modified or freed by the caller.
*
* Keep in mind that the layout text may contain a preedit string, so
* layout_index_to_text_index() and
* text_index_to_layout_index() are needed to convert byte
* indices in the layout to byte indices in the entry contents.
*
* @return The Pango::Layout for this entry.
*/
Glib::RefPtr<Pango::Layout> get_layout();
/** Gets the Pango::Layout used to display the entry.
* The layout is useful to e.g. convert text positions to
* pixel positions, in combination with get_layout_offsets().
* The returned layout is owned by the entry and must not be
* modified or freed by the caller.
*
* Keep in mind that the layout text may contain a preedit string, so
* layout_index_to_text_index() and
* text_index_to_layout_index() are needed to convert byte
* indices in the layout to byte indices in the entry contents.
*
* @return The Pango::Layout for this entry.
*/
Glib::RefPtr<const Pango::Layout> get_layout() const;
/** Obtains the position of the Pango::Layout used to render text
* in the entry, in widget coordinates. Useful if you want to line
* up the text in an entry with some other text, e.g. when using the
* entry to implement editable cells in a sheet widget.
*
* Also useful to convert mouse events into coordinates inside the
* Pango::Layout, e.g. to take some action if some part of the entry text
* is clicked.
*
* Note that as the user scrolls around in the entry the offsets will
* change; you’ll need to connect to the “notify::scroll-offset”
* signal to track this. Remember when using the Pango::Layout
* functions you need to convert to and from pixels using
* PANGO_PIXELS() or Pango::SCALE.
*
* Keep in mind that the layout text may contain a preedit string, so
* layout_index_to_text_index() and
* text_index_to_layout_index() are needed to convert byte
* indices in the layout to byte indices in the entry contents.
*
* @param x Location to store X offset of layout, or <tt>nullptr</tt>.
* @param y Location to store Y offset of layout, or <tt>nullptr</tt>.
*/
void get_layout_offsets(int& x, int& y);
/** Converts from a position in the entry contents (returned
* by get_text()) to a position in the
* entry’s Pango::Layout (returned by get_layout(),
* with text retrieved via pango_layout_get_text()).
*
* @param layout_index Byte index into the entry layout text.
* @return Byte index into the entry contents.
*/
int layout_index_to_text_index(int layout_index) const;
/** Converts from a position in the entry’s Pango::Layout (returned by
* get_layout()) to a position in the entry contents
* (returned by get_text()).
*
* @param text_index Byte index into the entry contents.
* @return Byte index into the entry layout text.
*/
int text_index_to_layout_index(int text_index) const;
/** Hooks up an adjustment to the cursor position in an entry, so that when
* the cursor is moved, the adjustment is scrolled to show that position.
* See Gtk::ScrolledWindow::get_hadjustment() for a typical way of obtaining
* the adjustment.
*
* The adjustment has to be in pixel units and in the same coordinate system
* as the entry.
*
* @newin{2,12}
*
* @param adjustment An adjustment which should be adjusted when the cursor
* is moved, or <tt>nullptr</tt>.
*/
void set_cursor_hadjustment(const Glib::RefPtr<Adjustment>& adjustment);
/** Retrieves the horizontal cursor adjustment for the entry.
* See set_cursor_hadjustment().
*
* @newin{2,12}
*
* @return The horizontal cursor adjustment, or <tt>nullptr</tt>
* if none has been set.
*/
Glib::RefPtr<Adjustment> get_cursor_hadjustment();
/** Retrieves the horizontal cursor adjustment for the entry.
* See set_cursor_hadjustment().
*
* @newin{2,12}
*
* @return The horizontal cursor adjustment, or <tt>nullptr</tt>
* if none has been set.
*/
Glib::RefPtr<const Adjustment> get_cursor_hadjustment() const;
/** Sets the alignment for the contents of the entry. This controls
* the horizontal positioning of the contents when the displayed
* text is shorter than the width of the entry.
*
* @newin{2,4}
*
* @param xalign The horizontal alignment, from 0 (left) to 1 (right).
* Reversed for RTL layouts.
*/
void set_alignment(float xalign);
/** Sets the alignment for the contents of the entry. This controls
* the horizontal positioning of the contents when the displayed
* text is shorter than the width of the entry.
*
* @newin{2,4}
*
* @param xalign The horizontal alignment, from 0 (left) to 1 (right).
* Reversed for RTL layouts.
*/
void set_alignment(Align xalign);
/** Gets the value set by set_alignment().
*
* @newin{2,4}
*
* @return The alignment.
*/
float get_alignment() const;
/** Sets @a completion to be the auxiliary completion object to use with @a entry.
* All further configuration of the completion mechanism is done on
* @a completion using the Gtk::EntryCompletion API. Completion is disabled if
* @a completion is set to <tt>nullptr</tt>.
*
* @newin{2,4}
*
* @param completion The Gtk::EntryCompletion or <tt>nullptr</tt>.
*/
void set_completion(const Glib::RefPtr<EntryCompletion>& completion);
/** Returns the auxiliary completion object currently in use by @a entry.
*
* @newin{2,4}
*
* @return The auxiliary completion object currently
* in use by @a entry.
*/
Glib::RefPtr<EntryCompletion> get_completion();
/** Returns the auxiliary completion object currently in use by @a entry.
*
* @newin{2,4}
*
* @return The auxiliary completion object currently
* in use by @a entry.
*/
Glib::RefPtr<const EntryCompletion> get_completion() const;
/** Causes the entry’s progress indicator to “fill in” the given
* fraction of the bar. The fraction should be between 0.0 and 1.0,
* inclusive.
*
* @newin{2,16}
*
* @param fraction Fraction of the task that’s been completed.
*/
void set_progress_fraction(double fraction);
/** Returns the current fraction of the task that’s been completed.
* See set_progress_fraction().
*
* @newin{2,16}
*
* @return A fraction from 0.0 to 1.0.
*/
double get_progress_fraction() const;
/** Sets the fraction of total entry width to move the progress
* bouncing block for each call to progress_pulse().
*
* @newin{2,16}
*
* @param fraction Fraction between 0.0 and 1.0.
*/
void set_progress_pulse_step(double fraction);
/** Retrieves the pulse step set with set_progress_pulse_step().
*
* @newin{2,16}
*
* @return A fraction from 0.0 to 1.0.
*/
double get_progress_pulse_step();
/** Indicates that some progress is made, but you don’t know how much.
* Causes the entry’s progress indicator to enter “activity mode,”
* where a block bounces back and forth. Each call to
* progress_pulse() causes the block to move by a little bit
* (the amount of movement per pulse is determined by
* set_progress_pulse_step()).
*
* @newin{2,16}
*/
void progress_pulse();
/** Retrieves the text that will be displayed when @a entry is empty and unfocused
*
* @newin{3,2}
*
* @return A pointer to the placeholder text as a string. This string points to internally allocated
* storage in the widget and must not be freed, modified or stored.
*/
Glib::ustring get_placeholder_text() const;
/** Sets text to be displayed in @a entry when it is empty and unfocused.
* This can be used to give a visual hint of the expected contents of
* the Gtk::Entry.
*
* Note that since the placeholder text gets removed when the entry
* received focus, using this feature is a bit problematic if the entry
* is given the initial focus in a window. Sometimes this can be
* worked around by delaying the initial focus setting until the
* first key event arrives.
*
* @newin{3,2}
*
* @param text A string to be displayed when @a entry is empty and unfocused, or <tt>nullptr</tt>.
*/
void set_placeholder_text(const Glib::ustring& text);
//We hand-code these so we can change the parameter order, so we can have a default parameter value:
/** Sets the icon shown in the specified position using a pixbuf.
*
* If @a pixbuf is <tt>nullptr</tt>, no icon will be shown in the specified position.
*
* @newin{2,16}
*
* @param icon_pos Icon position.
* @param pixbuf A Gdk::Pixbuf, or <tt>nullptr</tt>.
*/
void set_icon_from_pixbuf(const Glib::RefPtr<Gdk::Pixbuf>& pixbuf, EntryIconPosition icon_pos = ENTRY_ICON_PRIMARY);
#ifndef GTKMM_DISABLE_DEPRECATED
/** Sets the icon shown in the entry at the specified position from
* a stock image.
*
* If @a stock_id is <tt>nullptr</tt>, no icon will be shown in the specified position.
*
* @newin{2,16}
*
* Deprecated: 3.10: Use set_icon_from_icon_name() instead.
*
* @deprecated Use set_icon_from_icon_name() instead.
*
* @param icon_pos Icon position.
* @param stock_id The name of the stock item, or <tt>nullptr</tt>.
*/
void set_icon_from_stock(const StockID& stock_id, EntryIconPosition icon_pos = ENTRY_ICON_PRIMARY);
#endif // GTKMM_DISABLE_DEPRECATED
/** Sets the icon shown in the entry at the specified position
* from the current icon theme.
*
* If the icon name isn’t known, a “broken image” icon will be displayed
* instead.
*
* If @a icon_name is <tt>nullptr</tt>, no icon will be shown in the specified position.
*
* @newin{2,16}
*
* @param icon_pos The position at which to set the icon.
* @param icon_name An icon name, or <tt>nullptr</tt>.
*/
void set_icon_from_icon_name(const Glib::ustring& icon_name, EntryIconPosition icon_pos = ENTRY_ICON_PRIMARY);
/** Sets the icon shown in the entry at the specified position
* from the current icon theme.
* If the icon isn’t known, a “broken image” icon will be displayed
* instead.
*
* If @a icon is <tt>nullptr</tt>, no icon will be shown in the specified position.
*
* @newin{2,16}
*
* @param icon_pos The position at which to set the icon.
* @param icon The icon to set, or <tt>nullptr</tt>.
*/
void set_icon_from_gicon(const Glib::RefPtr<Gio::Icon>& icon, EntryIconPosition icon_pos = ENTRY_ICON_PRIMARY);
/** Do not show any icon in the specified position.
* See set_icon_from_pixbuf(), set_icon_from_stock(), set_icon_from_icon_name(),
* and set_icon_from_gicon().
*
* @param icon_pos The icon position.
*
* @newin{3,0}
*/
void unset_icon(EntryIconPosition icon_pos = ENTRY_ICON_PRIMARY);
/** Gets the type of representation being used by the icon
* to store image data. If the icon has no image data,
* the return value will be Gtk::IMAGE_EMPTY.
*
* @newin{2,16}
*
* @param icon_pos Icon position.
* @return Image representation being used.
*/
ImageType get_icon_storage_type(EntryIconPosition icon_pos = ENTRY_ICON_PRIMARY) const;
/** Retrieves the image used for the icon.
*
* Unlike the other methods of setting and getting icon data, this
* method will work regardless of whether the icon was set using a
* Gdk::Pixbuf, a Icon, a stock item, or an icon name.
*
* @newin{2,16}
*
* @param icon_pos Icon position.
* @return A Gdk::Pixbuf, or <tt>nullptr</tt> if no icon is
* set for this position.
*/
Glib::RefPtr<Gdk::Pixbuf> get_icon_pixbuf(EntryIconPosition icon_pos = ENTRY_ICON_PRIMARY);
/** Retrieves the image used for the icon.
*
* Unlike the other methods of setting and getting icon data, this
* method will work regardless of whether the icon was set using a
* Gdk::Pixbuf, a Icon, a stock item, or an icon name.
*
* @newin{2,16}
*
* @param icon_pos Icon position.
* @return A Gdk::Pixbuf, or <tt>nullptr</tt> if no icon is
* set for this position.
*/
Glib::RefPtr<const Gdk::Pixbuf> get_icon_pixbuf(EntryIconPosition icon_pos = ENTRY_ICON_PRIMARY) const;
#ifndef GTKMM_DISABLE_DEPRECATED
/** Retrieves the stock id used for the icon, or <tt>nullptr</tt> if there is
* no icon or if the icon was set by some other method (e.g., by
* pixbuf, icon name or gicon).
*
* @newin{2,16}
*
* Deprecated: 3.10: Use get_icon_name() instead.
*
* @deprecated Use get_icon_name() instead.
*
* @param icon_pos Icon position.
* @return A stock id, or <tt>nullptr</tt> if no icon is set or if the icon
* wasn’t set from a stock id.
*/
StockID get_icon_stock(EntryIconPosition icon_pos = ENTRY_ICON_PRIMARY) const;
#endif // GTKMM_DISABLE_DEPRECATED
/** Retrieves the icon name used for the icon, or <tt>nullptr</tt> if there is
* no icon or if the icon was set by some other method (e.g., by
* pixbuf, stock or gicon).
*
* @newin{2,16}
*
* @param icon_pos Icon position.
* @return An icon name, or <tt>nullptr</tt> if no icon is set or if the icon
* wasn’t set from an icon name.
*/
Glib::ustring get_icon_name(EntryIconPosition icon_pos = ENTRY_ICON_PRIMARY) const;
/** Retrieves the Icon used for the icon, or <tt>nullptr</tt> if there is
* no icon or if the icon was set by some other method (e.g., by
* stock, pixbuf, or icon name).
*
* @newin{2,16}
*
* @param icon_pos Icon position.
* @return A Icon, or <tt>nullptr</tt> if no icon is set
* or if the icon is not a Icon.
*/
Glib::RefPtr<Gio::Icon> get_icon_gicon(EntryIconPosition icon_pos = ENTRY_ICON_PRIMARY);
/** Retrieves the Icon used for the icon, or <tt>nullptr</tt> if there is
* no icon or if the icon was set by some other method (e.g., by
* stock, pixbuf, or icon name).
*
* @newin{2,16}
*
* @param icon_pos Icon position.
* @return A Icon, or <tt>nullptr</tt> if no icon is set
* or if the icon is not a Icon.
*/
Glib::RefPtr<const Gio::Icon> get_icon_gicon(EntryIconPosition icon_pos = ENTRY_ICON_PRIMARY) const;
/** Sets whether the icon is activatable.
*
* @newin{2,16}
*
* @param icon_pos Icon position.
* @param activatable <tt>true</tt> if the icon should be activatable.
*/
void set_icon_activatable(bool activatable = true, EntryIconPosition icon_pos = ENTRY_ICON_PRIMARY);
/** Returns whether the icon is activatable.
*
* @newin{2,16}
*
* @param icon_pos Icon position.
* @return <tt>true</tt> if the icon is activatable.
*/
bool get_icon_activatable(EntryIconPosition icon_pos = ENTRY_ICON_PRIMARY) const;
/** Sets the sensitivity for the specified icon.
*
* @newin{2,16}
*
* @param icon_pos Icon position.
* @param sensitive Specifies whether the icon should appear
* sensitive or insensitive.
*/
void set_icon_sensitive(EntryIconPosition icon_pos = ENTRY_ICON_PRIMARY, bool sensitive = true);
/** Returns whether the icon appears sensitive or insensitive.
*
* @newin{2,16}
*
* @param icon_pos Icon position.
* @return <tt>true</tt> if the icon is sensitive.
*/
bool get_icon_sensitive(EntryIconPosition icon_pos = ENTRY_ICON_PRIMARY);
/** Finds the icon at the given position and return its index. The
* position’s coordinates are relative to the @a entry’s top left corner.
* If @a x, @a y doesn’t lie inside an icon, -1 is returned.
* This function is intended for use in a Gtk::Widget::signal_query_tooltip()
* signal handler.
*
* @newin{2,16}
*
* @param x The x coordinate of the position to find.
* @param y The y coordinate of the position to find.
* @return The index of the icon at the given position, or -1.
*/
int get_icon_at_pos(int x, int y) const;
/** Sets @a tooltip as the contents of the tooltip for the icon
* at the specified position.
*
* Use <tt>nullptr</tt> for @a tooltip to remove an existing tooltip.
*
* See also Gtk::Widget::set_tooltip_text() and
* set_icon_tooltip_markup().
*
* @newin{2,16}
*
* @param icon_pos The icon position.
* @param tooltip The contents of the tooltip for the icon, or <tt>nullptr</tt>.
*/
void set_icon_tooltip_text(const Glib::ustring& tooltip, EntryIconPosition icon_pos = ENTRY_ICON_PRIMARY);
/** Gets the contents of the tooltip on the icon at the specified
* position in @a entry.
*
* @newin{2,16}
*
* @param icon_pos The icon position.
* @return The tooltip text, or <tt>nullptr</tt>.
*/
Glib::ustring get_icon_tooltip_text(EntryIconPosition icon_pos = ENTRY_ICON_PRIMARY) const;
/** Sets @a tooltip as the contents of the tooltip for the icon at
* the specified position. @a tooltip is assumed to be marked up with
* the [Pango text markup language][PangoMarkupFormat].
*
* Use <tt>nullptr</tt> for @a tooltip to remove an existing tooltip.
*
* See also Gtk::Widget::set_tooltip_markup() and
* set_icon_tooltip_text().
*
* @newin{2,16}
*
* @param icon_pos The icon position.
* @param tooltip The contents of the tooltip for the icon, or <tt>nullptr</tt>.
*/
void set_icon_tooltip_markup(const Glib::ustring& tooltip, EntryIconPosition icon_pos = ENTRY_ICON_PRIMARY);
/** Gets the contents of the tooltip on the icon at the specified
* position in @a entry.
*
* @newin{2,16}
*
* @param icon_pos The icon position.
* @return The tooltip text, or <tt>nullptr</tt>.
*/
Glib::ustring get_icon_tooltip_markup(EntryIconPosition icon_pos = ENTRY_ICON_PRIMARY) const;
/** Sets up the icon at the given position so that GTK+ will start a drag
* operation when the user clicks and drags the icon.
*
* To handle the drag operation, you need to connect to the usual
* Gtk::Widget::signal_drag_data_get() (or possibly Gtk::Widget::signal_drag_data_delete())
* signal, and use get_current_icon_drag_source() in
* your signal handler to find out if the drag was started from
* an icon.
*
* By default, GTK+ uses the icon as the drag icon. You can use the
* Gtk::Widget::signal_drag_begin() signal to set a different icon. Note that you
* have to use Glib::signal_connect_after() to ensure that your signal handler
* gets executed after the default handler.
*
* @newin{2,16}
*
* @param icon_pos Icon position.
* @param target_list The targets (data formats) in which the data can be provided.
* @param actions A bitmask of the allowed drag actions.
*/
void set_icon_drag_source(const Glib::RefPtr<TargetList>& target_list, Gdk::DragAction actions = Gdk::ACTION_COPY, EntryIconPosition icon_pos = ENTRY_ICON_PRIMARY);
/** Returns the area where entry's icon at @a icon_pos is drawn.
* This function is useful when drawing something to the
* entry in a draw callback.
*
* See also get_text_area().
*
* @param icon_pos Icon position.
* @result The location for the icon area.
*
* @newin{3,0}
*/
Gdk::Rectangle get_icon_area(EntryIconPosition icon_pos = ENTRY_ICON_PRIMARY) const;
/** Returns the index of the icon which is the source of the current
* DND operation, or -1.
*
* This function is meant to be used in a Gtk::Widget::signal_drag_data_get()
* callback.
*
* @newin{2,16}
*
* @return Index of the icon which is the source of the current
* DND operation, or -1.
*/
int get_current_icon_drag_source();
/** Allow the Gtk::Entry input method to internally handle key press
* and release events. If this function returns <tt>true</tt>, then no further
* processing should be done for this key event. See
* gtk_im_context_filter_keypress().
*
* Note that you are expected to call this function from your handler
* when overriding key event handling. This is needed in the case when
* you need to insert your own key handling between the input method
* and the default key event handling of the Gtk::Entry.
* See Gtk::TextView::reset_im_context() for an example of use.
*
* @newin{2,22}
*
* @param gdk_event The key event.
* @return <tt>true</tt> if the input method handled the key event.
*/
bool im_context_filter_keypress(GdkEventKey* gdk_event);
/** Reset the input method context of the entry if needed.
*
* This can be necessary in the case where modifying the buffer
* would confuse on-going input method behavior.
*
* @newin{2,22}
*/
void reset_im_context();
/** Sets the Gtk::Entry::property_input_purpose() property which
* can be used by on-screen keyboards and other input
* methods to adjust their behaviour.
*
* @newin{3,6}
*
* @param purpose The purpose.
*/
void set_input_purpose(InputPurpose purpose);
/** Gets the value of the Gtk::Entry::property_input_purpose() property.
*
* @newin{3,6}
*/
InputPurpose get_input_purpose() const;
/** Sets the Gtk::Entry::property_input_hints() property, which
* allows input methods to fine-tune their behaviour.
*
* @newin{3,6}
*
* @param hints The hints.
*/
void set_input_hints(InputHints hints);
/** Gets the value of the Gtk::Entry::property_input_hints() property.
*
* @newin{3,6}
*/
InputHints get_input_hints() const;
/** Sets a Pango::AttrList; the attributes in the list are applied to the
* entry text.
*
* @newin{3,6}
*
* @param attrs A Pango::AttrList.
*/
void set_attributes(Pango::AttrList& attrs);
/** Gets the attribute list that was set on the entry using
* set_attributes(), if any.
*
* @newin{3,6}
*
* @return The attribute list, or <tt>nullptr</tt>
* if none was set.
*/
Pango::AttrList get_attributes() const;
/** Sets a Pango::TabArray; the tabstops in the array are applied to the entry
* text.
*
* @newin{3,10}
*
* @param tabs A Pango::TabArray.
*/
void set_tabs(const Pango::TabArray& tabs);
/** Gets the tabstops that were set on the entry using set_tabs(), if
* any.
*
* @newin{3,10}
*
* @return The tabstops, or <tt>nullptr</tt> if none was set.
*/
Pango::TabArray get_tabs() const;
/** Causes @a entry to have keyboard focus.
*
* It behaves like Gtk::Widget::grab_focus(),
* except that it doesn't select the contents of the entry.
* You only want to call this on some special entries
* which the user usually doesn't want to replace all text in,
* such as search-as-you-type entries.
*
* @newin{3,16}
*/
void grab_focus_without_selecting();
//TODO: This signal now takes a GtkWidget* instead of just a GtkMenu*,
//so change that when we can break ABI.
//See https://git.gnome.org/browse/gtk+/commit/?id=88623b98a7ca0afca08ac21bc3aa662c6ed3ab7f
/**
* @par Slot Prototype:
* <tt>void on_my_%populate_popup(Menu* menu)</tt>
*
* Flags: Run Last
*
* The signal_populate_popup() signal gets emitted before showing the
* context menu of the entry.
*
* If you need to add items to the context menu, connect
* to this signal and append your items to the @a widget, which
* will be a Gtk::Menu in this case.
*
* If Gtk::Entry::property_populate_all() is <tt>true</tt>, this signal will
* also be emitted to populate touch popups. In this case,
* @a widget will be a different container, e.g. a Gtk::Toolbar.
* The signal handler should not make assumptions about the
* type of @a widget.
*
* @param menu The container that is being populated.
*/
Glib::SignalProxy< void,Menu* > signal_populate_popup();
/**
* @par Slot Prototype:
* <tt>void on_my_%insert_at_cursor(const Glib::ustring& str)</tt>
*
* Flags: Run Last
*
* The signal_insert_at_cursor() signal is a
* [keybinding signal][GtkBindingSignal]
* which gets emitted when the user initiates the insertion of a
* fixed string at the cursor.
*
* This signal has no default bindings.
*
* @param str The string to insert.
*/
Glib::SignalProxy< void,const Glib::ustring& > signal_insert_at_cursor();
//Note that the GTK+ C documentation for the activate signal says (as of 2012-06) that it should be used by applications even though it is a keybinding signal.
/**
* @par Slot Prototype:
* <tt>void on_my_%activate()</tt>
*
* Flags: Run Last
*
* The signal_activate() signal is emitted when the user hits
* the Enter key.
*
* While this signal is used as a
* [keybinding signal][GtkBindingSignal],
* it is also commonly used by applications to intercept
* activation of entries.
*
* The default bindings for this signal are all forms of the Enter key.
*/
Glib::SignalProxy< void > signal_activate();
/**
* @par Slot Prototype:
* <tt>void on_my_%icon_release(EntryIconPosition icon_position, const GdkEventButton* event)</tt>
*
* Flags: Run Last
*
* The signal_icon_release() signal is emitted on the button release from a
* mouse click over an activatable icon.
*
* @newin{2,16}
*
* @param icon_position The position of the clicked icon.
* @param event The button release event.
*/
Glib::SignalProxy< void,EntryIconPosition,const GdkEventButton* > signal_icon_release();
/**
* @par Slot Prototype:
* <tt>void on_my_%icon_press(EntryIconPosition icon_position, const GdkEventButton* event)</tt>
*
* Flags: Run Last
*
* The signal_icon_press() signal is emitted when an activatable icon
* is clicked.
*
* @newin{2,16}
*
* @param icon_position The position of the clicked icon.
* @param event The button press event.
*/
Glib::SignalProxy< void,EntryIconPosition,const GdkEventButton* > signal_icon_press();
/** Text buffer object which actually stores entry text.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Glib::RefPtr<EntryBuffer> > property_buffer() ;
/** Text buffer object which actually stores entry text.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<EntryBuffer> > property_buffer() const;
/** The current position of the insertion cursor in chars.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< int > property_cursor_position() const;
/** The position of the opposite end of the selection from the cursor in chars.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< int > property_selection_bound() const;
/** Whether the entry contents can be edited.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_editable() ;
/** Whether the entry contents can be edited.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_editable() const;
/** Maximum number of characters for this entry. Zero if no maximum.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< int > property_max_length() ;
/** Maximum number of characters for this entry. Zero if no maximum.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< int > property_max_length() const;
/** FALSE displays the 'invisible char' instead of the actual text (password mode).
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_visibility() ;
/** FALSE displays the 'invisible char' instead of the actual text (password mode).
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_visibility() const;
/** FALSE removes outside bevel from entry.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_has_frame() ;
/** FALSE removes outside bevel from entry.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_has_frame() const;
#ifndef GTKMM_DISABLE_DEPRECATED
/** Sets the text area's border between the text and the frame.
*
* @newin{2,10}
*
* Deprecated: 3.4: Use the standard border and padding CSS properties
* (through objects like Gtk::StyleContext and Gtk::CssProvider); the value
* of this style property is ignored.
*
* @deprecated Use the standard border and padding CSS properties (through objects like StyleContext and CssProvider); the value of this style property is ignored.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Border > property_inner_border() ;
/** Sets the text area's border between the text and the frame.
*
* @newin{2,10}
*
* Deprecated: 3.4: Use the standard border and padding CSS properties
* (through objects like Gtk::StyleContext and Gtk::CssProvider); the value
* of this style property is ignored.
*
* @deprecated Use the standard border and padding CSS properties (through objects like StyleContext and CssProvider); the value of this style property is ignored.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Border > property_inner_border() const;
#endif // GTKMM_DISABLE_DEPRECATED
/** The invisible character is used when masking entry contents (in
* \\"password mode\\")"). When it is not explicitly set with the
* Gtk::Entry::property_invisible_char() property, GTK+ determines the character
* to use from a list of possible candidates, depending on availability
* in the current font.
*
* This style property allows the theme to prepend a character
* to the list of candidates.
*
* @newin{2,18}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< gunichar > property_invisible_char() ;
/** The invisible character is used when masking entry contents (in
* \\"password mode\\")"). When it is not explicitly set with the
* Gtk::Entry::property_invisible_char() property, GTK+ determines the character
* to use from a list of possible candidates, depending on availability
* in the current font.
*
* This style property allows the theme to prepend a character
* to the list of candidates.
*
* @newin{2,18}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< gunichar > property_invisible_char() const;
/** Whether the invisible char has been set for the Gtk::Entry.
*
* @newin{2,16}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_invisible_char_set() ;
/** Whether the invisible char has been set for the Gtk::Entry.
*
* @newin{2,16}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_invisible_char_set() const;
/** Whether to activate the default widget (such as the default button in a dialog) when Enter is pressed.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_activates_default() ;
/** Whether to activate the default widget (such as the default button in a dialog) when Enter is pressed.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_activates_default() const;
/** Number of characters to leave space for in the entry.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< int > property_width_chars() ;
/** Number of characters to leave space for in the entry.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< int > property_width_chars() const;
/** The desired maximum width of the entry, in characters.
* If this property is set to -1, the width will be calculated
* automatically.
*
* @newin{3,12}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< int > property_max_width_chars() ;
/** The desired maximum width of the entry, in characters.
* If this property is set to -1, the width will be calculated
* automatically.
*
* @newin{3,12}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< int > property_max_width_chars() const;
/** Number of pixels of the entry scrolled off the screen to the left.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< int > property_scroll_offset() const;
#ifndef GTKMM_DISABLE_DEPRECATED
/** Which kind of shadow to draw around the entry when
* Gtk::Entry::property_has_frame() is set to <tt>true</tt>.
*
* Deprecated: 3.20: Use CSS to determine the style of the border;
* the value of this style property is ignored.
*
* @newin{2,12}
*
* @deprecated This property is ignored. Use CSS to determine the style of the border.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< ShadowType > property_shadow_type() ;
/** Which kind of shadow to draw around the entry when
* Gtk::Entry::property_has_frame() is set to <tt>true</tt>.
*
* Deprecated: 3.20: Use CSS to determine the style of the border;
* the value of this style property is ignored.
*
* @newin{2,12}
*
* @deprecated This property is ignored. Use CSS to determine the style of the border.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< ShadowType > property_shadow_type() const;
#endif // GTKMM_DISABLE_DEPRECATED
/** The contents of the entry.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Glib::ustring > property_text() ;
/** The contents of the entry.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_text() const;
/** The horizontal alignment, from 0 (left) to 1 (right).
* Reversed for RTL layouts.
*
* @newin{2,4}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< float > property_xalign() ;
/** The horizontal alignment, from 0 (left) to 1 (right).
* Reversed for RTL layouts.
*
* @newin{2,4}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< float > property_xalign() const;
/** When <tt>true</tt>, pasted multi-line text is truncated to the first line.
*
* @newin{2,10}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_truncate_multiline() ;
/** When <tt>true</tt>, pasted multi-line text is truncated to the first line.
*
* @newin{2,10}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_truncate_multiline() const;
/** If text is overwritten when typing in the Gtk::Entry.
*
* @newin{2,14}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_overwrite_mode() ;
/** If text is overwritten when typing in the Gtk::Entry.
*
* @newin{2,14}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_overwrite_mode() const;
/** The length of the text in the Gtk::Entry.
*
* @newin{2,14}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< guint > property_text_length() const;
/** Whether password entries will show a warning when Caps Lock is on.
*
* Note that the warning is shown using a secondary icon, and thus
* does not work if you are using the secondary icon position for some
* other purpose.
*
* @newin{2,16}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_caps_lock_warning() ;
/** Whether password entries will show a warning when Caps Lock is on.
*
* Note that the warning is shown using a secondary icon, and thus
* does not work if you are using the secondary icon position for some
* other purpose.
*
* @newin{2,16}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_caps_lock_warning() const;
/** The current fraction of the task that's been completed.
*
* @newin{2,16}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< double > property_progress_fraction() ;
/** The current fraction of the task that's been completed.
*
* @newin{2,16}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< double > property_progress_fraction() const;
/** The fraction of total entry width to move the progress
* bouncing block for each call to Gtk::Entry::progress_pulse().
*
* @newin{2,16}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< double > property_progress_pulse_step() ;
/** The fraction of total entry width to move the progress
* bouncing block for each call to Gtk::Entry::progress_pulse().
*
* @newin{2,16}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< double > property_progress_pulse_step() const;
/** A pixbuf to use as the primary icon for the entry.
*
* @newin{2,16}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Glib::RefPtr<Gdk::Pixbuf> > property_primary_icon_pixbuf() ;
/** A pixbuf to use as the primary icon for the entry.
*
* @newin{2,16}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gdk::Pixbuf> > property_primary_icon_pixbuf() const;
/** An pixbuf to use as the secondary icon for the entry.
*
* @newin{2,16}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Glib::RefPtr<Gdk::Pixbuf> > property_secondary_icon_pixbuf() ;
/** An pixbuf to use as the secondary icon for the entry.
*
* @newin{2,16}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gdk::Pixbuf> > property_secondary_icon_pixbuf() const;
#ifndef GTKMM_DISABLE_DEPRECATED
/** The stock id to use for the primary icon for the entry.
*
* @newin{2,16}
*
* Deprecated: 3.10: Use Gtk::Entry::property_primary_icon_name() instead.
*
* @deprecated Use property_primary_icon_name() instead.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< StockID > property_primary_icon_stock() ;
/** The stock id to use for the primary icon for the entry.
*
* @newin{2,16}
*
* Deprecated: 3.10: Use Gtk::Entry::property_primary_icon_name() instead.
*
* @deprecated Use property_primary_icon_name() instead.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< StockID > property_primary_icon_stock() const;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** The stock id to use for the secondary icon for the entry.
*
* @newin{2,16}
*
* Deprecated: 3.10: Use Gtk::Entry::property_secondary_icon_name() instead.
*
* @deprecated Use property_secondary_icon_name() instead.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< StockID > property_secondary_icon_stock() ;
/** The stock id to use for the secondary icon for the entry.
*
* @newin{2,16}
*
* Deprecated: 3.10: Use Gtk::Entry::property_secondary_icon_name() instead.
*
* @deprecated Use property_secondary_icon_name() instead.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< StockID > property_secondary_icon_stock() const;
#endif // GTKMM_DISABLE_DEPRECATED
/** The icon name to use for the primary icon for the entry.
*
* @newin{2,16}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Glib::ustring > property_primary_icon_name() ;
/** The icon name to use for the primary icon for the entry.
*
* @newin{2,16}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_primary_icon_name() const;
/** The icon name to use for the secondary icon for the entry.
*
* @newin{2,16}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Glib::ustring > property_secondary_icon_name() ;
/** The icon name to use for the secondary icon for the entry.
*
* @newin{2,16}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_secondary_icon_name() const;
/** The Icon to use for the primary icon for the entry.
*
* @newin{2,16}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Glib::RefPtr<Gio::Icon> > property_primary_icon_gicon() ;
/** The Icon to use for the primary icon for the entry.
*
* @newin{2,16}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gio::Icon> > property_primary_icon_gicon() const;
/** The Icon to use for the secondary icon for the entry.
*
* @newin{2,16}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Glib::RefPtr<Gio::Icon> > property_secondary_icon_gicon() ;
/** The Icon to use for the secondary icon for the entry.
*
* @newin{2,16}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gio::Icon> > property_secondary_icon_gicon() const;
/** The representation which is used for the primary icon of the entry.
*
* @newin{2,16}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< ImageType > property_primary_icon_storage_type() const;
/** The representation which is used for the secondary icon of the entry.
*
* @newin{2,16}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< ImageType > property_secondary_icon_storage_type() const;
/** Whether the primary icon is activatable.
*
* GTK+ emits the Gtk::Entry::signal_icon_press() and Gtk::Entry::signal_icon_release()
* signals only on sensitive, activatable icons.
*
* Sensitive, but non-activatable icons can be used for purely
* informational purposes.
*
* @newin{2,16}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_primary_icon_activatable() ;
/** Whether the primary icon is activatable.
*
* GTK+ emits the Gtk::Entry::signal_icon_press() and Gtk::Entry::signal_icon_release()
* signals only on sensitive, activatable icons.
*
* Sensitive, but non-activatable icons can be used for purely
* informational purposes.
*
* @newin{2,16}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_primary_icon_activatable() const;
/** Whether the secondary icon is activatable.
*
* GTK+ emits the Gtk::Entry::signal_icon_press() and Gtk::Entry::signal_icon_release()
* signals only on sensitive, activatable icons.
*
* Sensitive, but non-activatable icons can be used for purely
* informational purposes.
*
* @newin{2,16}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_secondary_icon_activatable() ;
/** Whether the secondary icon is activatable.
*
* GTK+ emits the Gtk::Entry::signal_icon_press() and Gtk::Entry::signal_icon_release()
* signals only on sensitive, activatable icons.
*
* Sensitive, but non-activatable icons can be used for purely
* informational purposes.
*
* @newin{2,16}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_secondary_icon_activatable() const;
/** Whether the primary icon is sensitive.
*
* An insensitive icon appears grayed out. GTK+ does not emit the
* Gtk::Entry::signal_icon_press() and Gtk::Entry::signal_icon_release() signals and
* does not allow DND from insensitive icons.
*
* An icon should be set insensitive if the action that would trigger
* when clicked is currently not available.
*
* @newin{2,16}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_primary_icon_sensitive() ;
/** Whether the primary icon is sensitive.
*
* An insensitive icon appears grayed out. GTK+ does not emit the
* Gtk::Entry::signal_icon_press() and Gtk::Entry::signal_icon_release() signals and
* does not allow DND from insensitive icons.
*
* An icon should be set insensitive if the action that would trigger
* when clicked is currently not available.
*
* @newin{2,16}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_primary_icon_sensitive() const;
/** Whether the secondary icon is sensitive.
*
* An insensitive icon appears grayed out. GTK+ does not emit the
* Gtk::Entry::signal_icon_press() and Gtk::Entry::signal_icon_release() signals and
* does not allow DND from insensitive icons.
*
* An icon should be set insensitive if the action that would trigger
* when clicked is currently not available.
*
* @newin{2,16}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_secondary_icon_sensitive() ;
/** Whether the secondary icon is sensitive.
*
* An insensitive icon appears grayed out. GTK+ does not emit the
* Gtk::Entry::signal_icon_press() and Gtk::Entry::signal_icon_release() signals and
* does not allow DND from insensitive icons.
*
* An icon should be set insensitive if the action that would trigger
* when clicked is currently not available.
*
* @newin{2,16}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_secondary_icon_sensitive() const;
/** The contents of the tooltip on the primary icon.
*
* Also see Gtk::Entry::set_icon_tooltip_text().
*
* @newin{2,16}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_primary_icon_tooltip_text() ;
/** The contents of the tooltip on the primary icon.
*
* Also see Gtk::Entry::set_icon_tooltip_text().
*
* @newin{2,16}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_primary_icon_tooltip_text() const;
/** The contents of the tooltip on the secondary icon.
*
* Also see Gtk::Entry::set_icon_tooltip_text().
*
* @newin{2,16}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_secondary_icon_tooltip_text() ;
/** The contents of the tooltip on the secondary icon.
*
* Also see Gtk::Entry::set_icon_tooltip_text().
*
* @newin{2,16}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_secondary_icon_tooltip_text() const;
/** The contents of the tooltip on the primary icon, which is marked up
* with the [Pango text markup language][PangoMarkupFormat].
*
* Also see Gtk::Entry::set_icon_tooltip_markup().
*
* @newin{2,16}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_primary_icon_tooltip_markup() ;
/** The contents of the tooltip on the primary icon, which is marked up
* with the [Pango text markup language][PangoMarkupFormat].
*
* Also see Gtk::Entry::set_icon_tooltip_markup().
*
* @newin{2,16}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_primary_icon_tooltip_markup() const;
/** The contents of the tooltip on the secondary icon, which is marked up
* with the [Pango text markup language][PangoMarkupFormat].
*
* Also see Gtk::Entry::set_icon_tooltip_markup().
*
* @newin{2,16}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_secondary_icon_tooltip_markup() ;
/** The contents of the tooltip on the secondary icon, which is marked up
* with the [Pango text markup language][PangoMarkupFormat].
*
* Also see Gtk::Entry::set_icon_tooltip_markup().
*
* @newin{2,16}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_secondary_icon_tooltip_markup() const;
/** Which IM (input method) module should be used for this entry.
* See Gtk::IMContext.
*
* Setting this to a non-<tt>nullptr</tt> value overrides the
* system-wide IM module setting. See the GtkSettings
* Gtk::Settings::property_gtk_im_module() property.
*
* @newin{2,16}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Glib::ustring > property_im_module() ;
/** Which IM (input method) module should be used for this entry.
* See Gtk::IMContext.
*
* Setting this to a non-<tt>nullptr</tt> value overrides the
* system-wide IM module setting. See the GtkSettings
* Gtk::Settings::property_gtk_im_module() property.
*
* @newin{2,16}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_im_module() const;
/** The text that will be displayed in the Gtk::Entry when it is empty
* and unfocused.
*
* @newin{3,2}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Glib::ustring > property_placeholder_text() ;
/** The text that will be displayed in the Gtk::Entry when it is empty
* and unfocused.
*
* @newin{3,2}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_placeholder_text() const;
/** The auxiliary completion object to use with the entry.
*
* @newin{3,2}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Glib::RefPtr<EntryCompletion> > property_completion() ;
/** The auxiliary completion object to use with the entry.
*
* @newin{3,2}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<EntryCompletion> > property_completion() const;
/** The purpose of this text field.
*
* This property can be used by on-screen keyboards and other input
* methods to adjust their behaviour.
*
* Note that setting the purpose to Gtk::INPUT_PURPOSE_PASSWORD or
* Gtk::INPUT_PURPOSE_PIN is independent from setting
* Gtk::Entry::property_visibility().
*
* @newin{3,6}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< InputPurpose > property_input_purpose() ;
/** The purpose of this text field.
*
* This property can be used by on-screen keyboards and other input
* methods to adjust their behaviour.
*
* Note that setting the purpose to Gtk::INPUT_PURPOSE_PASSWORD or
* Gtk::INPUT_PURPOSE_PIN is independent from setting
* Gtk::Entry::property_visibility().
*
* @newin{3,6}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< InputPurpose > property_input_purpose() const;
/** Additional hints (beyond Gtk::Entry::property_input_purpose()) that
* allow input methods to fine-tune their behaviour.
*
* @newin{3,6}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< InputHints > property_input_hints() ;
/** Additional hints (beyond Gtk::Entry::property_input_purpose()) that
* allow input methods to fine-tune their behaviour.
*
* @newin{3,6}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< InputHints > property_input_hints() const;
/** A list of Pango attributes to apply to the text of the entry.
*
* This is mainly useful to change the size or weight of the text.
*
* @newin{3,6}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Pango::AttrList > property_attributes() ;
/** A list of Pango attributes to apply to the text of the entry.
*
* This is mainly useful to change the size or weight of the text.
*
* @newin{3,6}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Pango::AttrList > property_attributes() const;
/** If :populate-all is <tt>true</tt>, the Gtk::Entry::signal_populate_popup()
* signal is also emitted for touch popups.
*
* @newin{3,8}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_populate_all() ;
/** If :populate-all is <tt>true</tt>, the Gtk::Entry::signal_populate_popup()
* signal is also emitted for touch popups.
*
* @newin{3,8}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_populate_all() const;
/** A list of tabstop locations to apply to the text of the entry.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Pango::TabArray > property_tabs() ;
/** A list of tabstop locations to apply to the text of the entry.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Pango::TabArray > property_tabs() const;
};
} //namespace Gtk
namespace Glib
{
/** A Glib::wrap() method for this object.
*
* @param object The C instance.
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
* @result A C++ instance that wraps this C instance.
*
* @relates Gtk::Entry
*/
Gtk::Entry* wrap(GtkEntry* object, bool take_copy = false);
} //namespace Glib
#endif /* _GTKMM_ENTRY_H */
|