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
use crate::enums::{Align, Color, FrameType};
use crate::prelude::*;
use crate::utils::FlString;
use crate::widget::Widget;
use fltk_sys::group::*;
use std::{
ffi::{CStr, CString},
mem,
sync::atomic::{AtomicBool, Ordering},
};
static DEBUG: AtomicBool = AtomicBool::new(false);
/// Creates a group widget
#[derive(Debug)]
pub struct Group {
inner: crate::widget::WidgetTracker,
is_derived: bool,
}
crate::macros::widget::impl_widget_ext!(Group, Fl_Group);
crate::macros::widget::impl_widget_base!(Group, Fl_Group);
crate::macros::widget::impl_widget_default!(Group);
crate::macros::group::impl_group_ext!(Group, Fl_Group);
impl Group {
#[deprecated(since = "1.2.18", note = "please use `try_current` instead")]
/// Get the current group
pub fn current() -> Group {
unsafe {
let ptr = Fl_Group_current();
assert!(!ptr.is_null());
Group::from_widget_ptr(ptr as _)
}
}
/// Tries to get the current group
pub fn try_current() -> Option<Group> {
unsafe {
let ptr = Fl_Group_current();
if ptr.is_null() {
None
} else {
Some(Group::from_widget_ptr(ptr as _))
}
}
}
/// Sets the current GroupExt widget which will take children
pub fn set_current(grp: Option<&impl GroupExt>) {
unsafe {
if let Some(grp) = grp {
Fl_Group_set_current(grp.as_widget_ptr() as _)
} else {
Fl_Group_set_current(std::ptr::null_mut())
}
}
}
}
/// Creates a widget pack
#[derive(Debug)]
pub struct Pack {
inner: crate::widget::WidgetTracker,
is_derived: bool,
}
crate::macros::widget::impl_widget_ext!(Pack, Fl_Pack);
crate::macros::widget::impl_widget_base!(Pack, Fl_Pack);
crate::macros::widget::impl_widget_default!(Pack);
crate::macros::group::impl_group_ext!(Pack, Fl_Pack);
/// Defines pack types
#[repr(i32)]
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum PackType {
/// Vertical layout pack
Vertical = 0,
/// Horizontal layout pack
Horizontal = 1,
}
crate::macros::widget::impl_widget_type!(PackType);
impl Pack {
/// Get the spacing of the pack
pub fn spacing(&self) -> i32 {
unsafe { Fl_Pack_spacing(self.inner.widget() as _) }
}
/// Set the spacing of the pack
pub fn set_spacing(&mut self, spacing: i32) {
unsafe {
Fl_Pack_set_spacing(self.inner.widget() as _, spacing);
}
}
/// Layout the children of the pack automatically.
/// Must be called on existing children
pub fn auto_layout(&mut self) {
let children = self.children();
if children == 0 {
return;
}
let spacing = self.spacing() * (children - 1);
let t = self.get_type::<PackType>();
let w = (self.width() - spacing) / children;
let h = (self.height() - spacing) / children;
for i in 0..children {
let mut c = self.child(i).unwrap();
let c_w = c.width();
let c_h = c.height();
if t == PackType::Vertical {
c.set_size(c_w, h);
} else {
c.set_size(w, c_h);
}
}
}
}
/// Creates a scroll group
#[derive(Debug)]
pub struct Scroll {
inner: crate::widget::WidgetTracker,
is_derived: bool,
}
crate::macros::widget::impl_widget_ext!(Scroll, Fl_Scroll);
crate::macros::widget::impl_widget_base!(Scroll, Fl_Scroll);
crate::macros::widget::impl_widget_default!(Scroll);
crate::macros::group::impl_group_ext!(Scroll, Fl_Scroll);
/// Defines Scroll types
#[repr(i32)]
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum ScrollType {
/// Never show bars
None = 0,
/// Show vertical bar
Horizontal = 1,
/// Show vertical bar
Vertical = 2,
/// Show both horizontal and vertical bars
Both = 3,
/// Always show bars
AlwaysOn = 4,
/// Show horizontal bar always
HorizontalAlways = 5,
/// Show vertical bar always
VerticalAlways = 6,
/// Always show both horizontal and vertical bars
BothAlways = 7,
}
crate::macros::widget::impl_widget_type!(ScrollType);
impl Scroll {
/// Returns the vertical scrollbar
pub fn scrollbar(&self) -> crate::valuator::Scrollbar {
unsafe {
let ptr = Fl_Scroll_scrollbar(self.inner.widget() as _);
assert!(!ptr.is_null());
crate::valuator::Scrollbar::from_widget_ptr(ptr as *mut fltk_sys::widget::Fl_Widget)
}
}
/// Returns the horizontal scrollbar
pub fn hscrollbar(&self) -> crate::valuator::Scrollbar {
unsafe {
let ptr = Fl_Scroll_hscrollbar(self.inner.widget() as _);
assert!(!ptr.is_null());
crate::valuator::Scrollbar::from_widget_ptr(ptr as *mut fltk_sys::widget::Fl_Widget)
}
}
/// Returns the x position
pub fn xposition(&self) -> i32 {
unsafe { Fl_Scroll_xposition(self.inner.widget() as _) }
}
/// Returns the y position
pub fn yposition(&self) -> i32 {
unsafe { Fl_Scroll_yposition(self.inner.widget() as _) }
}
/// Scrolls to `x` and `y`
pub fn scroll_to(&mut self, x: i32, y: i32) {
unsafe { Fl_Scroll_scroll_to(self.inner.widget() as _, x, y) }
}
/// Gets the scrollbar size
pub fn scrollbar_size(&self) -> i32 {
unsafe { Fl_Scroll_scrollbar_size(self.inner.widget() as _) }
}
/// Sets the scrollbar size
pub fn set_scrollbar_size(&mut self, new_size: i32) {
unsafe { Fl_Scroll_set_scrollbar_size(self.inner.widget() as _, new_size) }
}
}
/// Defines how Tabs handle overflow
#[repr(i32)]
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
pub enum TabsOverflow {
/// Compress tabs
Compress = 0,
/// Clip tabs
Clip,
/// Create a pulldown
Pulldown,
/// Drag tabs
Drag,
}
/// Creates a tab which can contain widgets
#[derive(Debug)]
pub struct Tabs {
inner: crate::widget::WidgetTracker,
is_derived: bool,
}
crate::macros::widget::impl_widget_ext!(Tabs, Fl_Tabs);
crate::macros::widget::impl_widget_base!(Tabs, Fl_Tabs);
crate::macros::widget::impl_widget_default!(Tabs);
crate::macros::group::impl_group_ext!(Tabs, Fl_Tabs);
impl Tabs {
/// Gets the currently visible group
pub fn value(&self) -> Option<impl GroupExt> {
unsafe {
let ptr = Fl_Tabs_value(self.inner.widget() as _);
if ptr.is_null() {
None
} else {
Some(Group::from_widget_ptr(
ptr as *mut fltk_sys::widget::Fl_Widget,
))
}
}
}
/// Sets the currently visible group
/// # Errors
/// Errors when the value can't be set for the group widget
pub fn set_value<Grp: GroupExt>(&mut self, w: &Grp) -> Result<(), FltkError> {
unsafe {
match Fl_Tabs_set_value(
self.inner.widget() as _,
w.as_widget_ptr() as *mut fltk_sys::group::Fl_Widget,
) {
0 => Err(FltkError::Internal(FltkErrorKind::FailedOperation)),
_ => Ok(()),
}
}
}
/// Returns the tab group for the tab the user has currently down-clicked
pub fn push(&self) -> Option<impl GroupExt> {
unsafe {
let ptr = Fl_Tabs_push(self.inner.widget() as _);
if ptr.is_null() {
None
} else {
Some(Group::from_widget_ptr(
ptr as *mut fltk_sys::widget::Fl_Widget,
))
}
}
}
/// This is called by the tab widget's handle() method to set the tab group widget the user last pushed
/// # Errors
/// Errors if `set_push` can't be set for the group widget
pub fn set_push<Grp: GroupExt>(&mut self, w: &Grp) -> Result<(), FltkError> {
unsafe {
match Fl_Tabs_set_push(
self.inner.widget() as _,
w.as_widget_ptr() as *mut fltk_sys::group::Fl_Widget,
) {
0 => Err(FltkError::Internal(FltkErrorKind::FailedOperation)),
_ => Ok(()),
}
}
}
/// Returns the position and size available to be used by its children
pub fn client_area(&self) -> (i32, i32, i32, i32) {
unsafe {
let mut i1 = 0;
let mut i2 = 0;
let mut i3 = 0;
let mut i4 = 0;
Fl_Tabs_client_area(self.inner.widget() as _, &mut i1, &mut i2, &mut i3, &mut i4);
(i1, i2, i3, i4)
}
}
/// Sets the tab label alignment
pub fn set_tab_align(&mut self, a: Align) {
unsafe { Fl_Tabs_set_tab_align(self.inner.widget() as _, a.bits()) }
}
/// Gets the tab label alignment.
pub fn tab_align(&self) -> Align {
unsafe { mem::transmute(Fl_Tabs_tab_align(self.inner.widget() as _)) }
}
/// Auto layout a tabs widget
pub fn auto_layout(&mut self) {
for c in self.clone().into_iter() {
if let Some(mut c) = c.as_group() {
c.resize(self.x(), self.y() + 30, self.w(), self.h() - 30);
}
}
self.resize_callback(|t, x, y, w, h| {
for c in t.clone().into_iter() {
if let Some(mut c) = c.as_group() {
c.resize(x, y + 30, w, h - 30);
}
}
});
}
/// Sets how the Tabs handles overflow
pub fn handle_overflow(&mut self, ov: TabsOverflow) {
unsafe { Fl_Tabs_handle_overflow(self.inner.widget() as _, ov as i32) }
}
}
/// Creates a tile which can contain widgets. For the tiling to work correctly, the children of a Tile must cover the entire area of the widget, but not overlap. This means that all children must touch each other at their edges, and no gaps can be left inside the Tile.
/// More info can be found [here](https://www.fltk.org/doc-1.4/classFl__Tile.html#details)
#[derive(Debug)]
pub struct Tile {
inner: crate::widget::WidgetTracker,
is_derived: bool,
}
crate::macros::widget::impl_widget_ext!(Tile, Fl_Tile);
crate::macros::widget::impl_widget_base!(Tile, Fl_Tile);
crate::macros::widget::impl_widget_default!(Tile);
crate::macros::group::impl_group_ext!(Tile, Fl_Tile);
/// Creates a wizard widget
#[derive(Debug)]
pub struct Wizard {
inner: crate::widget::WidgetTracker,
is_derived: bool,
}
crate::macros::widget::impl_widget_ext!(Wizard, Fl_Wizard);
crate::macros::widget::impl_widget_base!(Wizard, Fl_Wizard);
crate::macros::widget::impl_widget_default!(Wizard);
crate::macros::group::impl_group_ext!(Wizard, Fl_Wizard);
impl Wizard {
/// Gets the next view of the wizard
pub fn next(&mut self) {
unsafe { Fl_Wizard_next(self.inner.widget() as _) }
}
/// Gets the previous view of the wizard
pub fn prev(&mut self) {
unsafe { Fl_Wizard_prev(self.inner.widget() as _) }
}
#[deprecated(since = "1.2.18", note = "please use `try_current_widget` instead")]
/// Gets the underlying widget of the current view
pub fn current_widget(&self) -> Widget {
unsafe {
let ptr = Fl_Wizard_value(self.inner.widget() as _) as *mut fltk_sys::widget::Fl_Widget;
assert!(!ptr.is_null());
Widget::from_widget_ptr(ptr)
}
}
/// Gets the underlying widget of the current view
pub fn try_current_widget(&self) -> Option<impl WidgetExt> {
unsafe {
let ptr = Fl_Wizard_value(self.inner.widget() as _) as *mut fltk_sys::widget::Fl_Widget;
if ptr.is_null() {
None
} else {
Some(Widget::from_widget_ptr(ptr))
}
}
}
/// Sets the underlying widget of the current view
pub fn set_current_widget<W: WidgetExt>(&mut self, w: &W) {
unsafe {
Fl_Wizard_set_value(
self.inner.widget() as _,
w.as_widget_ptr() as *mut fltk_sys::group::Fl_Widget,
)
}
}
}
/// Creates a color chooser widget
#[derive(Debug)]
pub struct ColorChooser {
inner: crate::widget::WidgetTracker,
is_derived: bool,
}
crate::macros::widget::impl_widget_ext!(ColorChooser, Fl_Color_Chooser);
crate::macros::widget::impl_widget_base!(ColorChooser, Fl_Color_Chooser);
crate::macros::widget::impl_widget_default!(ColorChooser);
crate::macros::group::impl_group_ext!(ColorChooser, Fl_Color_Chooser);
impl ColorChooser {
/// Return the rgb color
pub fn rgb_color(&self) -> (u8, u8, u8) {
unsafe {
let r = (Fl_Color_Chooser_r(self.inner.widget() as _) * 255.0) as u8;
let g = (Fl_Color_Chooser_g(self.inner.widget() as _) * 255.0) as u8;
let b = (Fl_Color_Chooser_b(self.inner.widget() as _) * 255.0) as u8;
(r, g, b)
}
}
/// Return the hex color
pub fn hex_color(&self) -> u32 {
let (r, g, b) = self.rgb_color();
crate::utils::rgb2hex(r, g, b)
}
/// Set the base color of the ColorChooser. Returns an error on failure to change the color (wrong input)
pub fn set_rgb(&mut self, r: u8, g: u8, b: u8) -> Result<(), FltkError> {
unsafe {
let ret = Fl_Color_Chooser_set_rgb(
self.inner.widget() as _,
r as f64 / 255.0,
g as f64 / 255.0,
b as f64 / 255.0,
);
if ret == 1 {
Ok(())
} else {
Err(FltkError::Internal(FltkErrorKind::FailedOperation))
}
}
}
/// Set the base color of the ColorChooser. Returns an error on failure to change the color (wrong input)
pub fn set_tuple_rgb(&mut self, (r, g, b): (u8, u8, u8)) -> Result<(), FltkError> {
unsafe {
let ret = Fl_Color_Chooser_set_rgb(
self.inner.widget() as _,
r as f64 / 255.0,
g as f64 / 255.0,
b as f64 / 255.0,
);
if ret == 1 {
Ok(())
} else {
Err(FltkError::Internal(FltkErrorKind::FailedOperation))
}
}
}
}
crate::macros::widget::impl_widget_type!(FlexType);
/// Defines Flex types
#[repr(i32)]
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum FlexType {
/// row direction
Column = 0,
/// column direction
Row,
}
/**
a Flexbox widget
# Example
```rust,no_run
use fltk::{prelude::*, *};
fn main() {
let a = app::App::default();
let mut win = window::Window::default().with_size(400, 300);
let mut col = group::Flex::default().size_of_parent();
col.set_type(group::FlexType::Column);
let expanding = button::Button::default().with_label("Expanding");
let mut normal = button::Button::default().with_label("Normal");
col.set_size(&mut normal, 30);
col.end();
win.end();
win.show();
a.run().unwrap();
}
```
*/
#[derive(Debug)]
pub struct Flex {
inner: crate::widget::WidgetTracker,
is_derived: bool,
}
crate::macros::widget::impl_widget_ext!(Flex, Fl_Flex);
crate::macros::widget::impl_widget_base!(Flex, Fl_Flex);
crate::macros::widget::impl_widget_default!(Flex);
crate::macros::group::impl_group_ext!(Flex, Fl_Flex);
impl Flex {
/// Create a new Flex widget.
/// This code is here for backward compatibility with initial Fl_Flex code, which defaulted to Row instead of Column.
/// The behavior will be changed in fltk-rs version 2.
fn new<T: Into<Option<&'static str>>>(
x: i32,
y: i32,
width: i32,
height: i32,
title: T,
) -> Self {
let mut f = <Flex as WidgetBase>::new(x, y, width, height, title).row();
f.set_pad(5);
f.debug_();
f
}
/// Add a widget to the Flex box
pub fn add<W: WidgetExt>(&mut self, widget: &W) {
<Self as GroupExt>::add(self, widget);
self.recalc();
}
/// Add a widget to the Flex box
pub fn insert<W: WidgetExt>(&mut self, widget: &W, idx: i32) {
<Self as GroupExt>::insert(self, widget, idx);
self.recalc();
}
/// Set the size of the widget, same as `fixed` (before it was changed in FLTK 1.4)
#[deprecated(since = "1.4.8", note = "please use `fixed` instead")]
pub fn set_size<W: WidgetExt>(&mut self, w: &W, size: i32) {
unsafe { Fl_Flex_set_size(self.inner.widget() as _, w.as_widget_ptr() as _, size) }
}
/// Set the size of the widget, same as `set_size`, but more inline with the new FLTK Fl_Flex api
pub fn fixed<W: WidgetExt>(&mut self, w: &W, size: i32) {
unsafe { Fl_Flex_set_size(self.inner.widget() as _, w.as_widget_ptr() as _, size) }
}
/// Debug the flex layout
pub fn debug(flag: bool) {
DEBUG.store(flag, Ordering::Release);
}
fn debug_(&mut self) {
if DEBUG.load(Ordering::Relaxed) {
self.set_frame(FrameType::BorderBox);
if self.get_type::<FlexType>() == FlexType::Row {
self.set_color(Color::from_rgb(200, 0, 0));
} else {
self.set_color(Color::from_rgb(0, 0, 200));
}
}
}
/// Set the type to be a column
pub fn column(mut self) -> Self {
self.set_type(FlexType::Column);
self.debug_();
self
}
/// Set the type to a row
pub fn row(mut self) -> Self {
self.set_type(FlexType::Row);
self.debug_();
self
}
/// Recalculate children's coords and sizes
pub fn recalc(&self) {
let mut s = self.clone();
s.resize(self.x(), self.y(), self.w(), self.h());
s.redraw();
}
/// Recalculate children's coords and sizes
pub fn layout(&self) {
self.recalc();
}
/// Set the margin
pub fn set_margin(&mut self, m: i32) {
unsafe { Fl_Flex_set_margin(self.inner.widget() as _, m) }
}
/// Get the margin
pub fn margin(&self) -> i32 {
unsafe { Fl_Flex_margin(self.inner.widget() as _) }
}
/// Set the padding
pub fn set_pad(&mut self, p: i32) {
unsafe { Fl_Flex_set_pad(self.inner.widget() as _, p) }
}
/// Get the padding
pub fn pad(&self) -> i32 {
unsafe { Fl_Flex_pad(self.inner.widget() as _) }
}
/// Set the padding
pub fn set_spacing(&mut self, p: i32) {
unsafe { Fl_Flex_set_pad(self.inner.widget() as _, p) }
}
/// Get the padding
pub fn spacing(&self) -> i32 {
unsafe { Fl_Flex_pad(self.inner.widget() as _) }
}
/// Set the margins
pub fn set_margins(&mut self, left: i32, top: i32, right: i32, bottom: i32) {
unsafe { Fl_Flex_set_margins(self.inner.widget() as _, left, top, right, bottom) }
}
/// Get the margins -> returns (left, top, right, bottom)
pub fn margins(&self) -> (i32, i32, i32, i32) {
let mut left = 0;
let mut top = 0;
let mut right = 0;
let mut bottom = 0;
unsafe {
Fl_Flex_margins(
self.inner.widget() as _,
&mut left,
&mut top,
&mut right,
&mut bottom,
);
}
(left, top, right, bottom)
}
}
/**
Defines a Vertical Grid (custom widget).
Requires setting the params manually using the `set_params` method, which takes the rows, columns and spacing.
```rust,no_run
use fltk::{prelude::*, *};
fn main() {
let app = app::App::default();
let mut win = window::Window::default().with_size(400, 300);
let mut grid = group::VGrid::new(0, 0, 400, 300, "");
grid.set_params(3, 3, 5);
button::Button::default();
button::Button::default();
button::Button::default();
button::Button::default();
button::Button::default();
button::Button::default();
button::Button::default();
button::Button::default();
grid.end();
win.end();
win.show();
app.run().unwrap();
}
```
*/
#[derive(Debug, Clone)]
pub struct VGrid {
vpack: Pack,
rows: i32,
cols: i32,
current: i32,
}
impl Default for VGrid {
fn default() -> Self {
Self::new(0, 0, 0, 0, None)
}
}
impl VGrid {
/// Constructs a widget with the size of its parent
pub fn default_fill() -> Self {
Self::default().size_of_parent()
}
/// Creates a new vertical grid
pub fn new<T: Into<Option<&'static str>>>(x: i32, y: i32, w: i32, h: i32, label: T) -> VGrid {
let vpack = Pack::new(x, y, w, h, label);
VGrid {
vpack,
rows: 1,
cols: 1,
current: 0,
}
}
/// Sets the params for the grid
pub fn set_params(&mut self, rows: i32, cols: i32, spacing: i32) {
self.vpack.set_spacing(spacing);
let rows = if rows < 1 { 1 } else { rows };
let cols = if cols < 1 { 1 } else { cols };
self.rows = rows;
self.cols = cols;
for _ in 0..rows {
let mut p = Pack::new(0, 0, self.vpack.width(), 0, "");
p.set_type(PackType::Horizontal);
p.set_spacing(spacing);
p.end();
self.vpack.add(&p);
}
}
/// Adds widgets to the grid
pub fn add<W: WidgetExt>(&mut self, w: &W) {
debug_assert!(self.current < self.rows * self.cols);
let rem = (self.current - 1) / self.cols;
if rem < self.rows {
let hpack = self.vpack.child(rem).unwrap();
let mut hpack = unsafe { Pack::from_widget_ptr(hpack.as_widget_ptr()) };
hpack.end();
hpack.add(w);
hpack.auto_layout();
self.vpack.auto_layout();
self.current += 1;
}
}
/// End the grid
pub fn end(&mut self) {
use std::collections::VecDeque;
let children = self.vpack.children();
self.current = children - self.rows;
debug_assert!(self.current <= self.rows * self.cols);
let mut v = VecDeque::new();
for i in self.rows..children {
let c = self.vpack.child(i).unwrap();
v.push_back(c);
}
for i in 0..self.rows {
let hpack = self.vpack.child(i).unwrap();
let mut hpack = unsafe { Pack::from_widget_ptr(hpack.as_widget_ptr()) };
hpack.end();
for _j in 0..self.cols {
if let Some(w) = v.pop_front() {
self.vpack.remove(&w);
hpack.add(&w);
}
hpack.auto_layout();
}
}
self.vpack.auto_layout();
}
}
crate::widget_extends!(VGrid, Pack, vpack);
/**
Defines a Horizontal Grid (custom widget).
Requires setting the params manually using the `set_params` method, which takes the rows, columns and spacing.
```rust,no_run
use fltk::{prelude::*, *};
fn main() {
let app = app::App::default();
let mut win = window::Window::default().with_size(400, 300);
let mut grid = group::HGrid::new(0, 0, 400, 300, "");
grid.set_params(3, 3, 5);
button::Button::default();
button::Button::default();
button::Button::default();
button::Button::default();
button::Button::default();
button::Button::default();
button::Button::default();
button::Button::default();
grid.end();
win.end();
win.show();
app.run().unwrap();
}
```
*/
#[derive(Debug, Clone)]
pub struct HGrid {
hpack: Pack,
rows: i32,
cols: i32,
current: i32,
}
impl Default for HGrid {
fn default() -> Self {
Self::new(0, 0, 0, 0, None)
}
}
impl HGrid {
/// Constructs a widget with the size of its parent
pub fn default_fill() -> Self {
Self::default().size_of_parent()
}
/// Creates a new horizontal grid
pub fn new<T: Into<Option<&'static str>>>(x: i32, y: i32, w: i32, h: i32, label: T) -> HGrid {
let mut hpack = Pack::new(x, y, w, h, label);
hpack.set_type(PackType::Horizontal);
HGrid {
hpack,
rows: 1,
cols: 1,
current: 0,
}
}
/// Sets the params for the grid
pub fn set_params(&mut self, rows: i32, cols: i32, spacing: i32) {
self.hpack.set_spacing(spacing);
let rows = if rows < 1 { 1 } else { rows };
let cols = if cols < 1 { 1 } else { cols };
self.rows = rows;
self.cols = cols;
for _ in 0..cols {
let mut p = Pack::new(0, 0, 0, self.hpack.height(), "");
p.set_spacing(spacing);
p.end();
self.hpack.add(&p);
}
}
/// Adds widgets to the grid
pub fn add<W: WidgetExt>(&mut self, w: &W) {
debug_assert!(self.current < self.rows * self.cols);
let rem = (self.current - 1) / self.rows;
if rem < self.cols {
let vpack = self.hpack.child(rem).unwrap();
let mut vpack = unsafe { Pack::from_widget_ptr(vpack.as_widget_ptr()) };
vpack.end();
vpack.add(w);
vpack.auto_layout();
self.hpack.auto_layout();
self.current += 1;
}
}
/// End the grid
pub fn end(&mut self) {
use std::collections::VecDeque;
let children = self.hpack.children();
self.current = children - self.cols;
debug_assert!(self.current <= self.rows * self.cols);
let mut v = VecDeque::new();
for i in self.cols..children {
let c = self.hpack.child(i).unwrap();
v.push_back(c);
}
for i in 0..self.cols {
let vpack = self.hpack.child(i).unwrap();
let mut vpack = unsafe { Pack::from_widget_ptr(vpack.as_widget_ptr()) };
vpack.end();
for _j in 0..self.rows {
if let Some(w) = v.pop_front() {
self.hpack.remove(&w);
vpack.add(&w);
}
vpack.auto_layout();
}
}
self.hpack.auto_layout();
}
}
crate::widget_extends!(HGrid, Pack, hpack);
/// A wrapper around a Flex column
#[derive(Debug, Clone)]
pub struct Column {
p: Flex,
}
impl Default for Column {
fn default() -> Self {
Self::new(0, 0, 0, 0, None)
}
}
impl Column {
/// Constructs a widget with the size of its parent
pub fn default_fill() -> Self {
Self::default().size_of_parent().center_of_parent()
}
/// Create a new column
pub fn new<T: Into<Option<&'static str>>>(
x: i32,
y: i32,
width: i32,
height: i32,
label: T,
) -> Column {
let mut p = Flex::new(x, y, width, height, label);
p.set_type(FlexType::Column);
Column { p }
}
/// Add a widget to the column with automatic layouting
pub fn add<W: WidgetExt>(&mut self, w: &W) {
self.p.add(w);
}
}
crate::widget_extends!(Column, Flex, p);
/// A wrapper around a Flex row
#[derive(Debug, Clone)]
pub struct Row {
p: Flex,
}
impl Default for Row {
fn default() -> Self {
Self::new(0, 0, 0, 0, None)
}
}
impl Row {
/// Constructs a widget with the size of its parent
pub fn default_fill() -> Self {
Self::default().size_of_parent().center_of_parent()
}
/// Create a new row
pub fn new<T: Into<Option<&'static str>>>(
x: i32,
y: i32,
width: i32,
height: i32,
label: T,
) -> Row {
let mut p = Flex::new(x, y, width, height, label);
p.set_type(FlexType::Row);
Row { p }
}
/// Add a widget to the row with automatic layouting
pub fn add<W: WidgetExt>(&mut self, w: &W) {
self.p.add(w);
}
}
crate::widget_extends!(Row, Flex, p);
/// Experimental Group widgets, the api might change.
/// # Warning
/// The api might change if changes happen upstream
pub mod experimental {
use super::*;
use crate::enums::Font;
use std::ops::Range;
/// Grid range
pub struct GridRange {
start: usize,
end: usize,
}
impl GridRange {
/// Check the length of the GridRange
pub fn len(&self) -> usize {
self.end - self.start
}
/// Check whether the GridRange is empty
pub fn is_empty(&self) -> bool {
self.len() == 0
}
}
impl From<Range<usize>> for GridRange {
fn from(val: Range<usize>) -> Self {
Self {
start: val.start,
end: val.end,
}
}
}
impl From<usize> for GridRange {
fn from(val: usize) -> Self {
(val..val + 1).into()
}
}
bitflags::bitflags! {
/// Defines alignment rules used by FLTK's Grid
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct GridAlign: u16 {
/** Align the widget at the center of the cell. */
const CENTER = 0x0000;
/** Align the widget at the top of the cell. */
const TOP = 0x0001;
/** Align the widget at the bottom of the cell. */
const BOTTOM = 0x0002;
/** Align the widget at the left side of the cell. */
const LEFT = 0x0004;
/** Align the widget at the right side of the cell. */
const RIGHT = 0x0008;
/** Stretch the widget horizontally to fill the cell. */
const HORIZONTAL = 0x0010;
/** Stretch the widget vertically to fill the cell. */
const VERTICAL = 0x0020;
/** Stretch the widget in both directions to fill the cell. */
const FILL = 0x0030;
/** Stretch the widget proportionally. */
const PROPORTIONAL = 0x0040;
/** Align the widget at the top left of the cell. */
const TOP_LEFT = GridAlign::TOP.bits() | GridAlign::LEFT.bits();
/** Align the widget at the top right of the cell. */
const TOP_RIGHT = GridAlign::TOP.bits() | GridAlign::RIGHT.bits();
/** Align the widget at the bottom left of the cell. */
const BOTTOM_LEFT = GridAlign::BOTTOM.bits() | GridAlign::LEFT.bits();
/** Align the widget at the bottom right of the cell. */
const BOTTOM_RIGHT = GridAlign::BOTTOM.bits() | GridAlign::RIGHT.bits();
}
}
/// Fltk's grid widget
#[derive(Debug)]
pub struct Grid {
inner: crate::widget::WidgetTracker,
is_derived: bool,
}
crate::macros::widget::impl_widget_ext!(Grid, Fl_Grid);
crate::macros::widget::impl_widget_base!(Grid, Fl_Grid);
crate::macros::widget::impl_widget_default!(Grid);
crate::macros::group::impl_group_ext!(Grid, Fl_Grid);
impl Grid {
/// Set the layout of the grid, along with the margin and gap
pub fn set_layout_ext(&mut self, rows: i32, cols: i32, margin: i32, gap: i32) {
unsafe { Fl_Grid_set_layout(self.inner.widget() as _, rows, cols, margin, gap) }
}
/// Set the layout of the grid
pub fn set_layout(&mut self, rows: i32, cols: i32) {
unsafe { Fl_Grid_set_layout(self.inner.widget() as _, rows, cols, -1, -1) }
}
/// Layout the grid
pub fn layout(&mut self) {
unsafe { Fl_Grid_layout(self.inner.widget() as _) }
}
/// Clear the layout
pub fn clear_layout(&mut self) {
unsafe { Fl_Grid_clear_layout(self.inner.widget() as _) }
}
/// Set whether the Grid needs layout
pub fn set_need_layout(&mut self, set: bool) {
unsafe { Fl_Grid_set_need_layout(self.inner.widget() as _, set as _) }
}
/// Get whether the Grid needs layout
pub fn need_layout(&self) -> bool {
unsafe { Fl_Grid_need_layout(self.inner.widget() as _) != 0 }
}
/// Set the grid's margin
pub fn set_margin(&mut self, left: i32, top: i32, right: i32, bottom: i32) {
unsafe { Fl_Grid_set_margin(self.inner.widget() as _, left, top, right, bottom) }
}
/// Set the grid's gap
pub fn set_gap(&mut self, row_gap: i32, col_gap: i32) {
unsafe { Fl_Grid_set_gap(self.inner.widget() as _, row_gap, col_gap) }
}
#[allow(dead_code)]
/// Set the widget at row/column and alignment
pub fn set_widget_<W: WidgetExt>(
&mut self,
wi: &mut W,
row: i32,
col: i32,
align: GridAlign,
) -> *mut () {
unsafe {
Fl_Grid_set_widget(
self.inner.widget() as _,
wi.as_widget_ptr() as _,
row,
col,
align.bits(),
) as _
}
}
/// Set the widget at row/column using ranges
pub fn set_widget<W: 'static + Clone + WidgetExt>(
&mut self,
widget: &mut W,
row: impl Into<GridRange>,
col: impl Into<GridRange>,
) {
let row = row.into();
let col = col.into();
self.set_widget_ext(widget, row, col, GridAlign::FILL);
}
/// Set the widget at row/column along with row span and column span and alignment
fn set_widget_ext_<W: WidgetExt>(
&mut self,
wi: &mut W,
row: i32,
col: i32,
rowspan: i32,
colspan: i32,
align: GridAlign,
) -> *mut () {
unsafe {
Fl_Grid_set_widget_ext(
self.inner.widget() as _,
wi.as_widget_ptr() as _,
row,
col,
rowspan,
colspan,
align.bits(),
) as _
}
}
/// Set the widget at row/column using ranges along with the alignment
pub fn set_widget_ext<W: 'static + Clone + WidgetExt>(
&mut self,
widget: &mut W,
row: impl Into<GridRange>,
col: impl Into<GridRange>,
align: GridAlign,
) {
let row = row.into();
let col = col.into();
self.set_widget_ext_(
widget,
row.start as _,
col.start as _,
row.len() as _,
col.len() as _,
align,
);
}
/// Set the column width
pub fn set_col_width(&mut self, col: i32, value: i32) {
unsafe { Fl_Grid_set_col_width(self.inner.widget() as _, col, value) }
}
/// Set the column weight
pub fn set_col_weight(&mut self, col: i32, value: i32) {
unsafe { Fl_Grid_set_col_weight(self.inner.widget() as _, col, value) }
}
/// Set the column gap
pub fn set_col_gap(&mut self, col: i32, value: i32) {
unsafe { Fl_Grid_set_col_gap(self.inner.widget() as _, col, value) }
}
/// Set the row height
pub fn set_row_height(&mut self, row: i32, value: i32) {
unsafe { Fl_Grid_set_row_height(self.inner.widget() as _, row, value) }
}
/// Set the row weight
pub fn set_row_weight(&mut self, row: i32, value: i32) {
unsafe { Fl_Grid_set_row_weight(self.inner.widget() as _, row, value) }
}
/// Set the row gap
pub fn set_row_gap(&mut self, row: i32, value: i32) {
unsafe { Fl_Grid_set_row_gap(self.inner.widget() as _, row, value) }
}
/// Show the grid
pub fn show_grid(&mut self, set: bool) {
unsafe { Fl_Grid_show_grid(self.inner.widget() as _, set as _) }
}
/// Show the grid with a certain color
pub fn show_grid_with_color(&mut self, set: bool, col: Color) {
unsafe { Fl_Grid_show_grid_with_color(self.inner.widget() as _, set as _, col.bits()) }
}
/// Debug the grid
pub fn debug(&mut self, level: i32) {
unsafe { Fl_Grid_debug(self.inner.widget() as _, level) }
}
}
/// Creates a scrollable display widget to handle terminal-like behavior, such as
/// logging events or debug information.
/// Replaces SimpleTerminal widget
///
#[derive(Debug)]
pub struct Terminal {
inner: crate::widget::WidgetTracker,
is_derived: bool,
}
crate::macros::widget::impl_widget_ext!(Terminal, Fl_Terminal);
crate::macros::widget::impl_widget_base!(Terminal, Fl_Terminal);
crate::macros::widget::impl_widget_default!(Terminal);
crate::macros::group::impl_group_ext!(Terminal, Fl_Terminal);
/// Determines when Fl_Terminal calls redraw() if new text is added.
/// RATE_LIMITED is the recommended setting, using redraw_rate(float) to determine
/// the maximum rate of redraws.
/// see redraw_style(), redraw_rate()
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[repr(u32)]
#[non_exhaustive]
pub enum RedrawStyle {
/// App must call redraw() as needed to update text to screen
NoRedraw = 0x0000,
/// timer controlled redraws. (DEFAULT)
RateLimited = 0x0001, // todo: this is dangerous, because enum values are implicitly assigned in the C++ code
/// redraw triggered after *every* append() / printf() / etc. operation
PerWrite = 0x0002,
}
impl RedrawStyle {
/// Build a RedrawStyle enum with an arbitrary value.
// todo: is there a cleaner way to do this without using unsafe::reinterpret_cast?
fn new(val: u32) -> RedrawStyle {
if val == RedrawStyle::RateLimited as u32 {
RedrawStyle::RateLimited
} else if val == RedrawStyle::NoRedraw as u32 {
RedrawStyle::NoRedraw
} else if val == RedrawStyle::PerWrite as u32 {
RedrawStyle::PerWrite
} else {
panic!("Unknown RedrawStyle value {}", val)
}
}
}
/// Bits for the per-character attributes, which control text features
/// such as italic, bold, underlined text, etc.
/// Can be combined with | operator
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct Attrib {
// Implemented this way to look like an enum but allow attributes to be ored together
bits: u8,
}
impl Attrib {
/// all attributes off
pub const Normal: Attrib = Attrib { bits: 0x00 };
/// bold text: uses bold font, color brighter than normal
pub const Bold: Attrib = Attrib { bits: 0x01 };
/// dim text; color slightly darker than normal
pub const Dim: Attrib = Attrib { bits: 0x02 };
/// italic font text
pub const Italic: Attrib = Attrib { bits: 0x04 };
/// underlined text
pub const Underline: Attrib = Attrib { bits: 0x08 };
/// <EM>(reserved for internal future use)</EM>
pub const _Reserved1: Attrib = Attrib { bits: 0x10 };
/// inverse text; fg/bg color are swapped
pub const Inverse: Attrib = Attrib { bits: 0x20 };
/// <EM>(reserved for internal future use)</EM>
pub const _Reserved2: Attrib = Attrib { bits: 0x40 };
/// strikeout text
pub const Strikeout: Attrib = Attrib { bits: 0x80 };
/// Get the bitflag representation
pub fn bits(&self) -> u8 {
self.bits
}
}
impl std::ops::BitOr<Attrib> for Attrib {
type Output = Attrib;
fn bitor(self, rhs: Self) -> Attrib {
Attrib {
bits: self.bits() | rhs.bits(),
}
}
}
/// 'xterm color' values, used in set_text_fg_color_xterm and set_text_bg_color_xterm
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[repr(u8)]
#[allow(missing_docs)] // These color names are self-documenting
#[non_exhaustive]
pub enum XtermColor {
Black = 0,
Red = 1,
Green = 2,
Yellow = 3,
Blue = 4,
Magenta = 5,
Cyan = 6,
White = 7,
}
impl Terminal {
/// Returns whether the terminal is in ANSI mode.
pub fn ansi(&self) -> bool {
unsafe { Fl_Terminal_ansi(self.inner.widget() as _) != 0 }
}
/// Enable/disable ANSI mode. If true, ANSI and VT100/xterm codes will be processed.
/// If false, these codes won't be processed and will either be ignored or print the
/// error character "¿", depending on the value of show_unknown().
pub fn set_ansi(&mut self, arg1: bool) {
unsafe { Fl_Terminal_set_ansi(self.inner.widget() as _, arg1 as i32) }
}
/// Appends text to the terminal at current cursor position using the current text color/attributes.
/// Redraws are managed automatically by default; see redraw_style()
pub fn append(&mut self, s: &str) {
let s = CString::safe_new(s);
unsafe { Fl_Terminal_append(self.inner.widget() as _, s.into_raw() as _) }
}
/// Appends data to the terminal at current cursor position using the current text color/attributes
/// Redraws are managed automatically by default; see redraw_style()
pub fn append_u8(&mut self, s: &[u8]) {
unsafe {
Fl_Terminal_append_u8(self.inner.widget() as _, s.as_ptr() as _, s.len() as _)
}
}
/// Appends text to the terminal at current cursor position using the current text color/attributes.
/// Slightly more efficient than append_utf8
/// Redraws are managed automatically by default; see redraw_style()
pub fn append_ascii(&mut self, s: &str) {
let s = CString::safe_new(s);
unsafe { Fl_Terminal_append_ascii(self.inner.widget() as _, s.into_raw() as _) }
}
/// Appends text to the terminal at current cursor position using the current text color/attributes.
/// Handles UTF-8 chars split across calls
/// Redraws are managed automatically by default; see redraw_style()
pub fn append_utf8(&mut self, s: &str) {
let s = CString::safe_new(s);
unsafe { Fl_Terminal_append_utf8(self.inner.widget() as _, s.into_raw() as _) }
}
/// Appends data to the terminal at current cursor position using the current text color/attributes
/// Handles UTF-8 chars split across calls
/// Redraws are managed automatically by default; see redraw_style()
pub fn append_utf8_u8(&mut self, s: &[u8]) {
unsafe {
Fl_Terminal_append_utf8_u8(self.inner.widget() as _, s.as_ptr() as _, s.len() as _)
}
}
/// Clears the scroll history buffer and adjusts scrollbar, forcing it to redraw()
pub fn clear_history(&mut self) {
unsafe { Fl_Terminal_clear_history(self.inner.widget() as _) }
}
/// Return the cursor's current column position on the screen.
pub fn cursor_col(&self) -> i32 {
unsafe { Fl_Terminal_cursor_col(self.inner.widget() as _) }
}
/// Return the cursor's current row position on the screen.
pub fn cursor_row(&self) -> i32 {
unsafe { Fl_Terminal_cursor_row(self.inner.widget() as _) }
}
/// Get the cursor's background color used for the cursor itself.
pub fn cursor_bg_color(&mut self) -> Color {
Color::from_rgbi(unsafe { Fl_Terminal_cursor_bg_color(self.inner.widget() as _) })
}
/// Set the cursor's background color used for the cursor itself.
pub fn set_cursor_bg_color(&self, color: Color) {
unsafe { Fl_Terminal_set_cursor_bg_color(self.inner.widget() as _, color.bits()) }
}
/// Get the cursor's foreground color used for the cursor itself.
pub fn cursor_fg_color(&mut self) -> Color {
Color::from_rgbi(unsafe { Fl_Terminal_cursor_fg_color(self.inner.widget() as _) })
}
/// Set the cursor's foreground color used for the cursor itself.
pub fn set_cursor_fg_color(&self, color: Color) {
unsafe { Fl_Terminal_set_cursor_fg_color(self.inner.widget() as _, color.bits()) }
}
/// Return terminal's display width in columns of text characters.
pub fn display_columns(&self) -> i32 {
unsafe { Fl_Terminal_display_columns(self.inner.widget() as _) }
}
/// Set terminal's display width in columns of text characters.
pub fn set_display_columns(&self, val: i32) {
unsafe { Fl_Terminal_set_display_columns(self.inner.widget() as _, val) }
}
/// Return terminal's display height in lines of text.
pub fn display_rows(&self) -> i32 {
unsafe { Fl_Terminal_display_rows(self.inner.widget() as _) }
}
/// Set terminal's display height in lines of text.
pub fn set_display_rows(&self, val: i32) {
unsafe { Fl_Terminal_set_display_rows(self.inner.widget() as _, val) }
}
/// Sets the number of lines of screen history.
pub fn set_history_lines(&mut self, arg1: i32) {
unsafe { Fl_Terminal_set_history_lines(self.inner.widget() as _, arg1) }
}
/// Gets the number of lines of screen history.
pub fn history_lines(&self) -> i32 {
unsafe { Fl_Terminal_history_lines(self.inner.widget() as _) }
}
/// Sets the terminal's scrollback history buffer size in lines of text (rows).
pub fn set_history_rows(&mut self, arg1: i32) {
unsafe { Fl_Terminal_set_history_rows(self.inner.widget() as _, arg1) }
}
/// Gets the terminal's scrollback history buffer size in lines of text (rows).
pub fn history_rows(&self) -> i32 {
unsafe { Fl_Terminal_history_rows(self.inner.widget() as _) }
}
/// Returns how many lines are "in use" by the screen history buffer.
pub fn history_use(&self) -> i32 {
unsafe { Fl_Terminal_history_use(self.inner.widget() as _) }
}
/// Set the bottom margin
pub fn set_margin_bottom(&mut self, arg1: i32) {
unsafe { Fl_Terminal_set_margin_bottom(self.inner.widget() as _, arg1) }
}
/// Return the bottom margin
pub fn margin_bottom(&self) -> i32 {
unsafe { Fl_Terminal_margin_bottom(self.inner.widget() as _) }
}
/// Set the left margin
pub fn set_margin_left(&mut self, arg1: i32) {
unsafe { Fl_Terminal_set_margin_left(self.inner.widget() as _, arg1) }
}
/// Return the left margin
pub fn margin_left(&self) -> i32 {
unsafe { Fl_Terminal_margin_left(self.inner.widget() as _) }
}
/// Set the right margin
pub fn set_margin_right(&mut self, arg1: i32) {
unsafe { Fl_Terminal_set_margin_right(self.inner.widget() as _, arg1) }
}
/// Return the right margin
pub fn margin_right(&self) -> i32 {
unsafe { Fl_Terminal_margin_right(self.inner.widget() as _) }
}
/// Set the top margin
pub fn set_margin_top(&mut self, arg1: i32) {
unsafe { Fl_Terminal_set_margin_top(self.inner.widget() as _, arg1) }
}
/// Return the top margin
pub fn margin_top(&self) -> i32 {
unsafe { Fl_Terminal_margin_top(self.inner.widget() as _) }
}
/// Prints single ASCII char `c` at current cursor position, and advances the cursor.
/// - `c` must be ASCII, not utf-8
/// - Does not trigger redraws
pub fn print_char(&mut self, c: char) {
unsafe { Fl_Terminal_print_char(self.inner.widget() as _, c as i8) }
}
/// Prints single UTF-8 char `c` at current cursor position, and advances the cursor if the character
/// is printable. Handles ASCII and control codes (CR, LF, etc).
///
/// The character is displayed at the current cursor position
/// using the current text color/attributes.
///
/// Handles control codes and can be used to construct ANSI/XTERM escape sequences.
/// - `c` must be a single char only (whether UTF-8 or ASCII)
/// - `c` can be an ASCII character, though not as efficent as print_char()
/// - Invalid UTF-8 chars show the error character (¿) depending on show_unknown(bool).
/// - Does not trigger redraws
pub fn print_char_utf8(&mut self, c: char) {
let txt = c.to_string();
unsafe { Fl_Terminal_print_char_utf8(self.inner.widget() as _, txt.as_ptr() as _, txt.len() as _) }
}
/// Print the ASCII character `c` at the terminal's display position `(drow,dcol)`.
/// The character MUST be printable (in range 0x20 - 0x7e), and is displayed
/// using the current text color/attributes. Characters outside that range are either
/// ignored or print the error character (¿), depending on show_unknown(bool).
///
/// No range checking is done on drow,dcol:
/// - drow must be in range `0..(display_rows()-1)`
/// - dcol must be in range `0..(display_columns()-1)`
/// - Does not trigger redraws
/// - Does NOT handle control codes, ANSI or XTERM escape sequences.
pub fn put_char(&mut self, c: char, row: i32, col: i32) {
unsafe { Fl_Terminal_put_char(self.inner.widget() as _, c as i8, row, col) }
}
/// Print a single UTF-8 character len at display position `(drow,dcol)`.
/// The character is displayed using the current text color/attributes.
///
/// This is a very low level method.
/// No range checking is done on drow,dcol:
/// - drow must be in range `0..(display_rows()-1)`
/// - dcol must be in range `0..(display_columns()-1)`
/// - Does not trigger redraws
/// - Does not handle ANSI or XTERM escape sequences
/// - Invalid UTF-8 chars show the error character (¿) depending on show_unknown(bool).
pub fn put_char_utf8(&mut self, c: char, drow: i32, dcol: i32) {
let txt = c.to_string();
unsafe {
Fl_Terminal_put_char_utf8(
self.inner.widget() as _,
txt.as_ptr() as _,
txt.len() as _,
drow,
dcol,
)
}
}
/// Set the maximum rate redraw speed in floating point seconds if redraw_style() is set to RATE_LIMITED.
pub fn set_redraw_rate(&mut self, set: f32) {
unsafe { Fl_Terminal_set_redraw_rate(self.inner.widget() as _, set) }
}
/// Get max rate redraw speed in floating point seconds.
pub fn redraw_rate(&self) -> f32 {
unsafe { Fl_Terminal_redraw_rate(self.inner.widget() as _) }
}
/// Set how Fl_Terminal manages screen redrawing.
pub fn set_redraw_style(&mut self, set: RedrawStyle) {
unsafe { Fl_Terminal_set_redraw_style(self.inner.widget() as _, set as i32) }
}
/// Get the redraw style.
pub fn redraw_style(&self) -> RedrawStyle {
let result = unsafe { Fl_Terminal_redraw_style(self.inner.widget() as _) as u32 };
RedrawStyle::new(result) // Construct a style with the given value
}
/// Resets terminal to default colors, clears screen, history and mouse selection, homes cursor, resets tabstops.
pub fn reset_terminal(&self) {
unsafe { Fl_Terminal_reset_terminal(self.inner.widget() as _) }
}
/// Returns the scrollbar's actual size; actual width for vertical scrollbars, actual height for horizontal scrollbars.
pub fn scrollbar_actual_size(&self) -> i32 {
unsafe { Fl_Terminal_scrollbar_actual_size(self.inner.widget() as _) }
}
/// Get the current size of the scrollbar's trough, in pixels.
/// If this value is zero (default), this widget is using fltk's
/// master scrollbar_size() value
pub fn scrollbar_size(&self) -> i32 {
unsafe { Fl_Terminal_scrollbar_size(self.inner.widget() as _) }
}
/// Set the width of the scrollbar's trough to val, in pixels.
/// If this value is zero (default), this widget will use fltk's
/// master scrollbar_size() value
pub fn set_scrollbar_size(&mut self, val: i32) {
unsafe { Fl_Terminal_set_scrollbar_size(self.inner.widget() as _, val) }
}
/// Get mouse selection background color.
pub fn selection_bg_color(&mut self) -> Color {
Color::from_rgbi(unsafe { Fl_Terminal_selection_bg_color(self.inner.widget() as _) })
}
/// Set mouse selection background color.
pub fn set_selection_bg_color(&self, color: Color) {
unsafe { Fl_Terminal_set_selection_bg_color(self.inner.widget() as _, color.bits()) }
}
/// Get mouse selection foreground color.
pub fn selection_fg_color(&mut self) -> Color {
Color::from_rgbi(unsafe { Fl_Terminal_selection_fg_color(self.inner.widget() as _) })
}
/// Set mouse selection foreground color.
pub fn set_selection_fg_color(&self, color: Color) {
unsafe { Fl_Terminal_set_selection_fg_color(self.inner.widget() as _, color.bits()) }
}
/// Return the "show unknown" flag. if true, show unknown chars as '¿'
pub fn show_unknown(&self) -> bool {
unsafe { Fl_Terminal_show_unknown(self.inner.widget() as _) != 0 }
}
/// Set the "show unknown" flag. if true, show unknown chars as '¿' (default off)
pub fn set_show_unknown(&mut self, arg1: bool) {
unsafe { Fl_Terminal_set_show_unknown(self.inner.widget() as _, arg1 as i32) }
}
/// Set text attribute bits (underline, inverse, etc) for subsequent appends.
pub fn set_text_attrib(&mut self, arg1: Attrib) {
unsafe { Fl_Terminal_text_attrib(self.inner.widget() as _, arg1.bits() as u32) }
}
/// Set text background color to fltk color val.
/// Use this for temporary color changes, similar to <ESC>[48;2;{R};{G};{B}m
///
/// This setting does not affect the 'default' text colors used by <ESC>[0m, <ESC>c, reset_terminal(), etc.
/// To change both the current and default bg color, also use text_bg_color_default(Fl_Color).
pub fn set_text_bg_color(&self, color: Color) {
unsafe { Fl_Terminal_set_text_bg_color(self.inner.widget() as _, color.bits()) }
}
/// Get the text background color.
pub fn text_bg_color(&mut self) -> Color {
Color::from_rgbi(unsafe { Fl_Terminal_text_bg_color(self.inner.widget() as _) })
}
/// Set the default text background color used by <ESC>c, <ESC>[0m, and reset_terminal().
/// Does not affect the 'current' text fg color; use set_text_bg_color(Fl_Color) to set that.
pub fn set_text_bg_color_default(&self, color: Color) {
unsafe { Fl_Terminal_set_text_bg_color_default(self.inner.widget() as _, color.bits()) }
}
/// Return the default text background color.
pub fn text_bg_color_default(&mut self) -> Color {
Color::from_rgbi(unsafe { Fl_Terminal_text_bg_color_default(self.inner.widget() as _) })
}
/// Sets the background text color as one of the 8 'xterm color' values.
///
/// This will be the background color used for all newly printed text, similar to the <ESC>[#m escape sequence, where # is between 40 and 47.
///
/// This color will be reset to the default bg color if reset_terminal() is called, or by <ESC>c, <ESC>[0m, etc.
///
/// The xterm color intensity values can be influenced by the Dim/Bold/Normal modes (which can be set with e.g. <ESC>[1m, textattrib(), etc), so the actual RGB values of these colors allow room for Dim/Bold to influence their brightness. For instance, "Normal Red" is not full brightness to allow "Bold Red" to be brighter. This goes for all colors except 'Black', which is not influenced by Dim or Bold; Black is always Black.
///
/// These background colors are slightly dimmer than the corresponding xterm foregroumd colors.
///
/// The 8 color xterm values are:
/// 0 = Black, 1 = Red, 2 = Green, 3 = Yellow, 4 = Blue,5 = Magenta, 6 = Cyan, 7 = White
pub fn set_text_bg_color_xterm(&self, color: XtermColor) {
unsafe { Fl_Terminal_set_text_bg_color_xterm(self.inner.widget() as _, color as u8) }
}
/// Set text foreground drawing color to fltk color val.
/// Use this for temporary color changes, similar to <ESC>[38;2;{R};{G};{B}m
///
/// This setting does not affect the 'default' text colors used by <ESC>[0m, <ESC>c, reset_terminal(), etc.
/// To change both the current and default fg color, also use textfgcolor_default(Fl_Color)
pub fn set_text_fg_color(&self, color: Color) {
unsafe { Fl_Terminal_set_text_fg_color(self.inner.widget() as _, color.bits()) }
}
/// Get the text foreground color.
pub fn text_fg_color(&mut self) -> Color {
Color::from_rgbi(unsafe { Fl_Terminal_text_fg_color(self.inner.widget() as _) })
}
/// Set the default text foreground color used by <ESC>c, <ESC>[0m, and reset_terminal().
/// Does not affect the 'current' text fg color; use set_text_fg_color(Fl_Color) to set that.
pub fn set_text_fg_color_default(&self, color: Color) {
unsafe { Fl_Terminal_set_text_fg_color_default(self.inner.widget() as _, color.bits()) }
}
/// Return the default text foreground color.
pub fn text_fg_color_default(&mut self) -> Color {
Color::from_rgbi(unsafe { Fl_Terminal_text_fg_color_default(self.inner.widget() as _) })
}
/// Sets the foreground text color as one of the 8 'xterm color' values.
///
/// This will be the foreground color used for all newly printed text, similar to the <ESC>[#m escape sequence, where # is between 30 and 37.
///
/// This color will be reset to the default bg color if reset_terminal() is called, or by <ESC>c, <ESC>[0m, etc.
///
/// The xterm color intensity values can be influenced by the Dim/Bold/Normal modes (which can be set with e.g. <ESC>[1m, textattrib(), etc), so the actual RGB values of these colors allow room for Dim/Bold to influence their brightness. For instance, "Normal Red" is not full brightness to allow "Bold Red" to be brighter. This goes for all colors except 'Black', which is not influenced by Dim or Bold; Black is always Black.
///
/// The 8 color xterm values are:
/// 0 = Black, 1 = Red, 2 = Green, 3 = Yellow, 4 = Blue,5 = Magenta, 6 = Cyan, 7 = White
pub fn set_text_fg_color_xterm(&self, color: XtermColor) {
unsafe { Fl_Terminal_set_text_fg_color_xterm(self.inner.widget() as _, color as u8) }
}
/// Get the text font
pub fn text_font(&mut self) -> Font {
Font::by_index(unsafe { Fl_Terminal_text_font(self.inner.widget() as _) } as usize)
}
/// Sets the font used for all text displayed in the terminal.
/// This affects all existing text (in display and history) as well as any newly printed text.
/// Only monospace fonts are recommended.
pub fn set_text_font(&self, font: Font) {
unsafe { Fl_Terminal_set_text_font(self.inner.widget() as _, font.bits()) }
}
/// Gets the text size
pub fn text_size(&mut self) -> i32 {
unsafe { Fl_Terminal_text_size(self.inner.widget() as _) }
}
/// Sets the font size used for all text displayed in the terminal.
/// This affects all existing text (in display and history) as well as any newly printed text.
/// Changing this will affect the display_rows() and display_columns().
pub fn set_text_size(&self, val: i32) {
unsafe { Fl_Terminal_set_text_size(self.inner.widget() as _, val) }
}
}
}