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
pub use crate::enums::*; pub(crate) use crate::utils::*; use std::convert::From; use std::{fmt, io}; /// Error types returned by fltk-rs + wrappers of std::io errors #[derive(Debug)] pub enum FltkError { IoError(io::Error), NullError(std::ffi::NulError), Internal(FltkErrorKind), EnvVarError(std::env::VarError), Unknown(String), } unsafe impl Send for FltkError {} unsafe impl Sync for FltkError {} /// Error kinds enum for FltkError #[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)] pub enum FltkErrorKind { FailedToRun, FailedToLock, FailedToSetScheme, FailedOperation, ResourceNotFound, ImageFormatError, TableError, PrintError, } impl std::error::Error for FltkError { fn source(&self) -> Option<&(dyn std::error::Error + 'static)> { match self { FltkError::IoError(err) => Some(err), FltkError::NullError(err) => Some(err), _ => None, } } } impl fmt::Display for FltkError { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { FltkError::IoError(ref err) => err.fmt(f), FltkError::NullError(ref err) => err.fmt(f), FltkError::Internal(ref err) => write!(f, "An internal error occured {:?}", err), FltkError::EnvVarError(ref err) => write!(f, "An env var error occured {:?}", err), FltkError::Unknown(ref err) => write!(f, "An unknown error occurred {:?}", err), } } } impl From<io::Error> for FltkError { fn from(err: io::Error) -> FltkError { FltkError::IoError(err) } } impl From<std::ffi::NulError> for FltkError { fn from(err: std::ffi::NulError) -> FltkError { FltkError::NullError(err) } } impl From<std::env::VarError> for FltkError { fn from(err: std::env::VarError) -> FltkError { FltkError::EnvVarError(err) } } /// Defines the methods implemented by all widgets pub unsafe trait WidgetExt { /// Set to position x, y fn set_pos(&mut self, x: i32, y: i32); /// Set to dimensions width and height fn set_size(&mut self, width: i32, height: i32); /// Sets the widget's label fn set_label(&mut self, title: &str); /// Redraws a widget, necessary for resizing and changing positions fn redraw(&mut self); /// Shows the widget fn show(&mut self); /// Hides the widget fn hide(&mut self); /// Returns the x coordinate of the widget fn x(&self) -> i32; /// Returns the y coordinate of the widget fn y(&self) -> i32; /// Returns the width of the widget fn width(&self) -> i32; /// Returns the height of the widget fn height(&self) -> i32; /// Returns the label of the widget fn label(&self) -> String; /// Measures the label's width and height fn measure_label(&self) -> (i32, i32); /// transforms a widget to a base Fl_Widget, for internal use /// # Safety /// Can return multiple mutable pointers to the same widget unsafe fn as_widget_ptr(&self) -> *mut fltk_sys::widget::Fl_Widget; /// Initialize to position x, y, (should only be called on initialization) fn with_pos(self, x: i32, y: i32) -> Self where Self: Sized; /// Initialilze to dimensions width and height, (should only be called on initialization) fn with_size(self, width: i32, height: i32) -> Self where Self: Sized; /// Initialize with label/title, (should only be called on initialization) fn with_label(self, title: &str) -> Self where Self: Sized; /// Sets the initial alignment of the widget, (should only be called on initialization) fn with_align(self, align: Align) -> Self where Self: Sized; /// Positions the widget below w, the size of w should be known fn below_of<W: WidgetExt>(self, w: &W, padding: i32) -> Self where Self: Sized; /// Positions the widget above w, the size of w should be known fn above_of<W: WidgetExt>(self, w: &W, padding: i32) -> Self where Self: Sized; /// Positions the widget to the right of w, the size of w should be known fn right_of<W: WidgetExt>(self, w: &W, padding: i32) -> Self where Self: Sized; /// Positions the widget to the left of w, the size of w should be known fn left_of<W: WidgetExt>(self, w: &W, padding: i32) -> Self where Self: Sized; /// Positions the widget to the center of w, the size of w should be known fn center_of<W: WidgetExt>(self, w: &W) -> Self where Self: Sized; /// Takes the size of w, the size of w should be known fn size_of<W: WidgetExt>(self, w: &W) -> Self where Self: Sized; /// Checks whether the self widget is inside another widget fn inside<W: WidgetExt>(&self, wid: &W) -> bool where Self: Sized; /// Returns the widget type when applicable fn get_type<T: WidgetType>(&self) -> T where Self: Sized; /// Sets the widget type fn set_type<T: WidgetType>(&mut self, typ: T) where Self: Sized; /// Sets the image of the widget fn set_image<I: ImageExt>(&mut self, image: Option<I>) where Self: Sized; /// Gets the image associated with the widget fn image(&self) -> Option<Box<dyn ImageExt>> where Self: Sized; /// Sets the image of the widget fn set_deimage<I: ImageExt>(&mut self, image: Option<I>) where Self: Sized; /// Gets the image associated with the widget fn deimage(&self) -> Option<Box<dyn ImageExt>> where Self: Sized; /// Sets the callback when the widget is triggered (clicks for example) fn set_callback<F: FnMut() + 'static>(&mut self, cb: F) where Self: Sized; /// Sets the callback when the widget is triggered (clicks for example) /// takes the widget as a closure argument fn set_callback2<F: FnMut(&mut Self) + 'static>(&mut self, cb: F) where Self: Sized; /// Emits a message on callback using a sender fn emit<T: 'static + Copy + Send + Sync>(&mut self, sender: crate::app::Sender<T>, msg: T) where Self: Sized; /// Activates the widget fn activate(&mut self); /// Deactivates the widget fn deactivate(&mut self); /// Redraws the label of the widget fn redraw_label(&mut self); /// Resizes and/or moves the widget, takes x, y, width and height fn resize(&mut self, x: i32, y: i32, width: i32, height: i32); /// Returns the tooltip text fn tooltip(&self) -> Option<String>; /// Sets the tooltip text fn set_tooltip(&mut self, txt: &str); /// Returns the widget color fn color(&self) -> Color; /// Sets the widget's color fn set_color(&mut self, color: Color); /// Returns the widget label's color fn label_color(&self) -> Color; /// Sets the widget label's color fn set_label_color(&mut self, color: Color); /// Returns the widget label's font fn label_font(&self) -> Font; /// Sets the widget label's font fn set_label_font(&mut self, font: Font); /// Returns the widget label's size fn label_size(&self) -> i32; /// Sets the widget label's size fn set_label_size(&mut self, sz: i32); /// Returns the widget label's type fn label_type(&self) -> LabelType; /// Sets the widget label's type fn set_label_type(&mut self, typ: LabelType); /// Returns the widget's frame type fn frame(&self) -> FrameType; /// Sets the widget's frame type fn set_frame(&mut self, typ: FrameType); /// Returns whether the widget was changed fn changed(&self) -> bool; /// Mark the widget as changed fn set_changed(&mut self); /// Clears the changed status of the widget fn clear_changed(&mut self); /// Returns the alignment of the widget fn align(&self) -> Align; /// Sets the alignment of the widget fn set_align(&mut self, align: Align); /// Returns the parent of the widget fn parent(&self) -> Option<Box<dyn GroupExt>>; /// Gets the selection color of the widget fn selection_color(&mut self) -> Color; /// Sets the selection color of the widget fn set_selection_color(&mut self, color: Color); /// Runs the already registered callback fn do_callback(&mut self); /// Returns the direct window holding the widget fn window(&self) -> Option<Box<dyn WindowExt>>; /// Returns the topmost window holding the widget fn top_window(&self) -> Option<Box<dyn WindowExt>>; /// Checks whether a widget is capable of taking events fn takes_events(&self) -> bool; /// Make the widget take focus fn take_focus(&mut self) -> Result<(), FltkError>; /// Set the widget to have visible focus fn set_visible_focus(&mut self); /// Clear visible focus fn clear_visible_focus(&mut self); /// Set the visible focus using a flag fn visible_focus(&mut self, v: bool); /// Return whether the widget has visible focus fn has_visible_focus(&mut self) -> bool; /// Check if a widget was deleted fn was_deleted(&self) -> bool; /// Deletes widgets and their children. fn delete(wid: Self) where Self: Sized; /// Return whether the widget was damaged fn damage(&self) -> bool; /// Signal the widget as damaged and it should be redrawn in the next event loop cycle fn set_damage(&mut self, flag: bool); /// Clear the damaged flag fn clear_damage(&mut self); /// Sets the default callback trigger for a widget fn set_trigger(&mut self, trigger: CallbackTrigger); /// Return the callback trigger fn trigger(&self) -> u32; /// Return the widget as a window if it's a window fn as_window(&self) -> Option<Box<dyn WindowExt>>; /// Return the widget as a group widget if it's a group widget fn as_group(&self) -> Option<Box<dyn GroupExt>>; /// INTERNAL: Retakes ownership of the user callback data /// # Safety /// Can return multiple mutable references to the user_data unsafe fn user_data(&self) -> Option<Box<dyn FnMut()>>; /// Upcast a WidgetExt to a Widget fn into_widget<W: WidgetBase>(&self) -> W where Self: Sized; } /// Defines the extended methods implemented by all widgets pub unsafe trait WidgetBase: WidgetExt { /// Creates a new widget, takes an x, y coordinates, as well as a width and height, plus a title /// # Arguments /// * `x` - The x coordinate in the screen /// * `y` - The y coordinate in the screen /// * `width` - The width of the widget /// * `heigth` - The height of the widget /// * `title` - The title or label of the widget fn new(x: i32, y: i32, width: i32, height: i32, title: &str) -> Self; /// Creates a default and zero initialized widget fn default() -> Self; /// transforms a widget pointer to a Widget, for internal use /// # Safety /// The pointer must be valid unsafe fn from_widget_ptr(ptr: *mut fltk_sys::widget::Fl_Widget) -> Self; /// Get a widget from base widget /// # Safety /// The underlying object must be valid unsafe fn from_widget<W: WidgetExt>(w: W) -> Self; /// Set a custom handler, where events are managed manually, akin to Fl_Widget::handle(int) /// Handled or ignored events shoult return true, unhandled events should return false fn handle<F: FnMut(Event) -> bool + 'static>(&mut self, cb: F); /// Set a custom handler, where events are managed manually, akin to Fl_Widget::handle(int) /// Handled or ignored events shoult return true, unhandled events should return false /// takes the widget as a closure argument fn handle2<F: FnMut(&mut Self, Event) -> bool + 'static>(&mut self, cb: F); /// Set a custom draw method fn draw<F: FnMut() + 'static>(&mut self, cb: F); /// Set a custom draw method /// takes the widget as a closure argument fn draw2<F: FnMut(&mut Self) + 'static>(&mut self, cb: F); /// INTERNAL: Retrieve the draw data /// # Safety /// Can return multiple mutable references to the draw_data unsafe fn draw_data(&mut self) -> Option<Box<dyn FnMut()>>; /// INTERNAL: Retrieve the handle data /// # Safety /// Can return multiple mutable references to the handle_data unsafe fn handle_data(&mut self) -> Option<Box<dyn FnMut(Event) -> bool>>; } /// Defines the methods implemented by all button widgets pub unsafe trait ButtonExt: WidgetExt { /// Gets the shortcut associated with a button fn shortcut(&self) -> Shortcut; /// Sets the shortcut associated with a button fn set_shortcut(&mut self, shortcut: Shortcut); /// Clears the value of the button. /// Useful for round, radio, light, toggle and check buttons fn clear(&mut self); /// Returns whether a button is set or not /// Useful for round, radio, light, toggle and check buttons fn is_set(&self) -> bool; /// Sets whether a button is set or not /// Useful for round, radio, light, toggle and check buttons fn set(&mut self, flag: bool); } /// Defines the methods implemented by all group widgets pub unsafe trait GroupExt: WidgetExt { /// Begins a group, used for widgets implementing the group trait fn begin(&self); /// Ends a group, used for widgets implementing the group trait fn end(&self); /// Clear a group from all widgets fn clear(&mut self); /// Return the number of children in a group fn children(&self) -> u32; /// Return child widget by index fn child(&self, idx: u32) -> Option<Box<dyn WidgetExt>>; /// Find a widget within a group and return its index fn find<W: WidgetExt>(&self, widget: &W) -> u32 where Self: Sized; /// Add a widget to a group fn add<W: WidgetExt>(&mut self, widget: &W) where Self: Sized; /// Insert a widget to a group at a certain index fn insert<W: WidgetExt>(&mut self, widget: &W, index: u32) where Self: Sized; /// Remove a widget from a group, but does not delete it fn remove<W: WidgetExt>(&mut self, widget: &W) where Self: Sized; /// Make the passed widget resizable fn resizable<W: WidgetExt>(&self, widget: &W) where Self: Sized; /// Make the window resizable, should be called before ```show``` fn make_resizable(&mut self, val: bool); } /// Defines the methods implemented by all window widgets pub unsafe trait WindowExt: GroupExt { /// Positions the window to the center of the screen fn center_screen(self) -> Self where Self: Sized; /// Makes a window modal, should be called before ```show``` fn make_modal(&mut self, val: bool); /// Makes a window fullscreen fn fullscreen(&mut self, val: bool); /// Makes the window current fn make_current(&mut self); /// Returns the icon of the window fn icon(&self) -> Option<Box<dyn ImageExt>>; /// Sets the windows icon fn set_icon<T: ImageExt>(&mut self, image: Option<T>) where Self: Sized; /// Sets the cursor style within the window /// Needs to be called after the window is shown fn set_cursor(&mut self, cursor: Cursor); /// Returns whether a window is shown fn shown(&self) -> bool; /// Sets whether the window has a border fn set_border(&mut self, flag: bool); /// Returns whether a window has a border fn border(&self) -> bool; /// Frees the position of the window fn free_position(&mut self); /// Get the raw system handle of the window fn raw_handle(&self) -> crate::window::RawHandle; /// Set the window associated with a raw handle. /// RawHandle is a void pointer to: (Windows: HWND, X11: Xid (u64), MacOS: NSWindow) /// # Safety /// The data must be valid and is OS-dependent. The window must be shown. unsafe fn set_raw_handle(&mut self, handle: crate::window::RawHandle); /// Get the graphical draw region of the window fn region(&self) -> crate::draw::Region; /// Set the graphical draw region of the window /// # Safety /// The data must be valid. unsafe fn set_region(&mut self, region: crate::draw::Region); /// Iconifies the window fn iconize(&mut self); /// Returns whether the window is fullscreen or not fn fullscreen_active(&self) -> bool; /// Returns the decorated width fn decorated_w(&self) -> i32; /// Returns the decorated height fn decorated_h(&self) -> i32; } /// Defines the methods implemented by all input and output widgets pub unsafe trait InputExt: WidgetExt { /// Returns the value inside the input/output widget fn value(&self) -> String; /// Sets the value inside an input/output widget fn set_value(&self, val: &str); /// Returns the maximum size (in bytes) accepted by an input/output widget fn maximum_size(&self) -> u32; /// Sets the maximum size (in bytes) accepted by an input/output widget fn set_maximum_size(&mut self, val: u32); /// Returns the index position inside an input/output widget fn position(&self) -> u32; /// Sets the index postion inside an input/output widget fn set_position(&mut self, val: u32) -> Result<(), FltkError>; /// Returns the index mark inside an input/output widget fn mark(&self) -> u32; /// Sets the index mark inside an input/output widget fn set_mark(&mut self, val: u32) -> Result<(), FltkError>; /// Replace content with a &str fn replace(&mut self, beg: u32, end: u32, val: &str) -> Result<(), FltkError>; /// Insert a &str fn insert(&mut self, txt: &str) -> Result<(), FltkError>; /// Append a &str fn append(&mut self, txt: &str) -> Result<(), FltkError>; /// Copy the value within the widget fn copy(&mut self) -> Result<(), FltkError>; /// Undo changes fn undo(&mut self) -> Result<(), FltkError>; /// Cut the value within the widget fn cut(&mut self) -> Result<(), FltkError>; /// Return the text font fn text_font(&self) -> Font; /// Sets the text font fn set_text_font(&mut self, font: Font); /// Return the text color fn text_color(&self) -> Color; /// Sets the text color fn set_text_color(&mut self, color: Color); /// Return the text size fn text_size(&self) -> u32; /// Sets the text size fn set_text_size(&mut self, sz: u32); /// Returns whether the input/output widget is readonly fn readonly(&self) -> bool; /// Set readonly status of the input/output widget fn set_readonly(&mut self, val: bool); /// Return whether text is wrapped inside an input/output widget fn wrap(&self) -> bool; /// Set whether text is wrapped inside an input/output widget fn set_wrap(&mut self, val: bool); } /// Defines the methods implemented by all menu widgets pub unsafe trait MenuExt: WidgetExt { /// Get a menu item by name fn find_item(&self, name: &str) -> Option<crate::menu::MenuItem>; /// Set selected item fn set_item(&mut self, item: &crate::menu::MenuItem) -> bool; /// Find an item's index by its label fn find_index(&self, label: &str) -> u32; /// Return the text font fn text_font(&self) -> Font; /// Sets the text font fn set_text_font(&mut self, c: Font); /// Return the text size fn text_size(&self) -> u32; /// Sets the text size fn set_text_size(&mut self, c: u32); /// Return the text color fn text_color(&self) -> Color; /// Sets the text color fn set_text_color(&mut self, c: Color); /// Add a menu item along with its callback /// The characters "&", "/", "\\", and "_" are treated as special characters in the label string. The "&" character specifies that the following character is an accelerator and will be underlined. /// The "\\" character is used to escape the next character in the string. Labels starting with the "_" character cause a divider to be placed after that menu item. fn add<F: FnMut() + 'static>( &mut self, label: &str, shortcut: Shortcut, flag: crate::menu::MenuFlag, cb: F, ); /// Add a menu item along with its callback /// The characters "&", "/", "\\", and "_" are treated as special characters in the label string. The "&" character specifies that the following character is an accelerator and will be underlined. /// The "\\" character is used to escape the next character in the string. Labels starting with the "_" character cause a divider to be placed after that menu item. /// Takes the menu item as a closure argument fn add2<F: FnMut(&mut Self) + 'static>( &mut self, name: &str, shortcut: Shortcut, flag: crate::menu::MenuFlag, cb: F, ); /// Inserts a menu item at an index along with its callback /// The characters "&", "/", "\\", and "_" are treated as special characters in the label string. The "&" character specifies that the following character is an accelerator and will be underlined. /// The "\\" character is used to escape the next character in the string. Labels starting with the "_" character cause a divider to be placed after that menu item. fn insert<F: FnMut() + 'static>( &mut self, idx: u32, label: &str, shortcut: Shortcut, flag: crate::menu::MenuFlag, cb: F, ); /// Inserts a menu item at an index along with its callback /// The characters "&", "/", "\\", and "_" are treated as special characters in the label string. The "&" character specifies that the following character is an accelerator and will be underlined. /// The "\\" character is used to escape the next character in the string. Labels starting with the "_" character cause a divider to be placed after that menu item. /// Takes the menu item as a closure argument fn insert2<F: FnMut(&mut Self) + 'static>( &mut self, idx: u32, name: &str, shortcut: Shortcut, flag: crate::menu::MenuFlag, cb: F, ); /// Add a menu item along with an emit (sender and message) /// The characters "&", "/", "\\", and "_" are treated as special characters in the label string. The "&" character specifies that the following character is an accelerator and will be underlined. /// The "\\" character is used to escape the next character in the string. Labels starting with the "_" character cause a divider to be placed after that menu item. fn add_emit<T: 'static + Copy + Send + Sync>( &mut self, label: &str, shortcut: Shortcut, flag: crate::menu::MenuFlag, sender: crate::app::Sender<T>, msg: T, ); /// Inserts a menu item along with an emit (sender and message) /// The characters "&", "/", "\\", and "_" are treated as special characters in the label string. The "&" character specifies that the following character is an accelerator and will be underlined. /// The "\\" character is used to escape the next character in the string. Labels starting with the "_" character cause a divider to be placed after that menu item. fn insert_emit<T: 'static + Copy + Send + Sync>( &mut self, idx: u32, label: &str, shortcut: Shortcut, flag: crate::menu::MenuFlag, sender: crate::app::Sender<T>, msg: T, ); /// Remove a menu item by index fn remove(&mut self, idx: u32); /// Adds a simple text option to the Choice and MenuButton widgets /// The characters "&", "/", "\\", "|", and "_" are treated as special characters in the label string. The "&" character specifies that the following character is an accelerator and will be underlined. /// The "\\" character is used to escape the next character in the string. Labels starting with the "_" character cause a divider to be placed after that menu item. fn add_choice(&mut self, text: &str); /// Gets the user choice from the Choice and MenuButton widgets fn choice(&self) -> Option<String>; /// Get index into menu of the last item chosen, returns -1 if no item was chosen fn value(&self) -> i32; /// Set index into menu of the last item chosen,return true if the new value is different than the old one fn set_value(&mut self, v: i32) -> bool; /// Clears the items in a menu, effectively deleting them. fn clear(&mut self); /// Clears a submenu by index, failure return FltkErrorKind::FailedOperation fn clear_submenu(&mut self, idx: u32) -> Result<(), FltkError>; /// Clears the items in a menu, effectively deleting them, and recursively force-cleans capturing callbacks /// # Safety /// Deletes user_data and any captured objects in the callback unsafe fn unsafe_clear(&mut self); /// Clears a submenu by index, failure return FltkErrorKind::FailedOperation. Also recursively force-cleans capturing callbacks /// # Safety /// Deletes user_data and any captured objects in the callback unsafe fn unsafe_clear_submenu(&mut self, idx: u32) -> Result<(), FltkError>; /// Get the size of the menu widget fn size(&self) -> u32; /// Get the text label of the menu item at index idx fn text(&self, idx: u32) -> Option<String>; /// Get the menu item at an index fn at(&self, idx: u32) -> Option<crate::menu::MenuItem>; /// Set the mode of a menu item by index and flag fn mode(&self, idx: u32) -> crate::menu::MenuFlag; /// Get the mode of a menu item fn set_mode(&mut self, idx: u32, flag: crate::menu::MenuFlag); } /// Defines the methods implemented by all valuator widgets pub unsafe trait ValuatorExt: WidgetExt { /// Set bounds of a valuator fn set_bounds(&mut self, a: f64, b: f64); /// Get the minimum bound of a valuator fn minimum(&self) -> f64; /// Set the minimum bound of a valuator fn set_minimum(&mut self, a: f64); /// Get the maximum bound of a valuator fn maximum(&self) -> f64; /// Set the maximum bound of a valuator fn set_maximum(&mut self, a: f64); /// Set the range of a valuator fn set_range(&mut self, a: f64, b: f64); /// Set change step of a valuator fn set_step(&mut self, a: f64, b: i32); /// Get change step of a valuator fn step(&self) -> f64; /// Set the precision of a valuator fn set_precision(&mut self, digits: i32); /// Get the value of a valuator fn value(&self) -> f64; /// Set the value of a valuator fn set_value(&mut self, arg2: f64); /// Set the format of a valuator fn format(&mut self, arg2: &str) -> Result<(), FltkError>; /// Round the valuator fn round(&self, arg2: f64) -> f64; /// Clamp the valuator fn clamp(&self, arg2: f64) -> f64; /// Increment the valuator fn increment(&mut self, arg2: f64, arg3: i32) -> f64; } /// Defines the methods implemented by TextDisplay and TextEditor pub unsafe trait DisplayExt: WidgetExt { /// Get the associated TextBuffer fn buffer(&self) -> Option<crate::text::TextBuffer>; /// Sets the associated TextBuffer fn set_buffer(&mut self, buffer: Option<crate::text::TextBuffer>); /// Get the associated style TextBuffer fn style_buffer(&self) -> Option<crate::text::TextBuffer>; /// Return the text font fn text_font(&self) -> Font; /// Sets the text font fn set_text_font(&mut self, font: Font); /// Return the text color fn text_color(&self) -> Color; /// Sets the text color fn set_text_color(&mut self, color: Color); /// Return the text size fn text_size(&self) -> u32; /// Sets the text size fn set_text_size(&mut self, sz: u32); /// Scroll down the Display widget fn scroll(&mut self, top_line_num: u32, horiz_offset: u32); /// Insert into Display widget fn insert(&self, text: &str); /// Set the insert position fn set_insert_position(&mut self, new_pos: u32); /// Return the insert position fn insert_position(&self) -> u32; /// Gets the x and y positions of the cursor fn position_to_xy(&self, pos: u32) -> (u32, u32); /// Counts the lines from start to end fn count_lines(&self, start: u32, end: u32, is_line_start: bool) -> u32; /// Moves the cursor right fn move_right(&mut self) -> Result<(), FltkError>; /// Moves the cursor left fn move_left(&mut self) -> Result<(), FltkError>; /// Moves the cursor up fn move_up(&mut self) -> Result<(), FltkError>; /// Moves the cursor down fn move_down(&mut self) -> Result<(), FltkError>; /// Shows/hides the cursor fn show_cursor(&mut self, val: bool); /// Sets the style of the text widget fn set_highlight_data( &mut self, style_buffer: crate::text::TextBuffer, entries: Vec<crate::text::StyleTableEntry>, ); /// Sets the cursor style fn set_cursor_style(&mut self, style: TextCursor); /// Sets the cursor color fn set_cursor_color(&mut self, color: Color); /// Sets the scrollbar width fn set_scrollbar_width(&mut self, width: i32); /// Sets the scrollbar size in pixels fn set_scrollbar_size(&mut self, size: u32); /// Sets the scrollbar alignment fn set_scrollbar_align(&mut self, align: Align); /// Returns the cursor style fn cursor_style(&self) -> TextCursor; /// Returns the cursor color fn cursor_color(&self) -> Color; /// Returns the scrollback width fn scrollbar_width(&self) -> u32; /// Returns the scrollbar size in pixels fn scrollbar_size(&self) -> u32; /// Returns the scrollbar alignment fn scrollbar_align(&self) -> Align; /// Returns the beginning of the line from the current position fn line_start(&self, pos: u32) -> u32; /// Returns the ending of the line from the current position fn line_end(&self, start_pos: u32, is_line_start: bool) -> u32; /// Skips lines from start_pos fn skip_lines(&mut self, start_pos: u32, lines: u32, is_line_start: bool) -> u32; /// Rewinds the lines fn rewind_lines(&mut self, start_pos: u32, lines: u32) -> u32; /// Goes to the next word fn next_word(&mut self); /// Goes to the previous word fn previous_word(&mut self); /// Returns the position of the start of the word, relative to the current position fn word_start(&self, pos: u32) -> u32; /// Returns the position of the end of the word, relative to the current position fn word_end(&self, pos: u32) -> u32; /// Convert an x pixel position into a column number. fn x_to_col(&self, x: f64) -> f64; /// Convert a column number into an x pixel position fn col_to_x(&self, col: f64) -> f64; /// Sets the linenumber width fn set_linenumber_width(&mut self, w: i32); /// Gets the linenumber width fn linenumber_width(&self) -> i32; /// Sets the linenumber font fn set_linenumber_font(&mut self, font: Font); /// Gets the linenumber font fn linenumber_font(&self) -> Font; /// Sets the linenumber size fn set_linenumber_size(&mut self, size: u32); /// Gets the linenumber size fn linenumber_size(&self) -> u32; /// Sets the linenumber foreground color fn set_linenumber_fgcolor(&mut self, color: Color); /// Gets the linenumber foreground color fn linenumber_fgcolor(&self) -> Color; /// Sets the linenumber background color fn set_linenumber_bgcolor(&mut self, color: Color); /// Gets the linenumber background color fn linenumber_bgcolor(&self) -> Color; /// Sets the linenumber alignment fn set_linenumber_align(&mut self, align: Align); /// Gets the linenumber alignment fn linenumber_align(&self) -> Align; /// Checks whether a pixel is within a text selection fn in_selection(&self, x: i32, y: i32) -> bool; /// Sets the wrap mode of the Display widget /// If the wrap mode is AtColumn, wrap_margin is the column. /// If the wrap mode is AtPixel, wrap_margin is the pixel /// For more info: https://www.fltk.org/doc-1.4/classFl__Text__Display.html#ab9378d48b949f8fc7da04c6be4142c54 fn wrap_mode(&mut self, wrap: crate::text::WrapMode, wrap_margin: i32); /// Correct a column number based on an unconstrained position fn wrapped_column(&self, row: i32, column: i32) -> i32; /// Correct a row number from an unconstrained position fn wrapped_row(&self, row: i32) -> i32; } /// Defines the methods implemented by all browser types pub unsafe trait BrowserExt: WidgetExt { /// Removes the specified line /// Lines start at 1 fn remove(&mut self, line: u32); /// Adds an item fn add(&mut self, item: &str); /// Inserts an item at an index /// Lines start at 1 fn insert(&mut self, line: u32, item: &str); /// Moves an item /// Lines start at 1 fn move_item(&mut self, to: u32, from: u32); /// Swaps 2 items /// Lines start at 1 fn swap(&mut self, a: u32, b: u32); /// Clears the browser widget fn clear(&mut self); /// Returns the number of items fn size(&self) -> u32; /// Set the number of items fn set_size(&mut self, w: i32, h: i32); /// Select an item at the specified line /// Lines start at 1 fn select(&mut self, line: u32); /// Returns whether the item is selected /// Lines start at 1 fn selected(&self, line: u32) -> bool; /// Returns the text of the selected item /// Lines start at 1 fn text(&self, line: u32) -> Option<String>; /// Sets the text of the selected item /// Lines start at 1 fn set_text(&mut self, line: u32, txt: &str); /// Load a file fn load<P: AsRef<std::path::Path>>(&mut self, path: P) -> Result<(), FltkError>; /// Return the text size fn text_size(&self) -> u32; /// Sets the text size /// Lines start at 1 fn set_text_size(&mut self, sz: u32); /// Sets the icon for browser elements /// Lines start at 1 fn set_icon<Img: ImageExt>(&mut self, line: u32, image: Option<Img>); /// Returns the icon of a browser element /// Lines start at 1 fn icon(&self, line: u32) -> Option<Box<dyn ImageExt>>; /// Removes the icon of a browser element /// Lines start at 1 fn remove_icon(&mut self, line: u32); /// Scrolls the browser so the top item in the browser is showing the specified line /// Lines start at 1 fn topline(&mut self, line: u32); /// Scrolls the browser so the bottom item in the browser is showing the specified line /// Lines start at 1 fn bottomline(&mut self, line: u32); /// Scrolls the browser so the middle item in the browser is showing the specified line /// Lines start at 1 fn middleline(&mut self, line: u32); /// Gets the current format code prefix character, which by default is '\@' /// More info here: https://www.fltk.org/doc-1.3/classFl__Browser.html#a129dca59d64baf166503ba59341add69 fn format_char(&self) -> char; /// Sets the current format code prefix character to \p c. The default prefix is '\@ /// c should be ascii fn set_format_char(&mut self, c: char); /// Gets the current column separator character. The default is '\t' fn column_char(&self) -> char; /// Sets the column separator to c. This will only have an effect if you also use set_column_widths() /// c should be ascii fn set_column_char(&mut self, c: char); /// Gets the current column width array fn column_widths(&self) -> Vec<i32>; /// Sets the current column width array fn set_column_widths(&mut self, arr: &'static [i32]); /// Returns whether a certain line is displayed fn displayed(&self, line: u32) -> bool; /// Makes a specified line visible fn make_visible(&mut self, line: u32); /// Gets the vertical scroll position of the list as a pixel position fn position(&self) -> u32; /// Sets the vertical scroll position of the list as a pixel position fn set_position(&mut self, pos: u32); /// Gets the horizontal scroll position of the list as a pixel position fn hposition(&self) -> u32; /// Sets the horizontal scroll position of the list as a pixel position fn set_hposition(&mut self, pos: u32); /// Returns the type of scrollbar associated with the browser fn has_scrollbar(&self) -> crate::browser::BrowserScrollbar; /// Sets the type of scrollbar associated with the browser fn set_has_scrollbar(&mut self, mode: crate::browser::BrowserScrollbar); /// Gets the scrollbar size fn scrollbar_size(&self) -> u32; /// Sets the scrollbar size fn set_scrollbar_size(&mut self, new_size: u32); /// Gets the scrollbar width fn scrollbar_width(&self) -> i32; /// Sets the scrollbar width fn set_scrollbar_width(&mut self, width: i32); /// Sorts the items of the browser fn sort(&mut self); /// Returns the vertical scrollbar fn scrollbar(&self) -> Box<dyn ValuatorExt>; /// Returns the horizontal scrollbar fn hscrollbar(&self) -> Box<dyn ValuatorExt>; } /// Defines the methods implemented by table types pub unsafe trait TableExt: GroupExt { /// Clears the table fn clear(&mut self); /// Sets the table frame, table_box fn set_table_frame(&mut self, frame: FrameType); /// Gets the table frame, table box fn table_frame(&self) -> FrameType; /// Sets the number of rows fn set_rows(&mut self, val: u32); /// Gets the number of rows fn rows(&self) -> u32; /// Sets the number of columns fn set_cols(&mut self, val: u32); /// Gets the number of columns fn cols(&self) -> u32; /// Returns the range of row and column numbers for all visible and partially visible cells in the table. fn visible_cells(&mut self, r1: &mut i32, r2: &mut i32, c1: &mut i32, c2: &mut i32); /// Returns whether the resize is interactive fn is_interactive_resize(&self) -> bool; /// Returns whether a row is resizable fn row_resize(&self) -> bool; /// Sets a row to be resizable fn set_row_resize(&mut self, flag: bool); /// Returns whether a column is resizable fn col_resize(&self) -> bool; /// Sets a column to be resizable fn set_col_resize(&mut self, flag: bool); /// Returns the current column minimum resize value. fn col_resize_min(&self) -> u32; /// Sets the current column minimum resize value. fn set_col_resize_min(&mut self, val: u32); /// Returns the current row minimum resize value. fn row_resize_min(&self) -> u32; /// Sets the current row minimum resize value. fn set_row_resize_min(&mut self, val: u32); /// Returns if row headers are enabled or not fn row_header(&self) -> bool; /// Sets whether a row headers are enabled or not fn set_row_header(&mut self, flag: bool); /// Returns if column headers are enabled or not fn col_header(&self) -> bool; /// Sets whether a column headers are enabled or not fn set_col_header(&mut self, flag: bool); /// Sets the column header height fn set_col_header_height(&mut self, height: i32); /// Gets the column header height fn col_header_height(&self) -> i32; /// Sets the row header width fn set_row_header_width(&mut self, width: i32); /// Gets the row header width fn row_header_width(&self) -> i32; /// Sets the row header color fn set_row_header_color(&mut self, val: Color); /// Gets the row header color fn row_header_color(&self) -> Color; /// Sets the column header color fn set_col_header_color(&mut self, val: Color); /// Gets the row header color fn col_header_color(&self) -> Color; /// Sets the row's height fn set_row_height(&mut self, row: i32, height: i32); /// Gets the row's height fn row_height(&self, row: i32) -> i32; /// Sets the columns's width fn set_col_width(&mut self, col: i32, width: i32); /// Gets the columns's width fn col_width(&self, col: i32) -> i32; /// Sets all rows height fn set_row_height_all(&mut self, height: i32); /// Sets all columns's width fn set_col_width_all(&mut self, width: i32); /// Sets the row's position fn set_row_position(&mut self, row: i32); /// Sets the columns's position fn set_col_position(&mut self, col: i32); /// Gets the row's position fn row_position(&self) -> i32; /// Gets the columns's position fn col_position(&self) -> i32; /// Sets the top row fn set_top_row(&mut self, row: i32); /// Gets the top row fn top_row(&self) -> i32; /// Returns whether a cell is selected fn is_selected(&self, r: i32, c: i32) -> bool; /// Gets the selection fn get_selection( &self, row_top: &mut i32, col_left: &mut i32, row_bot: &mut i32, col_right: &mut i32, ); /// Sets the selection fn set_selection(&mut self, row_top: i32, col_left: i32, row_bot: i32, col_right: i32); /// Moves the cursor with shift select fn move_cursor_with_shift_select( &mut self, r: i32, c: i32, shiftselect: bool, ) -> Result<(), FltkError>; /// Moves the cursor fn move_cursor(&mut self, r: i32, c: i32) -> Result<(), FltkError>; /// Resets the internal array of widget sizes and positions. fn init_sizes(&mut self); /// Returns the scrollbar size fn scrollbar_size(&self) -> u32; /// Sets the scrollbar size fn set_scrollbar_size(&mut self, new_size: u32); /// Sets the tab key cell navigation fn set_tab_cell_nav(&mut self, val: u32); /// Returns the tab key cell navigation fn tab_cell_nav(&self) -> u32; /// Override draw_cell /// callback args: TableContext, Row: i32, Column: i32, X: i32, Y: i32, Width: i32 and Height: i32 fn draw_cell<F: FnMut(crate::table::TableContext, i32, i32, i32, i32, i32, i32) + 'static>( &mut self, cb: F, ); /// Override draw_cell /// callback args: &mut self, TableContext, Row: i32, Column: i32, X: i32, Y: i32, Width: i32 and Height: i32 /// takes the widget as a closure argument fn draw_cell2< F: FnMut(&mut Self, crate::table::TableContext, i32, i32, i32, i32, i32, i32) + 'static, >( &mut self, cb: F, ); /// INTERNAL: Retrieve the draw cell data /// # Safety /// Can return multiple mutable references to the draw_cell_data unsafe fn draw_cell_data(&self) -> Option<Box<dyn FnMut()>>; } /// Defines the methods implemented by all image types pub unsafe trait ImageExt { /// Performs a deep copy of the image fn copy(&self) -> Self where Self: Sized; /// Draws the image at the presupplied coordinates and size fn draw(&mut self, x: i32, y: i32, width: i32, height: i32); /// Return the width of the image fn width(&self) -> i32; /// Return the height of the image fn height(&self) -> i32; /// Retunrs a pointer of the image /// # Safety /// Can return multiple mutable pointers to the image unsafe fn as_image_ptr(&self) -> *mut fltk_sys::image::Fl_Image; /// Transforms a raw image pointer to an image /// # Safety /// The pointer must be valid unsafe fn from_image_ptr(ptr: *mut fltk_sys::image::Fl_Image) -> Self where Self: Sized; /// Returns the underlying raw rgb image data fn to_rgb_data(&self) -> Vec<u8>; /// Returns the underlying raw image data fn to_raw_data(&self) -> *const *const u8; /// Transforms the image into an RgbImage fn to_rgb(&self) -> Result<crate::image::RgbImage, FltkError>; /// Scales the image fn scale(&mut self, width: i32, height: i32, proportional: bool, can_expand: bool); /// Return the count of an image fn count(&self) -> u32; /// Gets the image's data width fn data_w(&self) -> u32; /// Gets the image's data height fn data_h(&self) -> u32; /// Gets the image's depth fn depth(&self) -> u32; /// Gets the image's line data size fn ld(&self) -> u32; /// Greys the image fn inactive(&mut self); /// Transforms an image to a PngImage fn into_png(self) -> Result<crate::image::PngImage, FltkError> where Self: Sized; /// Transforms an image to a JpegImage fn into_jpeg(self) -> Result<crate::image::JpegImage, FltkError> where Self: Sized; /// Transforms an image to a BmpImage fn into_bmp(self) -> Result<crate::image::BmpImage, FltkError> where Self: Sized; /// Deletes the image /// # Safety /// An image shouldn't be deleted while it's being used by a widget unsafe fn delete(img: Self) where Self: Sized; /// Checks if the image was deleted fn was_deleted(&self) -> bool; /// INTERNAL: Manually increment the atomic refcount /// # Safety /// The underlying image pointer must be valid unsafe fn increment_arc(&mut self); /// INTERNAL: Manually decrement the atomic refcount /// # Safety /// The underlying image pointer must be valid unsafe fn decrement_arc(&mut self); /// Transforms an Image base into another Image /// # Safety /// Can be unsafe if used to downcast to an image of different format unsafe fn into_image<I: ImageExt>(self) -> I where Self: Sized; } /// Defines the methods implemented by all surface types, currently ImageSurface pub trait SurfaceDevice { /// Checks whether this surface is the current surface fn is_current(&self) -> bool; /// Get the current surface fn surface() -> Self; /// Push a surface as a current surface fn push_current(new_current: &Self); /// Pop the current surface fn pop_current(); }