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
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files.git)
// DO NOT EDIT
use crate::Buildable;
use crate::CellAreaContext;
use crate::CellEditable;
use crate::CellLayout;
use crate::CellRenderer;
use crate::CellRendererState;
use crate::DirectionType;
use crate::Orientation;
use crate::SizeRequestMode;
use crate::Snapshot;
use crate::TreeIter;
use crate::TreeModel;
use crate::TreePath;
use crate::Widget;
use glib::object::Cast;
use glib::object::IsA;
use glib::signal::connect_raw;
use glib::signal::SignalHandlerId;
use glib::translate::*;
use std::boxed::Box as Box_;
use std::fmt;
use std::mem;
use std::mem::transmute;
glib::wrapper! {
/// An abstract class for laying out [`CellRenderer`][crate::CellRenderer]s
///
/// The [`CellArea`][crate::CellArea] is an abstract class for [`CellLayout`][crate::CellLayout]
/// widgets (also referred to as "layouting widgets") to interface with
/// an arbitrary number of [`CellRenderer`][crate::CellRenderer]s and interact with the user
/// for a given [`TreeModel`][crate::TreeModel] row.
///
/// The cell area handles events, focus navigation, drawing and
/// size requests and allocations for a given row of data.
///
/// Usually users dont have to interact with the [`CellArea`][crate::CellArea] directly
/// unless they are implementing a cell-layouting widget themselves.
///
/// # Requesting area sizes
///
/// As outlined in
/// [GtkWidget’s geometry management section](class.Widget.html#height-for-width-geometry-management),
/// GTK uses a height-for-width
/// geometry management system to compute the sizes of widgets and user
/// interfaces. [`CellArea`][crate::CellArea] uses the same semantics to calculate the
/// size of an area for an arbitrary number of [`TreeModel`][crate::TreeModel] rows.
///
/// When requesting the size of a cell area one needs to calculate
/// the size for a handful of rows, and this will be done differently by
/// different layouting widgets. For instance a [`TreeViewColumn`][crate::TreeViewColumn]
/// always lines up the areas from top to bottom while a [`IconView`][crate::IconView]
/// on the other hand might enforce that all areas received the same
/// width and wrap the areas around, requesting height for more cell
/// areas when allocated less width.
///
/// It’s also important for areas to maintain some cell
/// alignments with areas rendered for adjacent rows (cells can
/// appear “columnized” inside an area even when the size of
/// cells are different in each row). For this reason the [`CellArea`][crate::CellArea]
/// uses a [`CellAreaContext`][crate::CellAreaContext] object to store the alignments
/// and sizes along the way (as well as the overall largest minimum
/// and natural size for all the rows which have been calculated
/// with the said context).
///
/// The [`CellAreaContext`][crate::CellAreaContext] is an opaque object specific to the
/// [`CellArea`][crate::CellArea] which created it (see [`CellAreaExt::create_context()`][crate::prelude::CellAreaExt::create_context()]).
///
/// The owning cell-layouting widget can create as many contexts as
/// it wishes to calculate sizes of rows which should receive the
/// same size in at least one orientation (horizontally or vertically),
/// However, it’s important that the same [`CellAreaContext`][crate::CellAreaContext] which
/// was used to request the sizes for a given [`TreeModel`][crate::TreeModel] row be
/// used when rendering or processing events for that row.
///
/// In order to request the width of all the rows at the root level
/// of a [`TreeModel`][crate::TreeModel] one would do the following:
///
/// **⚠️ The following code is in c ⚠️**
///
/// ```c
/// GtkTreeIter iter;
/// int minimum_width;
/// int natural_width;
///
/// valid = gtk_tree_model_get_iter_first (model, &iter);
/// while (valid)
/// {
/// gtk_cell_area_apply_attributes (area, model, &iter, FALSE, FALSE);
/// gtk_cell_area_get_preferred_width (area, context, widget, NULL, NULL);
///
/// valid = gtk_tree_model_iter_next (model, &iter);
/// }
///
/// gtk_cell_area_context_get_preferred_width (context, &minimum_width, &natural_width);
/// ```
///
/// Note that in this example it’s not important to observe the
/// returned minimum and natural width of the area for each row
/// unless the cell-layouting object is actually interested in the
/// widths of individual rows. The overall width is however stored
/// in the accompanying [`CellAreaContext`][crate::CellAreaContext] object and can be consulted
/// at any time.
///
/// This can be useful since [`CellLayout`][crate::CellLayout] widgets usually have to
/// support requesting and rendering rows in treemodels with an
/// exceedingly large amount of rows. The [`CellLayout`][crate::CellLayout] widget in
/// that case would calculate the required width of the rows in an
/// idle or timeout source (see `timeout_add()`) and when the widget
/// is requested its actual width in `vfunc::Gtk::Widget::measure`
/// it can simply consult the width accumulated so far in the
/// [`CellAreaContext`][crate::CellAreaContext] object.
///
/// A simple example where rows are rendered from top to bottom and
/// take up the full width of the layouting widget would look like:
///
/// **⚠️ The following code is in c ⚠️**
///
/// ```c
/// static void
/// foo_get_preferred_width (GtkWidget *widget,
/// int *minimum_size,
/// int *natural_size)
/// {
/// Foo *self = FOO (widget);
/// FooPrivate *priv = foo_get_instance_private (self);
///
/// foo_ensure_at_least_one_handfull_of_rows_have_been_requested (self);
///
/// gtk_cell_area_context_get_preferred_width (priv->context, minimum_size, natural_size);
/// }
/// ```
///
/// In the above example the `Foo` widget has to make sure that some
/// row sizes have been calculated (the amount of rows that `Foo` judged
/// was appropriate to request space for in a single timeout iteration)
/// before simply returning the amount of space required by the area via
/// the [`CellAreaContext`][crate::CellAreaContext].
///
/// Requesting the height for width (or width for height) of an area is
/// a similar task except in this case the [`CellAreaContext`][crate::CellAreaContext] does not
/// store the data (actually, it does not know how much space the layouting
/// widget plans to allocate it for every row. It’s up to the layouting
/// widget to render each row of data with the appropriate height and
/// width which was requested by the [`CellArea`][crate::CellArea]).
///
/// In order to request the height for width of all the rows at the
/// root level of a [`TreeModel`][crate::TreeModel] one would do the following:
///
/// **⚠️ The following code is in c ⚠️**
///
/// ```c
/// GtkTreeIter iter;
/// int minimum_height;
/// int natural_height;
/// int full_minimum_height = 0;
/// int full_natural_height = 0;
///
/// valid = gtk_tree_model_get_iter_first (model, &iter);
/// while (valid)
/// {
/// gtk_cell_area_apply_attributes (area, model, &iter, FALSE, FALSE);
/// gtk_cell_area_get_preferred_height_for_width (area, context, widget,
/// width, &minimum_height, &natural_height);
///
/// if (width_is_for_allocation)
/// cache_row_height (&iter, minimum_height, natural_height);
///
/// full_minimum_height += minimum_height;
/// full_natural_height += natural_height;
///
/// valid = gtk_tree_model_iter_next (model, &iter);
/// }
/// ```
///
/// Note that in the above example we would need to cache the heights
/// returned for each row so that we would know what sizes to render the
/// areas for each row. However we would only want to really cache the
/// heights if the request is intended for the layouting widgets real
/// allocation.
///
/// In some cases the layouting widget is requested the height for an
/// arbitrary for_width, this is a special case for layouting widgets
/// who need to request size for tens of thousands of rows. For this
/// case it’s only important that the layouting widget calculate
/// one reasonably sized chunk of rows and return that height
/// synchronously. The reasoning here is that any layouting widget is
/// at least capable of synchronously calculating enough height to fill
/// the screen height (or scrolled window height) in response to a single
/// call to `vfunc::Gtk::Widget::measure`. Returning
/// a perfect height for width that is larger than the screen area is
/// inconsequential since after the layouting receives an allocation
/// from a scrolled window it simply continues to drive the scrollbar
/// values while more and more height is required for the row heights
/// that are calculated in the background.
///
/// # Rendering Areas
///
/// Once area sizes have been acquired at least for the rows in the
/// visible area of the layouting widget they can be rendered at
/// `vfunc::Gtk::Widget::snapshot` time.
///
/// A crude example of how to render all the rows at the root level
/// runs as follows:
///
/// **⚠️ The following code is in c ⚠️**
///
/// ```c
/// GtkAllocation allocation;
/// GdkRectangle cell_area = { 0, };
/// GtkTreeIter iter;
/// int minimum_width;
/// int natural_width;
///
/// gtk_widget_get_allocation (widget, &allocation);
/// cell_area.width = allocation.width;
///
/// valid = gtk_tree_model_get_iter_first (model, &iter);
/// while (valid)
/// {
/// cell_area.height = get_cached_height_for_row (&iter);
///
/// gtk_cell_area_apply_attributes (area, model, &iter, FALSE, FALSE);
/// gtk_cell_area_render (area, context, widget, cr,
/// &cell_area, &cell_area, state_flags, FALSE);
///
/// cell_area.y += cell_area.height;
///
/// valid = gtk_tree_model_iter_next (model, &iter);
/// }
/// ```
///
/// Note that the cached height in this example really depends on how
/// the layouting widget works. The layouting widget might decide to
/// give every row its minimum or natural height or, if the model content
/// is expected to fit inside the layouting widget without scrolling, it
/// would make sense to calculate the allocation for each row at
/// the time the widget is allocated using `distribute_natural_allocation()`.
///
/// # Handling Events and Driving Keyboard Focus
///
/// Passing events to the area is as simple as handling events on any
/// normal widget and then passing them to the [`CellAreaExtManual::event()`][crate::prelude::CellAreaExtManual::event()]
/// API as they come in. Usually [`CellArea`][crate::CellArea] is only interested in
/// button events, however some customized derived areas can be implemented
/// who are interested in handling other events. Handling an event can
/// trigger the [`signal@Gtk.CellArea::focus-changed`] signal to fire; as well
/// as [`signal@GtkCellArea::add-editable`] in the case that an editable cell
/// was clicked and needs to start editing. You can call
/// [`CellAreaExt::stop_editing()`][crate::prelude::CellAreaExt::stop_editing()] at any time to cancel any cell editing
/// that is currently in progress.
///
/// The [`CellArea`][crate::CellArea] drives keyboard focus from cell to cell in a way
/// similar to [`Widget`][crate::Widget]. For layouting widgets that support giving
/// focus to cells it’s important to remember to pass `GTK_CELL_RENDERER_FOCUSED`
/// to the area functions for the row that has focus and to tell the
/// area to paint the focus at render time.
///
/// Layouting widgets that accept focus on cells should implement the
/// `vfunc::Gtk::Widget::focus` virtual method. The layouting widget is always
/// responsible for knowing where [`TreeModel`][crate::TreeModel] rows are rendered inside
/// the widget, so at `vfunc::Gtk::Widget::focus` time the layouting widget
/// should use the [`CellArea`][crate::CellArea] methods to navigate focus inside the area
/// and then observe the [`DirectionType`][crate::DirectionType] to pass the focus to adjacent
/// rows and areas.
///
/// A basic example of how the `vfunc::Gtk::Widget::focus` virtual method
/// should be implemented:
///
/// ```text
/// static gboolean
/// foo_focus (GtkWidget *widget,
/// GtkDirectionType direction)
/// {
/// Foo *self = FOO (widget);
/// FooPrivate *priv = foo_get_instance_private (self);
/// int focus_row = priv->focus_row;
/// gboolean have_focus = FALSE;
///
/// if (!gtk_widget_has_focus (widget))
/// gtk_widget_grab_focus (widget);
///
/// valid = gtk_tree_model_iter_nth_child (priv->model, &iter, NULL, priv->focus_row);
/// while (valid)
/// {
/// gtk_cell_area_apply_attributes (priv->area, priv->model, &iter, FALSE, FALSE);
///
/// if (gtk_cell_area_focus (priv->area, direction))
/// {
/// priv->focus_row = focus_row;
/// have_focus = TRUE;
/// break;
/// }
/// else
/// {
/// if (direction == GTK_DIR_RIGHT ||
/// direction == GTK_DIR_LEFT)
/// break;
/// else if (direction == GTK_DIR_UP ||
/// direction == GTK_DIR_TAB_BACKWARD)
/// {
/// if (focus_row == 0)
/// break;
/// else
/// {
/// focus_row--;
/// valid = gtk_tree_model_iter_nth_child (priv->model, &iter, NULL, focus_row);
/// }
/// }
/// else
/// {
/// if (focus_row == last_row)
/// break;
/// else
/// {
/// focus_row++;
/// valid = gtk_tree_model_iter_next (priv->model, &iter);
/// }
/// }
/// }
/// }
/// return have_focus;
/// }
/// ```
///
/// Note that the layouting widget is responsible for matching the
/// [`DirectionType`][crate::DirectionType] values to the way it lays out its cells.
///
/// # Cell Properties
///
/// The [`CellArea`][crate::CellArea] introduces cell properties for [`CellRenderer`][crate::CellRenderer]s.
/// This provides some general interfaces for defining the relationship
/// cell areas have with their cells. For instance in a [`CellAreaBox`][crate::CellAreaBox]
/// a cell might “expand” and receive extra space when the area is allocated
/// more than its full natural request, or a cell might be configured to “align”
/// with adjacent rows which were requested and rendered with the same
/// [`CellAreaContext`][crate::CellAreaContext].
///
/// Use `Gtk::CellAreaClass::install_cell_property()` to install cell
/// properties for a cell area class and `Gtk::CellAreaClass::find_cell_property()`
/// or `Gtk::CellAreaClass::list_cell_properties()` to get information about
/// existing cell properties.
///
/// To set the value of a cell property, use [`CellAreaExtManual::cell_set_property()`][crate::prelude::CellAreaExtManual::cell_set_property()],
/// `Gtk::CellArea::cell_set()` or `Gtk::CellArea::cell_set_valist()`. To obtain
/// the value of a cell property, use [`CellAreaExtManual::cell_get_property()`][crate::prelude::CellAreaExtManual::cell_get_property()]
/// `Gtk::CellArea::cell_get()` or `Gtk::CellArea::cell_get_valist()`.
///
/// This is an Abstract Base Class, you cannot instantiate it.
///
/// # Implements
///
/// [`CellAreaExt`][trait@crate::prelude::CellAreaExt], [`trait@glib::ObjectExt`], [`BuildableExt`][trait@crate::prelude::BuildableExt], [`CellLayoutExt`][trait@crate::prelude::CellLayoutExt], [`CellAreaExtManual`][trait@crate::prelude::CellAreaExtManual], [`CellLayoutExtManual`][trait@crate::prelude::CellLayoutExtManual]
#[doc(alias = "GtkCellArea")]
pub struct CellArea(Object<ffi::GtkCellArea, ffi::GtkCellAreaClass>) @implements Buildable, CellLayout;
match fn {
type_ => || ffi::gtk_cell_area_get_type(),
}
}
impl CellArea {
pub const NONE: Option<&'static CellArea> = None;
}
/// Trait containing all [`struct@CellArea`] methods.
///
/// # Implementors
///
/// [`CellAreaBox`][struct@crate::CellAreaBox], [`CellArea`][struct@crate::CellArea]
pub trait CellAreaExt: 'static {
/// Activates @self, usually by activating the currently focused
/// cell, however some subclasses which embed widgets in the area
/// can also activate a widget if it currently has the focus.
/// ## `context`
/// the [`CellArea`][crate::CellArea]Context in context with the current row data
/// ## `widget`
/// the [`Widget`][crate::Widget] that @self is rendering on
/// ## `cell_area`
/// the size and location of @self relative to @widget’s allocation
/// ## `flags`
/// the [`CellRenderer`][crate::CellRenderer]State flags for @self for this row of data.
/// ## `edit_only`
/// if [`true`] then only cell renderers that are [`CellRendererMode::Editable`][crate::CellRendererMode::Editable]
/// will be activated.
///
/// # Returns
///
/// Whether @self was successfully activated.
#[doc(alias = "gtk_cell_area_activate")]
fn activate(
&self,
context: &impl IsA<CellAreaContext>,
widget: &impl IsA<Widget>,
cell_area: &gdk::Rectangle,
flags: CellRendererState,
edit_only: bool,
) -> bool;
/// Adds @renderer to @self with the default child cell properties.
/// ## `renderer`
/// the [`CellRenderer`][crate::CellRenderer] to add to @self
#[doc(alias = "gtk_cell_area_add")]
fn add(&self, renderer: &impl IsA<CellRenderer>);
/// Adds @sibling to @renderer’s focusable area, focus will be drawn
/// around @renderer and all of its siblings if @renderer can
/// focus for a given row.
///
/// Events handled by focus siblings can also activate the given
/// focusable @renderer.
/// ## `renderer`
/// the [`CellRenderer`][crate::CellRenderer] expected to have focus
/// ## `sibling`
/// the [`CellRenderer`][crate::CellRenderer] to add to @renderer’s focus area
#[doc(alias = "gtk_cell_area_add_focus_sibling")]
fn add_focus_sibling(
&self,
renderer: &impl IsA<CellRenderer>,
sibling: &impl IsA<CellRenderer>,
);
/// Applies any connected attributes to the renderers in
/// @self by pulling the values from @tree_model.
/// ## `tree_model`
/// the [`TreeModel`][crate::TreeModel] to pull values from
/// ## `iter`
/// the [`TreeIter`][crate::TreeIter] in @tree_model to apply values for
/// ## `is_expander`
/// whether @iter has children
/// ## `is_expanded`
/// whether @iter is expanded in the view and
/// children are visible
#[doc(alias = "gtk_cell_area_apply_attributes")]
fn apply_attributes(
&self,
tree_model: &impl IsA<TreeModel>,
iter: &TreeIter,
is_expander: bool,
is_expanded: bool,
);
/// Connects an @attribute to apply values from @column for the
/// [`TreeModel`][crate::TreeModel] in use.
/// ## `renderer`
/// the [`CellRenderer`][crate::CellRenderer] to connect an attribute for
/// ## `attribute`
/// the attribute name
/// ## `column`
/// the [`TreeModel`][crate::TreeModel] column to fetch attribute values from
#[doc(alias = "gtk_cell_area_attribute_connect")]
fn attribute_connect(&self, renderer: &impl IsA<CellRenderer>, attribute: &str, column: i32);
/// Disconnects @attribute for the @renderer in @self so that
/// attribute will no longer be updated with values from the
/// model.
/// ## `renderer`
/// the [`CellRenderer`][crate::CellRenderer] to disconnect an attribute for
/// ## `attribute`
/// the attribute name
#[doc(alias = "gtk_cell_area_attribute_disconnect")]
fn attribute_disconnect(&self, renderer: &impl IsA<CellRenderer>, attribute: &str);
/// Returns the model column that an attribute has been mapped to,
/// or -1 if the attribute is not mapped.
/// ## `renderer`
/// a [`CellRenderer`][crate::CellRenderer]
/// ## `attribute`
/// an attribute on the renderer
///
/// # Returns
///
/// the model column, or -1
#[doc(alias = "gtk_cell_area_attribute_get_column")]
fn attribute_get_column(&self, renderer: &impl IsA<CellRenderer>, attribute: &str) -> i32;
/// This is sometimes needed for cases where rows need to share
/// alignments in one orientation but may be separately grouped
/// in the opposing orientation.
///
/// For instance, [`IconView`][crate::IconView] creates all icons (rows) to have
/// the same width and the cells theirin to have the same
/// horizontal alignments. However each row of icons may have
/// a separate collective height. [`IconView`][crate::IconView] uses this to
/// request the heights of each row based on a context which
/// was already used to request all the row widths that are
/// to be displayed.
/// ## `context`
/// the [`CellArea`][crate::CellArea]Context to copy
///
/// # Returns
///
/// a newly created [`CellArea`][crate::CellArea]Context copy of @context.
#[doc(alias = "gtk_cell_area_copy_context")]
fn copy_context(&self, context: &impl IsA<CellAreaContext>) -> CellAreaContext;
/// Creates a [`CellArea`][crate::CellArea]Context to be used with @self for
/// all purposes. [`CellArea`][crate::CellArea]Context stores geometry information
/// for rows for which it was operated on, it is important to use
/// the same context for the same row of data at all times (i.e.
/// one should render and handle events with the same [`CellArea`][crate::CellArea]Context
/// which was used to request the size of those rows of data).
///
/// # Returns
///
/// a newly created [`CellArea`][crate::CellArea]Context which can be used with @self.
#[doc(alias = "gtk_cell_area_create_context")]
fn create_context(&self) -> CellAreaContext;
/// This should be called by the @self’s owning layout widget
/// when focus is to be passed to @self, or moved within @self
/// for a given @direction and row data.
///
/// Implementing [`CellArea`][crate::CellArea] classes should implement this
/// method to receive and navigate focus in its own way particular
/// to how it lays out cells.
/// ## `direction`
/// the [`DirectionType`][crate::DirectionType]
///
/// # Returns
///
/// [`true`] if focus remains inside @self as a result of this call.
#[doc(alias = "gtk_cell_area_focus")]
fn focus(&self, direction: DirectionType) -> bool;
/// Calls @callback for every [`CellRenderer`][crate::CellRenderer] in @self.
/// ## `callback`
/// the `GtkCellCallback` to call
/// ## `callback_data`
/// user provided data pointer
#[doc(alias = "gtk_cell_area_foreach")]
fn foreach<P: FnMut(&CellRenderer) -> bool>(&self, callback: P);
/// Calls @callback for every [`CellRenderer`][crate::CellRenderer] in @self with the
/// allocated rectangle inside @cell_area.
/// ## `context`
/// the [`CellArea`][crate::CellArea]Context for this row of data.
/// ## `widget`
/// the [`Widget`][crate::Widget] that @self is rendering to
/// ## `cell_area`
/// the @widget relative coordinates and size for @self
/// ## `background_area`
/// the @widget relative coordinates of the background area
/// ## `callback`
/// the `GtkCellAllocCallback` to call
/// ## `callback_data`
/// user provided data pointer
#[doc(alias = "gtk_cell_area_foreach_alloc")]
fn foreach_alloc<P: FnMut(&CellRenderer, &gdk::Rectangle, &gdk::Rectangle) -> bool>(
&self,
context: &impl IsA<CellAreaContext>,
widget: &impl IsA<Widget>,
cell_area: &gdk::Rectangle,
background_area: &gdk::Rectangle,
callback: P,
);
/// Derives the allocation of @renderer inside @self if @self
/// were to be renderered in @cell_area.
/// ## `context`
/// the [`CellArea`][crate::CellArea]Context used to hold sizes for @self.
/// ## `widget`
/// the [`Widget`][crate::Widget] that @self is rendering on
/// ## `renderer`
/// the [`CellRenderer`][crate::CellRenderer] to get the allocation for
/// ## `cell_area`
/// the whole allocated area for @self in @widget
/// for this row
///
/// # Returns
///
///
/// ## `allocation`
/// where to store the allocation for @renderer
#[doc(alias = "gtk_cell_area_get_cell_allocation")]
#[doc(alias = "get_cell_allocation")]
fn cell_allocation(
&self,
context: &impl IsA<CellAreaContext>,
widget: &impl IsA<Widget>,
renderer: &impl IsA<CellRenderer>,
cell_area: &gdk::Rectangle,
) -> gdk::Rectangle;
/// Gets the [`CellRenderer`][crate::CellRenderer] at @x and @y coordinates inside @self and optionally
/// returns the full cell allocation for it inside @cell_area.
/// ## `context`
/// the [`CellArea`][crate::CellArea]Context used to hold sizes for @self.
/// ## `widget`
/// the [`Widget`][crate::Widget] that @self is rendering on
/// ## `cell_area`
/// the whole allocated area for @self in @widget
/// for this row
/// ## `x`
/// the x position
/// ## `y`
/// the y position
///
/// # Returns
///
/// the [`CellRenderer`][crate::CellRenderer] at @x and @y.
///
/// ## `alloc_area`
/// where to store the inner allocated area of the
/// returned cell renderer
#[doc(alias = "gtk_cell_area_get_cell_at_position")]
#[doc(alias = "get_cell_at_position")]
fn cell_at_position(
&self,
context: &impl IsA<CellAreaContext>,
widget: &impl IsA<Widget>,
cell_area: &gdk::Rectangle,
x: i32,
y: i32,
) -> (CellRenderer, gdk::Rectangle);
/// Gets the current [`TreePath`][crate::TreePath] string for the currently
/// applied [`TreeIter`][crate::TreeIter], this is implicitly updated when
/// gtk_cell_area_apply_attributes() is called and can be
/// used to interact with renderers from [`CellArea`][crate::CellArea]
/// subclasses.
///
/// # Returns
///
/// The current [`TreePath`][crate::TreePath] string for the current
/// attributes applied to @self. This string belongs to the area and
/// should not be freed.
#[doc(alias = "gtk_cell_area_get_current_path_string")]
#[doc(alias = "get_current_path_string")]
fn current_path_string(&self) -> glib::GString;
/// Gets the [`CellEditable`][crate::CellEditable] widget currently used
/// to edit the currently edited cell.
///
/// # Returns
///
/// The currently active [`CellEditable`][crate::CellEditable] widget
#[doc(alias = "gtk_cell_area_get_edit_widget")]
#[doc(alias = "get_edit_widget")]
fn edit_widget(&self) -> Option<CellEditable>;
/// Gets the [`CellRenderer`][crate::CellRenderer] in @self that is currently
/// being edited.
///
/// # Returns
///
/// The currently edited [`CellRenderer`][crate::CellRenderer]
#[doc(alias = "gtk_cell_area_get_edited_cell")]
#[doc(alias = "get_edited_cell")]
fn edited_cell(&self) -> Option<CellRenderer>;
/// Retrieves the currently focused cell for @self
///
/// # Returns
///
/// the currently focused cell in @self.
#[doc(alias = "gtk_cell_area_get_focus_cell")]
#[doc(alias = "get_focus_cell")]
fn focus_cell(&self) -> Option<CellRenderer>;
/// Gets the [`CellRenderer`][crate::CellRenderer] which is expected to be focusable
/// for which @renderer is, or may be a sibling.
///
/// This is handy for [`CellArea`][crate::CellArea] subclasses when handling events,
/// after determining the renderer at the event location it can
/// then chose to activate the focus cell for which the event
/// cell may have been a sibling.
/// ## `renderer`
/// the [`CellRenderer`][crate::CellRenderer]
///
/// # Returns
///
/// the [`CellRenderer`][crate::CellRenderer]
/// for which @renderer is a sibling
#[doc(alias = "gtk_cell_area_get_focus_from_sibling")]
#[doc(alias = "get_focus_from_sibling")]
fn focus_from_sibling(&self, renderer: &impl IsA<CellRenderer>) -> Option<CellRenderer>;
/// Gets the focus sibling cell renderers for @renderer.
/// ## `renderer`
/// the [`CellRenderer`][crate::CellRenderer] expected to have focus
///
/// # Returns
///
/// A `GList` of [`CellRenderer`][crate::CellRenderer]s.
/// The returned list is internal and should not be freed.
#[doc(alias = "gtk_cell_area_get_focus_siblings")]
#[doc(alias = "get_focus_siblings")]
fn focus_siblings(&self, renderer: &impl IsA<CellRenderer>) -> Vec<CellRenderer>;
/// Retrieves a cell area’s initial minimum and natural height.
///
/// @self will store some geometrical information in @context along the way;
/// when requesting sizes over an arbitrary number of rows, it’s not important
/// to check the @minimum_height and @natural_height of this call but rather to
/// consult gtk_cell_area_context_get_preferred_height() after a series of
/// requests.
/// ## `context`
/// the [`CellArea`][crate::CellArea]Context to perform this request with
/// ## `widget`
/// the [`Widget`][crate::Widget] where @self will be rendering
///
/// # Returns
///
///
/// ## `minimum_height`
/// location to store the minimum height
///
/// ## `natural_height`
/// location to store the natural height
#[doc(alias = "gtk_cell_area_get_preferred_height")]
#[doc(alias = "get_preferred_height")]
fn preferred_height(
&self,
context: &impl IsA<CellAreaContext>,
widget: &impl IsA<Widget>,
) -> (i32, i32);
/// Retrieves a cell area’s minimum and natural height if it would be given
/// the specified @width.
///
/// @self stores some geometrical information in @context along the way
/// while calling gtk_cell_area_get_preferred_width(). It’s important to
/// perform a series of gtk_cell_area_get_preferred_width() requests with
/// @context first and then call gtk_cell_area_get_preferred_height_for_width()
/// on each cell area individually to get the height for width of each
/// fully requested row.
///
/// If at some point, the width of a single row changes, it should be
/// requested with gtk_cell_area_get_preferred_width() again and then
/// the full width of the requested rows checked again with
/// gtk_cell_area_context_get_preferred_width().
/// ## `context`
/// the [`CellArea`][crate::CellArea]Context which has already been requested for widths.
/// ## `widget`
/// the [`Widget`][crate::Widget] where @self will be rendering
/// ## `width`
/// the width for which to check the height of this area
///
/// # Returns
///
///
/// ## `minimum_height`
/// location to store the minimum height
///
/// ## `natural_height`
/// location to store the natural height
#[doc(alias = "gtk_cell_area_get_preferred_height_for_width")]
#[doc(alias = "get_preferred_height_for_width")]
fn preferred_height_for_width(
&self,
context: &impl IsA<CellAreaContext>,
widget: &impl IsA<Widget>,
width: i32,
) -> (i32, i32);
/// Retrieves a cell area’s initial minimum and natural width.
///
/// @self will store some geometrical information in @context along the way;
/// when requesting sizes over an arbitrary number of rows, it’s not important
/// to check the @minimum_width and @natural_width of this call but rather to
/// consult gtk_cell_area_context_get_preferred_width() after a series of
/// requests.
/// ## `context`
/// the [`CellArea`][crate::CellArea]Context to perform this request with
/// ## `widget`
/// the [`Widget`][crate::Widget] where @self will be rendering
///
/// # Returns
///
///
/// ## `minimum_width`
/// location to store the minimum width
///
/// ## `natural_width`
/// location to store the natural width
#[doc(alias = "gtk_cell_area_get_preferred_width")]
#[doc(alias = "get_preferred_width")]
fn preferred_width(
&self,
context: &impl IsA<CellAreaContext>,
widget: &impl IsA<Widget>,
) -> (i32, i32);
/// Retrieves a cell area’s minimum and natural width if it would be given
/// the specified @height.
///
/// @self stores some geometrical information in @context along the way
/// while calling gtk_cell_area_get_preferred_height(). It’s important to
/// perform a series of gtk_cell_area_get_preferred_height() requests with
/// @context first and then call gtk_cell_area_get_preferred_width_for_height()
/// on each cell area individually to get the height for width of each
/// fully requested row.
///
/// If at some point, the height of a single row changes, it should be
/// requested with gtk_cell_area_get_preferred_height() again and then
/// the full height of the requested rows checked again with
/// gtk_cell_area_context_get_preferred_height().
/// ## `context`
/// the [`CellArea`][crate::CellArea]Context which has already been requested for widths.
/// ## `widget`
/// the [`Widget`][crate::Widget] where @self will be rendering
/// ## `height`
/// the height for which to check the width of this area
///
/// # Returns
///
///
/// ## `minimum_width`
/// location to store the minimum width
///
/// ## `natural_width`
/// location to store the natural width
#[doc(alias = "gtk_cell_area_get_preferred_width_for_height")]
#[doc(alias = "get_preferred_width_for_height")]
fn preferred_width_for_height(
&self,
context: &impl IsA<CellAreaContext>,
widget: &impl IsA<Widget>,
height: i32,
) -> (i32, i32);
/// Gets whether the area prefers a height-for-width layout
/// or a width-for-height layout.
///
/// # Returns
///
/// The [`SizeRequestMode`][crate::SizeRequestMode] preferred by @self.
#[doc(alias = "gtk_cell_area_get_request_mode")]
#[doc(alias = "get_request_mode")]
fn request_mode(&self) -> SizeRequestMode;
/// Checks if @self contains @renderer.
/// ## `renderer`
/// the [`CellRenderer`][crate::CellRenderer] to check
///
/// # Returns
///
/// [`true`] if @renderer is in the @self.
#[doc(alias = "gtk_cell_area_has_renderer")]
fn has_renderer(&self, renderer: &impl IsA<CellRenderer>) -> bool;
/// This is a convenience function for [`CellArea`][crate::CellArea] implementations
/// to get the inner area where a given [`CellRenderer`][crate::CellRenderer] will be
/// rendered. It removes any padding previously added by gtk_cell_area_request_renderer().
/// ## `widget`
/// the [`Widget`][crate::Widget] that @self is rendering onto
/// ## `cell_area`
/// the @widget relative coordinates where one of @self’s cells
/// is to be placed
///
/// # Returns
///
///
/// ## `inner_area`
/// the return location for the inner cell area
#[doc(alias = "gtk_cell_area_inner_cell_area")]
fn inner_cell_area(
&self,
widget: &impl IsA<Widget>,
cell_area: &gdk::Rectangle,
) -> gdk::Rectangle;
/// Returns whether the area can do anything when activated,
/// after applying new attributes to @self.
///
/// # Returns
///
/// whether @self can do anything when activated.
#[doc(alias = "gtk_cell_area_is_activatable")]
fn is_activatable(&self) -> bool;
/// Returns whether @sibling is one of @renderer’s focus siblings
/// (see gtk_cell_area_add_focus_sibling()).
/// ## `renderer`
/// the [`CellRenderer`][crate::CellRenderer] expected to have focus
/// ## `sibling`
/// the [`CellRenderer`][crate::CellRenderer] to check against @renderer’s sibling list
///
/// # Returns
///
/// [`true`] if @sibling is a focus sibling of @renderer
#[doc(alias = "gtk_cell_area_is_focus_sibling")]
fn is_focus_sibling(
&self,
renderer: &impl IsA<CellRenderer>,
sibling: &impl IsA<CellRenderer>,
) -> bool;
/// Removes @renderer from @self.
/// ## `renderer`
/// the [`CellRenderer`][crate::CellRenderer] to remove from @self
#[doc(alias = "gtk_cell_area_remove")]
fn remove(&self, renderer: &impl IsA<CellRenderer>);
/// Removes @sibling from @renderer’s focus sibling list
/// (see gtk_cell_area_add_focus_sibling()).
/// ## `renderer`
/// the [`CellRenderer`][crate::CellRenderer] expected to have focus
/// ## `sibling`
/// the [`CellRenderer`][crate::CellRenderer] to remove from @renderer’s focus area
#[doc(alias = "gtk_cell_area_remove_focus_sibling")]
fn remove_focus_sibling(
&self,
renderer: &impl IsA<CellRenderer>,
sibling: &impl IsA<CellRenderer>,
);
/// This is a convenience function for [`CellArea`][crate::CellArea] implementations
/// to request size for cell renderers. It’s important to use this
/// function to request size and then use gtk_cell_area_inner_cell_area()
/// at render and event time since this function will add padding
/// around the cell for focus painting.
/// ## `renderer`
/// the [`CellRenderer`][crate::CellRenderer] to request size for
/// ## `orientation`
/// the [`Orientation`][crate::Orientation] in which to request size
/// ## `widget`
/// the [`Widget`][crate::Widget] that @self is rendering onto
/// ## `for_size`
/// the allocation contextual size to request for, or -1 if
/// the base request for the orientation is to be returned.
///
/// # Returns
///
///
/// ## `minimum_size`
/// location to store the minimum size
///
/// ## `natural_size`
/// location to store the natural size
#[doc(alias = "gtk_cell_area_request_renderer")]
fn request_renderer(
&self,
renderer: &impl IsA<CellRenderer>,
orientation: Orientation,
widget: &impl IsA<Widget>,
for_size: i32,
) -> (i32, i32);
/// Explicitly sets the currently focused cell to @renderer.
///
/// This is generally called by implementations of
/// `GtkCellAreaClass.focus()` or `GtkCellAreaClass.event()`,
/// however it can also be used to implement functions such
/// as gtk_tree_view_set_cursor_on_cell().
/// ## `renderer`
/// the [`CellRenderer`][crate::CellRenderer] to give focus to
#[doc(alias = "gtk_cell_area_set_focus_cell")]
fn set_focus_cell(&self, renderer: Option<&impl IsA<CellRenderer>>);
/// Snapshots @self’s cells according to @self’s layout onto at
/// the given coordinates.
/// ## `context`
/// the [`CellArea`][crate::CellArea]Context for this row of data.
/// ## `widget`
/// the [`Widget`][crate::Widget] that @self is rendering to
/// ## `snapshot`
/// the [`Snapshot`][crate::Snapshot] to draw to
/// ## `background_area`
/// the @widget relative coordinates for @self’s background
/// ## `cell_area`
/// the @widget relative coordinates for @self
/// ## `flags`
/// the [`CellRenderer`][crate::CellRenderer]State for @self in this row.
/// ## `paint_focus`
/// whether @self should paint focus on focused cells for focused rows or not.
#[doc(alias = "gtk_cell_area_snapshot")]
fn snapshot(
&self,
context: &impl IsA<CellAreaContext>,
widget: &impl IsA<Widget>,
snapshot: &Snapshot,
background_area: &gdk::Rectangle,
cell_area: &gdk::Rectangle,
flags: CellRendererState,
paint_focus: bool,
);
/// Explicitly stops the editing of the currently edited cell.
///
/// If @canceled is [`true`], the currently edited cell renderer
/// will emit the ::editing-canceled signal, otherwise the
/// the ::editing-done signal will be emitted on the current
/// edit widget.
///
/// See gtk_cell_area_get_edited_cell() and gtk_cell_area_get_edit_widget().
/// ## `canceled`
/// whether editing was canceled.
#[doc(alias = "gtk_cell_area_stop_editing")]
fn stop_editing(&self, canceled: bool);
/// Indicates that editing has started on @renderer and that @editable
/// should be added to the owning cell-layouting widget at @cell_area.
/// ## `renderer`
/// the [`CellRenderer`][crate::CellRenderer] that started the edited
/// ## `editable`
/// the [`CellEditable`][crate::CellEditable] widget to add
/// ## `cell_area`
/// the [`Widget`][crate::Widget] relative [`gdk::Rectangle`][crate::gdk::Rectangle] coordinates
/// where @editable should be added
/// ## `path`
/// the [`TreePath`][crate::TreePath] string this edit was initiated for
#[doc(alias = "add-editable")]
fn connect_add_editable<
F: Fn(&Self, &CellRenderer, &CellEditable, &gdk::Rectangle, TreePath) + 'static,
>(
&self,
f: F,
) -> SignalHandlerId;
/// This signal is emitted whenever applying attributes to @area from @model
/// ## `model`
/// the [`TreeModel`][crate::TreeModel] to apply the attributes from
/// ## `iter`
/// the [`TreeIter`][crate::TreeIter] indicating which row to apply the attributes of
/// ## `is_expander`
/// whether the view shows children for this row
/// ## `is_expanded`
/// whether the view is currently showing the children of this row
#[doc(alias = "apply-attributes")]
fn connect_apply_attributes<F: Fn(&Self, &TreeModel, &TreeIter, bool, bool) + 'static>(
&self,
f: F,
) -> SignalHandlerId;
/// Indicates that focus changed on this @area. This signal
/// is emitted either as a result of focus handling or event
/// handling.
///
/// It's possible that the signal is emitted even if the
/// currently focused renderer did not change, this is
/// because focus may change to the same renderer in the
/// same cell area for a different row of data.
/// ## `renderer`
/// the [`CellRenderer`][crate::CellRenderer] that has focus
/// ## `path`
/// the current [`TreePath`][crate::TreePath] string set for @area
#[doc(alias = "focus-changed")]
fn connect_focus_changed<F: Fn(&Self, &CellRenderer, TreePath) + 'static>(
&self,
f: F,
) -> SignalHandlerId;
/// Indicates that editing finished on @renderer and that @editable
/// should be removed from the owning cell-layouting widget.
/// ## `renderer`
/// the [`CellRenderer`][crate::CellRenderer] that finished editeding
/// ## `editable`
/// the [`CellEditable`][crate::CellEditable] widget to remove
#[doc(alias = "remove-editable")]
fn connect_remove_editable<F: Fn(&Self, &CellRenderer, &CellEditable) + 'static>(
&self,
f: F,
) -> SignalHandlerId;
#[doc(alias = "edit-widget")]
fn connect_edit_widget_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId;
#[doc(alias = "edited-cell")]
fn connect_edited_cell_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId;
#[doc(alias = "focus-cell")]
fn connect_focus_cell_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId;
}
impl<O: IsA<CellArea>> CellAreaExt for O {
fn activate(
&self,
context: &impl IsA<CellAreaContext>,
widget: &impl IsA<Widget>,
cell_area: &gdk::Rectangle,
flags: CellRendererState,
edit_only: bool,
) -> bool {
unsafe {
from_glib(ffi::gtk_cell_area_activate(
self.as_ref().to_glib_none().0,
context.as_ref().to_glib_none().0,
widget.as_ref().to_glib_none().0,
cell_area.to_glib_none().0,
flags.into_glib(),
edit_only.into_glib(),
))
}
}
fn add(&self, renderer: &impl IsA<CellRenderer>) {
unsafe {
ffi::gtk_cell_area_add(
self.as_ref().to_glib_none().0,
renderer.as_ref().to_glib_none().0,
);
}
}
fn add_focus_sibling(
&self,
renderer: &impl IsA<CellRenderer>,
sibling: &impl IsA<CellRenderer>,
) {
unsafe {
ffi::gtk_cell_area_add_focus_sibling(
self.as_ref().to_glib_none().0,
renderer.as_ref().to_glib_none().0,
sibling.as_ref().to_glib_none().0,
);
}
}
fn apply_attributes(
&self,
tree_model: &impl IsA<TreeModel>,
iter: &TreeIter,
is_expander: bool,
is_expanded: bool,
) {
unsafe {
ffi::gtk_cell_area_apply_attributes(
self.as_ref().to_glib_none().0,
tree_model.as_ref().to_glib_none().0,
mut_override(iter.to_glib_none().0),
is_expander.into_glib(),
is_expanded.into_glib(),
);
}
}
fn attribute_connect(&self, renderer: &impl IsA<CellRenderer>, attribute: &str, column: i32) {
unsafe {
ffi::gtk_cell_area_attribute_connect(
self.as_ref().to_glib_none().0,
renderer.as_ref().to_glib_none().0,
attribute.to_glib_none().0,
column,
);
}
}
fn attribute_disconnect(&self, renderer: &impl IsA<CellRenderer>, attribute: &str) {
unsafe {
ffi::gtk_cell_area_attribute_disconnect(
self.as_ref().to_glib_none().0,
renderer.as_ref().to_glib_none().0,
attribute.to_glib_none().0,
);
}
}
fn attribute_get_column(&self, renderer: &impl IsA<CellRenderer>, attribute: &str) -> i32 {
unsafe {
ffi::gtk_cell_area_attribute_get_column(
self.as_ref().to_glib_none().0,
renderer.as_ref().to_glib_none().0,
attribute.to_glib_none().0,
)
}
}
fn copy_context(&self, context: &impl IsA<CellAreaContext>) -> CellAreaContext {
unsafe {
from_glib_full(ffi::gtk_cell_area_copy_context(
self.as_ref().to_glib_none().0,
context.as_ref().to_glib_none().0,
))
}
}
fn create_context(&self) -> CellAreaContext {
unsafe {
from_glib_full(ffi::gtk_cell_area_create_context(
self.as_ref().to_glib_none().0,
))
}
}
fn focus(&self, direction: DirectionType) -> bool {
unsafe {
from_glib(ffi::gtk_cell_area_focus(
self.as_ref().to_glib_none().0,
direction.into_glib(),
))
}
}
fn foreach<P: FnMut(&CellRenderer) -> bool>(&self, callback: P) {
let callback_data: P = callback;
unsafe extern "C" fn callback_func<P: FnMut(&CellRenderer) -> bool>(
renderer: *mut ffi::GtkCellRenderer,
data: glib::ffi::gpointer,
) -> glib::ffi::gboolean {
let renderer = from_glib_borrow(renderer);
let callback: *mut P = data as *const _ as usize as *mut P;
let res = (*callback)(&renderer);
res.into_glib()
}
let callback = Some(callback_func::<P> as _);
let super_callback0: &P = &callback_data;
unsafe {
ffi::gtk_cell_area_foreach(
self.as_ref().to_glib_none().0,
callback,
super_callback0 as *const _ as usize as *mut _,
);
}
}
fn foreach_alloc<P: FnMut(&CellRenderer, &gdk::Rectangle, &gdk::Rectangle) -> bool>(
&self,
context: &impl IsA<CellAreaContext>,
widget: &impl IsA<Widget>,
cell_area: &gdk::Rectangle,
background_area: &gdk::Rectangle,
callback: P,
) {
let callback_data: P = callback;
unsafe extern "C" fn callback_func<
P: FnMut(&CellRenderer, &gdk::Rectangle, &gdk::Rectangle) -> bool,
>(
renderer: *mut ffi::GtkCellRenderer,
cell_area: *const gdk::ffi::GdkRectangle,
cell_background: *const gdk::ffi::GdkRectangle,
data: glib::ffi::gpointer,
) -> glib::ffi::gboolean {
let renderer = from_glib_borrow(renderer);
let cell_area = from_glib_borrow(cell_area);
let cell_background = from_glib_borrow(cell_background);
let callback: *mut P = data as *const _ as usize as *mut P;
let res = (*callback)(&renderer, &cell_area, &cell_background);
res.into_glib()
}
let callback = Some(callback_func::<P> as _);
let super_callback0: &P = &callback_data;
unsafe {
ffi::gtk_cell_area_foreach_alloc(
self.as_ref().to_glib_none().0,
context.as_ref().to_glib_none().0,
widget.as_ref().to_glib_none().0,
cell_area.to_glib_none().0,
background_area.to_glib_none().0,
callback,
super_callback0 as *const _ as usize as *mut _,
);
}
}
fn cell_allocation(
&self,
context: &impl IsA<CellAreaContext>,
widget: &impl IsA<Widget>,
renderer: &impl IsA<CellRenderer>,
cell_area: &gdk::Rectangle,
) -> gdk::Rectangle {
unsafe {
let mut allocation = gdk::Rectangle::uninitialized();
ffi::gtk_cell_area_get_cell_allocation(
self.as_ref().to_glib_none().0,
context.as_ref().to_glib_none().0,
widget.as_ref().to_glib_none().0,
renderer.as_ref().to_glib_none().0,
cell_area.to_glib_none().0,
allocation.to_glib_none_mut().0,
);
allocation
}
}
fn cell_at_position(
&self,
context: &impl IsA<CellAreaContext>,
widget: &impl IsA<Widget>,
cell_area: &gdk::Rectangle,
x: i32,
y: i32,
) -> (CellRenderer, gdk::Rectangle) {
unsafe {
let mut alloc_area = gdk::Rectangle::uninitialized();
let ret = from_glib_none(ffi::gtk_cell_area_get_cell_at_position(
self.as_ref().to_glib_none().0,
context.as_ref().to_glib_none().0,
widget.as_ref().to_glib_none().0,
cell_area.to_glib_none().0,
x,
y,
alloc_area.to_glib_none_mut().0,
));
(ret, alloc_area)
}
}
fn current_path_string(&self) -> glib::GString {
unsafe {
from_glib_none(ffi::gtk_cell_area_get_current_path_string(
self.as_ref().to_glib_none().0,
))
}
}
fn edit_widget(&self) -> Option<CellEditable> {
unsafe {
from_glib_none(ffi::gtk_cell_area_get_edit_widget(
self.as_ref().to_glib_none().0,
))
}
}
fn edited_cell(&self) -> Option<CellRenderer> {
unsafe {
from_glib_none(ffi::gtk_cell_area_get_edited_cell(
self.as_ref().to_glib_none().0,
))
}
}
fn focus_cell(&self) -> Option<CellRenderer> {
unsafe {
from_glib_none(ffi::gtk_cell_area_get_focus_cell(
self.as_ref().to_glib_none().0,
))
}
}
fn focus_from_sibling(&self, renderer: &impl IsA<CellRenderer>) -> Option<CellRenderer> {
unsafe {
from_glib_none(ffi::gtk_cell_area_get_focus_from_sibling(
self.as_ref().to_glib_none().0,
renderer.as_ref().to_glib_none().0,
))
}
}
fn focus_siblings(&self, renderer: &impl IsA<CellRenderer>) -> Vec<CellRenderer> {
unsafe {
FromGlibPtrContainer::from_glib_none(ffi::gtk_cell_area_get_focus_siblings(
self.as_ref().to_glib_none().0,
renderer.as_ref().to_glib_none().0,
))
}
}
fn preferred_height(
&self,
context: &impl IsA<CellAreaContext>,
widget: &impl IsA<Widget>,
) -> (i32, i32) {
unsafe {
let mut minimum_height = mem::MaybeUninit::uninit();
let mut natural_height = mem::MaybeUninit::uninit();
ffi::gtk_cell_area_get_preferred_height(
self.as_ref().to_glib_none().0,
context.as_ref().to_glib_none().0,
widget.as_ref().to_glib_none().0,
minimum_height.as_mut_ptr(),
natural_height.as_mut_ptr(),
);
(minimum_height.assume_init(), natural_height.assume_init())
}
}
fn preferred_height_for_width(
&self,
context: &impl IsA<CellAreaContext>,
widget: &impl IsA<Widget>,
width: i32,
) -> (i32, i32) {
unsafe {
let mut minimum_height = mem::MaybeUninit::uninit();
let mut natural_height = mem::MaybeUninit::uninit();
ffi::gtk_cell_area_get_preferred_height_for_width(
self.as_ref().to_glib_none().0,
context.as_ref().to_glib_none().0,
widget.as_ref().to_glib_none().0,
width,
minimum_height.as_mut_ptr(),
natural_height.as_mut_ptr(),
);
(minimum_height.assume_init(), natural_height.assume_init())
}
}
fn preferred_width(
&self,
context: &impl IsA<CellAreaContext>,
widget: &impl IsA<Widget>,
) -> (i32, i32) {
unsafe {
let mut minimum_width = mem::MaybeUninit::uninit();
let mut natural_width = mem::MaybeUninit::uninit();
ffi::gtk_cell_area_get_preferred_width(
self.as_ref().to_glib_none().0,
context.as_ref().to_glib_none().0,
widget.as_ref().to_glib_none().0,
minimum_width.as_mut_ptr(),
natural_width.as_mut_ptr(),
);
(minimum_width.assume_init(), natural_width.assume_init())
}
}
fn preferred_width_for_height(
&self,
context: &impl IsA<CellAreaContext>,
widget: &impl IsA<Widget>,
height: i32,
) -> (i32, i32) {
unsafe {
let mut minimum_width = mem::MaybeUninit::uninit();
let mut natural_width = mem::MaybeUninit::uninit();
ffi::gtk_cell_area_get_preferred_width_for_height(
self.as_ref().to_glib_none().0,
context.as_ref().to_glib_none().0,
widget.as_ref().to_glib_none().0,
height,
minimum_width.as_mut_ptr(),
natural_width.as_mut_ptr(),
);
(minimum_width.assume_init(), natural_width.assume_init())
}
}
fn request_mode(&self) -> SizeRequestMode {
unsafe {
from_glib(ffi::gtk_cell_area_get_request_mode(
self.as_ref().to_glib_none().0,
))
}
}
fn has_renderer(&self, renderer: &impl IsA<CellRenderer>) -> bool {
unsafe {
from_glib(ffi::gtk_cell_area_has_renderer(
self.as_ref().to_glib_none().0,
renderer.as_ref().to_glib_none().0,
))
}
}
fn inner_cell_area(
&self,
widget: &impl IsA<Widget>,
cell_area: &gdk::Rectangle,
) -> gdk::Rectangle {
unsafe {
let mut inner_area = gdk::Rectangle::uninitialized();
ffi::gtk_cell_area_inner_cell_area(
self.as_ref().to_glib_none().0,
widget.as_ref().to_glib_none().0,
cell_area.to_glib_none().0,
inner_area.to_glib_none_mut().0,
);
inner_area
}
}
fn is_activatable(&self) -> bool {
unsafe {
from_glib(ffi::gtk_cell_area_is_activatable(
self.as_ref().to_glib_none().0,
))
}
}
fn is_focus_sibling(
&self,
renderer: &impl IsA<CellRenderer>,
sibling: &impl IsA<CellRenderer>,
) -> bool {
unsafe {
from_glib(ffi::gtk_cell_area_is_focus_sibling(
self.as_ref().to_glib_none().0,
renderer.as_ref().to_glib_none().0,
sibling.as_ref().to_glib_none().0,
))
}
}
fn remove(&self, renderer: &impl IsA<CellRenderer>) {
unsafe {
ffi::gtk_cell_area_remove(
self.as_ref().to_glib_none().0,
renderer.as_ref().to_glib_none().0,
);
}
}
fn remove_focus_sibling(
&self,
renderer: &impl IsA<CellRenderer>,
sibling: &impl IsA<CellRenderer>,
) {
unsafe {
ffi::gtk_cell_area_remove_focus_sibling(
self.as_ref().to_glib_none().0,
renderer.as_ref().to_glib_none().0,
sibling.as_ref().to_glib_none().0,
);
}
}
fn request_renderer(
&self,
renderer: &impl IsA<CellRenderer>,
orientation: Orientation,
widget: &impl IsA<Widget>,
for_size: i32,
) -> (i32, i32) {
unsafe {
let mut minimum_size = mem::MaybeUninit::uninit();
let mut natural_size = mem::MaybeUninit::uninit();
ffi::gtk_cell_area_request_renderer(
self.as_ref().to_glib_none().0,
renderer.as_ref().to_glib_none().0,
orientation.into_glib(),
widget.as_ref().to_glib_none().0,
for_size,
minimum_size.as_mut_ptr(),
natural_size.as_mut_ptr(),
);
(minimum_size.assume_init(), natural_size.assume_init())
}
}
fn set_focus_cell(&self, renderer: Option<&impl IsA<CellRenderer>>) {
unsafe {
ffi::gtk_cell_area_set_focus_cell(
self.as_ref().to_glib_none().0,
renderer.map(|p| p.as_ref()).to_glib_none().0,
);
}
}
fn snapshot(
&self,
context: &impl IsA<CellAreaContext>,
widget: &impl IsA<Widget>,
snapshot: &Snapshot,
background_area: &gdk::Rectangle,
cell_area: &gdk::Rectangle,
flags: CellRendererState,
paint_focus: bool,
) {
unsafe {
ffi::gtk_cell_area_snapshot(
self.as_ref().to_glib_none().0,
context.as_ref().to_glib_none().0,
widget.as_ref().to_glib_none().0,
snapshot.to_glib_none().0,
background_area.to_glib_none().0,
cell_area.to_glib_none().0,
flags.into_glib(),
paint_focus.into_glib(),
);
}
}
fn stop_editing(&self, canceled: bool) {
unsafe {
ffi::gtk_cell_area_stop_editing(self.as_ref().to_glib_none().0, canceled.into_glib());
}
}
fn connect_add_editable<
F: Fn(&Self, &CellRenderer, &CellEditable, &gdk::Rectangle, TreePath) + 'static,
>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn add_editable_trampoline<
P: IsA<CellArea>,
F: Fn(&P, &CellRenderer, &CellEditable, &gdk::Rectangle, TreePath) + 'static,
>(
this: *mut ffi::GtkCellArea,
renderer: *mut ffi::GtkCellRenderer,
editable: *mut ffi::GtkCellEditable,
cell_area: *mut gdk::ffi::GdkRectangle,
path: *mut libc::c_char,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
let path = from_glib_full(crate::ffi::gtk_tree_path_new_from_string(path));
f(
CellArea::from_glib_borrow(this).unsafe_cast_ref(),
&from_glib_borrow(renderer),
&from_glib_borrow(editable),
&from_glib_borrow(cell_area),
path,
)
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"add-editable\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
add_editable_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
fn connect_apply_attributes<F: Fn(&Self, &TreeModel, &TreeIter, bool, bool) + 'static>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn apply_attributes_trampoline<
P: IsA<CellArea>,
F: Fn(&P, &TreeModel, &TreeIter, bool, bool) + 'static,
>(
this: *mut ffi::GtkCellArea,
model: *mut ffi::GtkTreeModel,
iter: *mut ffi::GtkTreeIter,
is_expander: glib::ffi::gboolean,
is_expanded: glib::ffi::gboolean,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(
CellArea::from_glib_borrow(this).unsafe_cast_ref(),
&from_glib_borrow(model),
&from_glib_borrow(iter),
from_glib(is_expander),
from_glib(is_expanded),
)
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"apply-attributes\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
apply_attributes_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
fn connect_focus_changed<F: Fn(&Self, &CellRenderer, TreePath) + 'static>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn focus_changed_trampoline<
P: IsA<CellArea>,
F: Fn(&P, &CellRenderer, TreePath) + 'static,
>(
this: *mut ffi::GtkCellArea,
renderer: *mut ffi::GtkCellRenderer,
path: *mut libc::c_char,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
let path = from_glib_full(crate::ffi::gtk_tree_path_new_from_string(path));
f(
CellArea::from_glib_borrow(this).unsafe_cast_ref(),
&from_glib_borrow(renderer),
path,
)
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"focus-changed\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
focus_changed_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
fn connect_remove_editable<F: Fn(&Self, &CellRenderer, &CellEditable) + 'static>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn remove_editable_trampoline<
P: IsA<CellArea>,
F: Fn(&P, &CellRenderer, &CellEditable) + 'static,
>(
this: *mut ffi::GtkCellArea,
renderer: *mut ffi::GtkCellRenderer,
editable: *mut ffi::GtkCellEditable,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(
CellArea::from_glib_borrow(this).unsafe_cast_ref(),
&from_glib_borrow(renderer),
&from_glib_borrow(editable),
)
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"remove-editable\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
remove_editable_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
fn connect_edit_widget_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_edit_widget_trampoline<
P: IsA<CellArea>,
F: Fn(&P) + 'static,
>(
this: *mut ffi::GtkCellArea,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(CellArea::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::edit-widget\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_edit_widget_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
fn connect_edited_cell_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_edited_cell_trampoline<
P: IsA<CellArea>,
F: Fn(&P) + 'static,
>(
this: *mut ffi::GtkCellArea,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(CellArea::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::edited-cell\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_edited_cell_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
fn connect_focus_cell_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_focus_cell_trampoline<P: IsA<CellArea>, F: Fn(&P) + 'static>(
this: *mut ffi::GtkCellArea,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(CellArea::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::focus-cell\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_focus_cell_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl fmt::Display for CellArea {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("CellArea")
}
}