Struct DoubleWindow

pub struct DoubleWindow { /* private fields */ }

Creates a double (buffered) window widget

Implementations

impl DoubleWindow

pub unsafe fn find_by_handle(handle: RawHandle) -> Option<impl WindowExt>

Find an Fl_Window through a raw handle. The window must have been instantiated by the app. void * to: (Windows: HWND, X11: Xid (u64), macOS: NSWindow)

Safety

The data must be valid and is OS-dependent.

pub fn show_with_env_args(&mut self)

Use FLTK specific arguments for the application: More info here. The options are:

• -bg2 color
• -bg color
• -di[splay] host:n.n
• -dn[d]
• -fg color
• -g[eometry] WxH+X+Y
• -i[conic]
• -k[bd]
• -na[me] classname
• -nod[nd]
• -nok[bd]
• -not[ooltips]
• -s[cheme] scheme
• -ti[tle] windowtitle
• -to[oltips]

Examples found in repository

examples/animations.rs (line 66)

fn main() {
    let app = app::App::default();
    let mut wind = Window::default().with_label("timeout").with_size(720, 486);
    wind.set_center_screen();
    let mut frame = Frame::new(-200, 150, 200, 200, "");
    let mut pxm = Pixmap::new(PXM).unwrap();
    pxm.scale(200, 200, true, true);
    frame.set_image_scaled(Some(pxm));
    wind.set_color(enums::Color::White);
    wind.end();
    wind.show_with_env_args();

    app::add_timeout(0.016, move |handle| {
        let frame = frame.clone();
        move_image(frame, handle);
    });
    app.run().unwrap();
}

pub fn show_with_args(&mut self, args: &[&str])

Use FLTK specific arguments for the application: More info here. The options are:

• -bg2 color
• -bg color
• -di[splay] host:n.n
• -dn[d]
• -fg color
• -g[eometry] WxH+X+Y
• -i[conic]
• -k[bd]
• -na[me] classname
• -nod[nd]
• -nok[bd]
• -not[ooltips]
• -s[cheme] scheme
• -ti[tle] windowtitle
• -to[oltips]

Examples found in repository

examples/calculator.rs (line 156)

fn main() {
    let app = app::App::default();
    let win_w = 400;
    let win_h = 500;
    let border = 20;
    let but_row = 180;

    let mut operation = Ops::None;
    let mut txt = String::from("0");
    let mut old_val = String::from("0");
    let mut new_val: String;

    let mut wind = Window::default()
        .with_label("FLTK Calc")
        .with_size(win_w, win_h);
    wind.set_center_screen();
    wind.set_color(Color::Light3);

    let mut out = Output::new(border, border, win_w - 40, 140, "");
    out.set_text_size(36);
    out.set_value("0");

    let vpack = Pack::new(border, but_row, win_w - 40, 300, "");

    let mut hpack = Pack::new(0, 0, win_w - 40, 60, "");
    let but_ce = MyButton::new("CE");
    let but_c = MyButton::new("C");
    let but_back = MyButton::new("@<-");
    let but_div = MyButton::new("/");
    hpack.end();
    hpack.set_type(PackType::Horizontal);

    let mut hpack = Pack::new(0, 0, win_w - 40, 60, "");
    let mut but7 = MyButton::new("7");
    let mut but8 = MyButton::new("8");
    let mut but9 = MyButton::new("9");
    let but_mul = MyButton::new("x");
    hpack.end();
    hpack.set_type(PackType::Horizontal);

    let mut hpack = Pack::new(0, 0, win_w - 40, 60, "");
    let mut but4 = MyButton::new("4");
    let mut but5 = MyButton::new("5");
    let mut but6 = MyButton::new("6");
    let but_sub = MyButton::new("-");
    hpack.end();
    hpack.set_type(PackType::Horizontal);

    let mut hpack = Pack::new(0, 0, win_w - 40, 60, "");
    let mut but1 = MyButton::new("1");
    let mut but2 = MyButton::new("2");
    let mut but3 = MyButton::new("3");
    let but_add = MyButton::new("+");
    hpack.end();
    hpack.set_type(PackType::Horizontal);

    let mut hpack = Pack::new(0, 0, win_w - 40, 60, "");
    let mut but_dot = MyButton::new(".");
    let mut but0 = MyButton::new("0");
    let but_eq = MyButton::new("=");
    hpack.end();
    hpack.set_type(PackType::Horizontal);

    vpack.end();

    wind.make_resizable(false);
    wind.end();
    wind.show_with_args(&["-scheme", "gtk+", "-nokbd"]);

    app::set_focus(&*but1);

    let but_vec = vec![
        &mut but1, &mut but2, &mut but3, &mut but4, &mut but5, &mut but6, &mut but7, &mut but8,
        &mut but9, &mut but0,
    ];

    let but_op_vec = vec![
        but_add, but_sub, but_mul, but_div, but_c, but_ce, but_back, but_eq,
    ];

    let (s, r) = app::channel::<Message>();

    for but in but_vec {
        let label = but.label().unwrap();
        but.emit(s, Message::Number(label.parse().unwrap()));
    }

    for mut but in but_op_vec {
        let op = match but.label().unwrap().as_str() {
            "+" => Ops::Add,
            "-" => Ops::Sub,
            "x" => Ops::Mul,
            "/" => Ops::Div,
            "=" => Ops::Eq,
            "CE" => Ops::CE,
            "C" => Ops::C,
            "@<-" => Ops::Back,
            _ => Ops::None,
        };
        but.emit(s, Message::Op(op));
    }

    but_dot.emit(s, Message::Dot);

    while app.wait() {
        if let Some(val) = r.recv() {
            match val {
                Message::Number(num) => {
                    if out.value() == "0" {
                        txt.clear();
                    }
                    txt.push_str(&num.to_string());
                    out.set_value(txt.as_str());
                }
                Message::Dot => {
                    if operation == Ops::Eq {
                        txt.clear();
                        operation = Ops::None;
                        out.set_value("0.");
                        txt.push_str("0.");
                    }
                    if !txt.contains('.') {
                        txt.push('.');
                        out.set_value(txt.as_str());
                    }
                }
                Message::Op(op) => match op {
                    Ops::Add | Ops::Sub | Ops::Div | Ops::Mul => {
                        old_val.clear();
                        old_val.push_str(&out.value());
                        operation = op;
                        out.set_value("0");
                    }
                    Ops::Back => {
                        let val = out.value();
                        txt.pop();
                        if val.len() > 1 {
                            out.set_value(txt.as_str());
                        } else {
                            out.set_value("0");
                        }
                    }
                    Ops::CE => {
                        txt.clear();
                        old_val.clear();
                        txt.push('0');
                        out.set_value(txt.as_str());
                    }
                    Ops::C => {
                        txt.clear();
                        txt.push('0');
                        out.set_value(txt.as_str());
                    }
                    Ops::Eq => {
                        new_val = out.value();
                        let old: f64 = old_val.parse().unwrap();
                        let new: f64 = new_val.parse().unwrap();
                        let val = match operation {
                            Ops::Div => old / new,
                            Ops::Mul => old * new,
                            Ops::Add => old + new,
                            Ops::Sub => old - new,
                            _ => new,
                        };
                        operation = Ops::None;
                        txt = String::from("0");
                        out.set_value(&val.to_string());
                    }
                    _ => (),
                },
            }
        }
    }
}

pub fn set_on_top(&mut self)

Set the window to be on top of other windows. Must only be called after the window has been shown.

pub fn maximize(&mut self)

Maximize the window

pub fn un_maximize(&mut self)

Unmaximize the window

pub fn maximize_active(&self) -> bool

Checks whether the window is maximized

pub fn default_xclass() -> Option<String>

Get the default XA_WM_CLASS property for all windows of your application

pub fn set_default_xclass(s: &str)

Set the default XA_WM_CLASS property for all windows of your application. This should be called before showing with window

impl DoubleWindow

pub fn pixels_per_unit(&self) -> f32

Returns the pixels per unit/point

pub fn pixel_w(&self) -> i32

Gets the window’s width in pixels

pub fn pixel_h(&self) -> i32

Gets the window’s height in pixels

impl DoubleWindow

pub fn new<'a, T: Into<Option<&'a str>>>( x: i32, y: i32, w: i32, h: i32, title: T, ) -> Self

Creates a new window, with title as its window title if the window is decorated

Examples found in repository

examples/hello_svg.rs (line 8)

fn main() {
    let app = app::App::default().with_scheme(app::Scheme::Gleam);

    let mut wind = Window::new(100, 100, 400, 300, "Hello from rust");

    let mut frame = Frame::default().with_size(360, 260).center_of_parent();
    frame.set_frame(FrameType::EngravedBox);
    let mut image1 = SvgImage::load("screenshots/RustLogo.svg").unwrap();
    image1.scale(200, 200, true, true);
    frame.set_image(Some(image1));

    wind.make_resizable(true);
    wind.end();
    wind.show();

    app.run().unwrap();
}

examples/rounded_images.rs (line 54)

fn main() {
    let app = app::App::default().with_scheme(app::Scheme::Gleam);
    app::background(0, 0, 0);
    let image = image::SharedImage::load("screenshots/calc2.jpg")
        .unwrap()
        .as_rgb_image()
        .unwrap();

    let mut wind = window::Window::new(100, 100, 800, 400, "Hello from rust");
    let row = group::Flex::default()
        .row()
        .with_size(800, 200)
        .center_of_parent();
    for i in 1..=4 {
        let color_depth = enums::ColorDepth::from_u8(i).unwrap();
        let image = image.convert(color_depth).unwrap();
        RoundImageBox::new(100, image);
    }
    row.end();
    wind.end();
    wind.show();

    app.run().unwrap();
}

examples/charts.rs (line 5)

fn main() {
    let app = app::App::default().with_scheme(app::Scheme::Gtk);
    let mut win = window::Window::new(100, 100, 800, 600, "Charts");
    let mut chart = misc::Chart::default().size_of_parent();
    chart.set_type(misc::ChartType::Pie);
    chart.set_bounds(0.0, 100.0);
    chart.set_text_size(18);
    chart.add(88.4, "Rust", enums::Color::from_u32(0xcc9c59));
    chart.add(8.4, "C++", enums::Color::Red);
    chart.add(3.2, "C", enums::Color::Black);
    chart.set_color(enums::Color::White);
    let mut choice = menu::Choice::new(300, 5, 200, 40, "Chart type");
    choice.add_choice("Bar|HorzBar|Line|Fill|Spike|Pie|SpecialPie");
    choice.set_value(5);
    choice.set_color(enums::Color::White);
    win.end();
    win.show();

    choice.set_callback(move |c| {
        chart.set_type(misc::ChartType::from_i32(c.value()));
        chart.redraw();
    });

    app.run().unwrap();
}

examples/tile.rs (line 30)

fn main() {
    let app = app::App::default();
    let mut window = window::Window::default().with_size(300, 300);
    window.set_frame(FrameType::NoBox);
    window.make_resizable(true);

    let dx = 20;
    let dy = dx; // border width of resizable() - see below
    let tile = group::Tile::default_fill();

    // create the symmetrical resize box with dx and dy pixels distance, resp.
    // from the borders of the Fl_Tile widget before all other children
    let r = frame::Frame::new(
        tile.x() + dx,
        tile.y() + dy,
        tile.w() - 2 * dx,
        tile.h() - 2 * dy,
        None,
    );
    tile.resizable(&r);

    let mut box0 = frame::Frame::new(0, 0, 150, 150, "0");
    box0.set_frame(FrameType::DownBox);
    box0.set_color(Color::by_index(9));
    box0.set_label_size(36);
    box0.set_align(Align::Clip);

    let mut w1 = window::Window::new(150, 0, 150, 150, "1");
    w1.set_frame(FrameType::NoBox);
    let mut box1 = frame::Frame::new(0, 0, 150, 150, "1\nThis is a child window");
    box1.set_frame(FrameType::DownBox);
    box1.set_color(Color::by_index(19));
    box1.set_label_size(18);
    box1.set_align(Align::Clip | Align::Inside | Align::Wrap);
    w1.resizable(&box1);
    w1.end();

    let mut box2a = frame::Frame::new(0, 150, 70, 150, "2a");
    box2a.set_frame(FrameType::DownBox);
    box2a.set_color(Color::by_index(12));
    box2a.set_label_size(36);
    box2a.set_align(Align::Clip);

    let mut box2b = frame::Frame::new(70, 150, 80, 150, "2b");
    box2b.set_frame(FrameType::DownBox);
    box2b.set_color(Color::by_index(13));
    box2b.set_label_size(36);
    box2b.set_align(Align::Clip);

    let mut box3a = frame::Frame::new(150, 150, 150, 70, "3a");
    box3a.set_frame(FrameType::DownBox);
    box3a.set_color(Color::by_index(12));
    box3a.set_label_size(36);
    box3a.set_align(Align::Clip);

    let mut box3b = frame::Frame::new(150, 150 + 70, 150, 80, "3b");
    box3b.set_frame(FrameType::DownBox);
    box3b.set_color(Color::by_index(13));
    box3b.set_label_size(36);
    box3b.set_align(Align::Clip);

    tile.end();
    window.end();

    w1.show();
    window.show();

    app.run().unwrap();
}

examples/terminal.rs (lines 32-38)

fn main() {
    let app = fltk::app::App::default();

    // Set panic handler for main thread (will become UI thread)
    std::panic::set_hook(Box::new({
        |e| {
            eprintln!("!!!!PANIC!!!!{:#?}", e);
            error_box(e.to_string()); // Only works from the UI thread
            std::process::exit(2);
        }
    }));

    let mut main_win = Window::new(
        2285,
        180,
        WIN_WIDTH,
        WIN_HEIGHT,
        "FLTK/Terminal Rust wrapper test",
    );
    main_win.set_type(WindowType::Double);
    main_win.make_resizable(true);

    let mut menu_bar = MenuBar::new(0, 0, WIN_WIDTH, 30, None);

    let mut term = Terminal::new(0, 30, WIN_WIDTH, WIN_HEIGHT - 30, None);
    term.set_label("term");
    main_win.resizable(&term);
    term.set_label_type(LabelType::None);

    let idx = menu_bar.add_choice("Test&1");
    menu_bar.at(idx).unwrap().set_callback({
        let mut term1 = term.clone();
        move |c| mb_test1_cb(c, &mut term1)
    });
    menu_bar
        .at(idx)
        .unwrap()
        .set_shortcut(unsafe { std::mem::transmute(0x80031) }); // Alt-1

    let idx = menu_bar.add_choice("Test&2");
    menu_bar.at(idx).unwrap().set_callback({
        let mut term1 = term.clone();
        move |c| mb_test2_cb(c, &mut term1)
    });
    menu_bar
        .at(idx)
        .unwrap()
        .set_shortcut(unsafe { std::mem::transmute(0x80032) }); // Alt-2

    let idx = menu_bar.add_choice("Test&3");
    menu_bar.at(idx).unwrap().set_callback({
        let mut term1 = term.clone();
        move |c| mb_test3_cb(c, &mut term1)
    });
    menu_bar
        .at(idx)
        .unwrap()
        .set_shortcut(unsafe { std::mem::transmute(0x80033) }); // Alt-3

    let idx = menu_bar.add_choice("Test&4");
    menu_bar.at(idx).unwrap().set_callback({
        let mut term1 = term.clone();
        move |c| mb_test4_cb(c, &mut term1)
    });
    menu_bar
        .at(idx)
        .unwrap()
        .set_shortcut(unsafe { std::mem::transmute(0x80034) }); // Alt-4

    let idx = menu_bar.add_choice("Test&5");
    menu_bar.at(idx).unwrap().set_callback({
        let mut term1 = term.clone();
        move |c| mb_test5_cb(c, &mut term1)
    });
    menu_bar
        .at(idx)
        .unwrap()
        .set_shortcut(unsafe { std::mem::transmute(0x80035) }); // Alt-5

    menu_bar.end();

    main_win.end();
    main_win.show();

    // Worker thread that drives the startup tests
    let _worker_thread: std::thread::JoinHandle<_> = std::thread::spawn({
        let mut term = term.clone();
        move || {
            println!("Startup tests\n");
            term.append("Startup tests\n\n");
            term.append("<tmp>\n"); // This line will be overwritten later

            term.cursor_up(2, false);
            assert_eq!(term.text(false), "Startup tests\n\n"); // Ignores lines below cursor
            assert_eq!(
                term.text(true),
                "Startup tests\n\n<tmp>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n"
            );

            // Testing ansi() and set_ansi() methods
            assert!(term.ansi(), "Default ANSI mode should be ON at startup");
            term.append("ANSI mode is \x1b[4mON\x1b[0m\n");
            term.set_ansi(false);
            assert!(!term.ansi());
            term.append("ANSI mode is \x1b[4mOFF\x1b[0m\n");
            // append() method is already being used/tested. Test the u8, ascii, and utf8 variants
            term.append_u8(b"Appending u8 array\n");
            term.append_ascii("Appending ASCII array ↑ (up-arrow is dropped)\n");
            term.set_ansi(true); // Restore ANSI state

            // Play with the horizontal scrollbar
            assert_eq!(term.hscrollbar_style(), ScrollbarStyle::AUTO);
            term.set_hscrollbar_style(ScrollbarStyle::ON);
            assert_eq!(term.hscrollbar_style(), ScrollbarStyle::ON);

            // Test show_unknown() as incidental part of testing append methods
            term.set_show_unknown(true);
            assert!(term.show_unknown());
            term.append_ascii(
                "Appending ASCII array with show_unknown() ↑ (up-arrow is three unknown bytes)\n",
            );
            term.set_show_unknown(false);
            assert!(!term.show_unknown());

            term.append_utf8("Appending UTF8 array ↑ (up-arrow is visible)\n");
            term.append_utf8_u8(b"Appending UTF8 array as u8 \xe2\x86\x91 (up-arrow is visible)\n");

            let r = term.cursor_row();
            assert_eq!(term.cursor_col(), 0);
            term.append(&format!("Testing cursor row/col {r}"));
            assert_eq!(term.cursor_col(), 24);
            assert_eq!(term.cursor_row(), r);

            // Test cursor color methods
            assert_eq!(
                term.cursor_bg_color(),
                Color::XtermGreen,
                "Default cursor bg at startup"
            );
            term.set_cursor_bg_color(Color::Red);
            assert_eq!(term.cursor_bg_color(), Color::Red);
            term.set_cursor_fg_color(Color::Blue);
            assert_eq!(term.cursor_bg_color(), Color::Red);
            assert_eq!(term.cursor_fg_color(), Color::Blue);
            term.set_cursor_bg_color(Color::XtermGreen); // Restore the defaults
            term.set_cursor_fg_color(Color::from_hex(0xff_ff_f0));
            assert_eq!(term.cursor_bg_color(), Color::XtermGreen);
            assert_eq!(term.cursor_fg_color(), Color::from_hex(0xff_ff_f0));

            // The default display_rows() will derive from the window size
            let dr = term.display_rows();
            let height = term.h();
            assert_eq!(height, term.h());
            assert!(dr > 20, "Default display_rows at startup");
            term.resize(term.x(), term.y(), term.w(), height * 2);
            assert_eq!(term.h(), height * 2);
            assert_eq!(height * 2, term.h());
            assert!(term.display_rows() > dr);
            term.resize(term.x(), term.y(), term.w(), height);

            // The default display_columns() will derive from the window size
            let dc = term.display_columns();
            assert!(dc > 80, "Default display_rows at startup");
            term.set_display_columns(200);
            assert_eq!(term.display_columns(), 200);
            term.append("\n         1         2         3         4         5         6         7         8         9");
            term.append("\n123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890");
            term.append("[This text should be truncated by display_columns() call below.]\n"); // We shouldn't see this on screen
            term.set_display_columns(90);
            assert_eq!(term.display_columns(), 90);
            term.set_display_columns(dc); // Set back to default
            assert_eq!(term.display_columns(), dc);

            assert_eq!(term.history_rows(), 100, "Default history_rows at startup");
            term.set_history_rows(50);
            assert_eq!(term.history_rows(), 50);
            term.set_history_rows(100); // Set back to default
            assert_eq!(term.history_rows(), 100);

            let hu = term.history_use();
            term.append(&format!(
                "history_use = {hu} (it's not clear what this means)\n"
            ));
            // assert_eq!(term.history_use(), hu+1);

            term.append(&format!(
                "margins = b:{} l:{} r:{} t{}\n",
                term.margin_bottom(),
                term.margin_left(),
                term.margin_right(),
                term.margin_top()
            ));
            assert_eq!(term.margin_bottom(), 3);
            assert_eq!(term.margin_left(), 3);
            assert_eq!(term.margin_right(), 3);
            assert_eq!(term.margin_top(), 3);

            term.set_margin_bottom(5);
            term.set_margin_left(10);
            term.set_margin_right(15);
            term.set_margin_top(20);
            assert_eq!(term.margin_bottom(), 5);
            assert_eq!(term.margin_left(), 10);
            assert_eq!(term.margin_right(), 15);
            assert_eq!(term.margin_top(), 20);

            term.append("Single character: '");
            term.print_char('X');
            term.append("', single UTF-8 character: '");
            term.print_char_utf8('↑');
            term.append("'\n");

            let rr = term.redraw_rate();
            assert_eq!(rr, 0.1, "Default redraw rate at startup");
            term.append(&format!("Redraw rate {rr}\n"));
            term.set_redraw_rate(1.0);
            assert_eq!(term.redraw_rate(), 1.0);
            term.set_redraw_rate(rr);
            assert_eq!(term.redraw_rate(), rr);

            let rs = term.redraw_style();
            term.append(&format!("Redraw style {rs:?}\n"));
            assert_eq!(
                rs,
                RedrawStyle::RateLimited,
                "Default redraw style at startup"
            );
            term.set_redraw_style(RedrawStyle::NoRedraw);
            assert_eq!(term.redraw_style(), RedrawStyle::NoRedraw);
            term.set_redraw_style(rs);
            assert_eq!(term.redraw_style(), rs);

            // Sanity checks: enum values are implicitly assigned in the C++ code so could change unexpectedly
            assert_eq!(
                RedrawStyle::NoRedraw.bits(),
                0x0000,
                "RedrawStyle enum values have been reassigned"
            );
            assert_eq!(
                RedrawStyle::RateLimited.bits(),
                0x0001,
                "RedrawStyle enum values have been reassigned"
            );
            assert_eq!(
                RedrawStyle::PerWrite.bits(),
                0x0002,
                "RedrawStyle enum values have been reassigned"
            );

            let sb = term.scrollbar();
            let hsb = term.hscrollbar();
            // Both vertical and horizontal scrollbars are at zero
            assert_eq!(sb.value(), 0.0);
            assert_eq!(hsb.value(), 0.0);
            term.set_hscrollbar_style(ScrollbarStyle::AUTO);

            term.append(&format!(
                "Scrollbar actual size {}\n",
                term.scrollbar_actual_size()
            ));
            assert_eq!(term.scrollbar_actual_size(), 16);
            term.append(&format!("Scrollbar size {}\n", term.scrollbar_size()));
            assert_eq!(
                term.scrollbar_size(),
                0,
                "Default scrollbar size at startup"
            );
            term.set_scrollbar_size(40);
            assert_eq!(term.scrollbar_size(), 40);
            assert_eq!(term.scrollbar_actual_size(), 40);
            term.append(&format!(
                "Scrollbar actual size {}\n",
                term.scrollbar_actual_size()
            ));
            term.set_scrollbar_size(0); // Restore default
            assert_eq!(term.scrollbar_size(), 0);
            assert_eq!(term.scrollbar_actual_size(), 16);

            let sfc = term.selection_fg_color();
            let sbc = term.selection_bg_color();
            assert_eq!(sfc, Color::Black);
            assert_eq!(sbc, Color::White);
            term.append(&format!("Selection colors: {sfc} {sbc}\n"));
            term.set_selection_fg_color(Color::Green);
            term.set_selection_bg_color(Color::DarkBlue);
            assert_eq!(term.selection_fg_color(), Color::Green);
            assert_eq!(term.selection_bg_color(), Color::DarkBlue);
            term.set_selection_fg_color(sfc);
            term.set_selection_bg_color(sbc);
            assert_eq!(term.selection_fg_color(), Color::Black);
            assert_eq!(term.selection_bg_color(), Color::White);

            let tfcd = term.text_fg_color_default();
            let tbcd = term.text_bg_color_default();
            assert_eq!(tfcd, Color::XtermWhite);
            assert_eq!(tbcd, Color::TransparentBg);
            term.append(&format!("Default text colors: {sfc} {sbc}\n"));
            term.set_text_fg_color_default(Color::Green);
            term.set_text_bg_color_default(Color::DarkBlue);
            assert_eq!(term.text_fg_color_default(), Color::Green);
            assert_eq!(term.text_bg_color_default(), Color::DarkBlue);
            term.set_text_fg_color_default(tfcd);
            term.set_text_bg_color_default(tbcd);
            assert_eq!(term.text_fg_color_default(), Color::XtermWhite);
            assert_eq!(term.text_bg_color_default(), Color::TransparentBg);

            let tfc = term.text_fg_color();
            let tbc = term.text_bg_color();
            assert_eq!(tfc, Color::XtermWhite);
            assert_eq!(tbc, Color::TransparentBg);
            term.append(&format!("Text colors: {sfc} {sbc}\n"));
            term.set_text_fg_color(Color::Green);
            term.set_text_bg_color(Color::DarkBlue);
            assert_eq!(term.text_fg_color(), Color::Green);
            assert_eq!(term.text_bg_color(), Color::DarkBlue);
            term.set_text_fg_color(tfc);
            term.set_text_bg_color(tbc);
            assert_eq!(term.text_fg_color(), Color::XtermWhite);
            assert_eq!(term.text_bg_color(), Color::TransparentBg);

            let tf = term.text_font();
            term.append(&format!("Text font: {tf:?}\n"));
            assert_eq!(tf, Font::Courier);
            term.set_text_font(Font::Screen);
            assert_eq!(term.text_font(), Font::Screen);
            term.set_text_font(tf);
            assert_eq!(term.text_font(), Font::Courier);

            let ts = term.text_size();
            let r = term.h_to_row(100);
            let c = term.w_to_col(100);
            term.append(&format!(
                "Text size: {ts}, h_to_row(100): {r}, w_to_col(100): {c}\n"
            ));
            assert_eq!(ts, 14);
            term.set_text_size(30);
            assert_eq!(term.text_size(), 30);
            term.append(&format!(
                "Text size: {}, h_to_row(100): {}, w_to_col(100): {}\n",
                term.text_size(),
                term.h_to_row(100),
                term.w_to_col(100)
            ));
            term.set_text_size(ts);
            assert_eq!(term.text_size(), ts);
            term.append(&format!(
                "Text size: {}, h_to_row(100): {}, w_to_col(100): {}\n",
                term.text_size(),
                term.h_to_row(100),
                term.w_to_col(100)
            ));

            // Keyboard handler
            term.handle({
                move |term, e| {
                    match e {
                        fltk::enums::Event::KeyDown
                            if fltk::app::event_key() == fltk::enums::Key::Escape =>
                        {
                            // false to let FLTK handle ESC. true to hide ESC
                            false
                        }

                        fltk::enums::Event::KeyDown
                            if fltk::app::event_length() == 1 && fltk::app::is_event_ctrl() =>
                        {
                            // We handle control keystroke
                            let k = fltk::app::event_text().unwrap();
                            term.append_utf8(&k);
                            true
                        }

                        fltk::enums::Event::KeyDown
                            if fltk::app::event_length() == 1 && !fltk::app::is_event_alt() =>
                        {
                            // We handle normal printable keystroke
                            let k = fltk::app::event_text().unwrap();
                            term.take_focus().unwrap();
                            term.append(&k);
                            true
                        }

                        // fltk docs say that keyboard handler should always claim Focus and Unfocus events
                        // We can do this, or else ignore them (return false)
                        // fltk::enums::Event::Focus | fltk::enums::Event::Unfocus => {
                        //     term.redraw();
                        //     true
                        // }
                        _ => false, // Let FLTK handle everything else
                    }
                }
            });

            let attr_save = term.text_attrib();
            term.set_text_attrib(Attrib::Inverse | Attrib::Italic);
            term.append("\nStartup tests complete. Keyboard is live.\n");
            assert_eq!(term.text_attrib(), Attrib::Inverse | Attrib::Italic);
            term.set_text_attrib(attr_save);
            assert_eq!(term.text_attrib(), attr_save);
            term.redraw();
        }
    });

    app.run().unwrap();
}

pub fn flush(&mut self)

Forces the window to be drawn, this window is also made current and calls draw()

pub fn platform_show(&self)

Show a window after it had been hidden. Works on Windows and X11 systems

pub fn platform_hide(&self)

Hide a window using the platforms hide call. Works on Windows and X11 systems

Trait Implementations

impl Clone for DoubleWindow

fn clone(&self) -> DoubleWindow

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DoubleWindow

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DoubleWindow

fn default() -> Self

Returns the “default value” for a type.

impl GroupExt for DoubleWindow

fn begin(&self)

Begins a group, used for widgets implementing the group trait

fn end(&self)

Ends a group, used for widgets implementing the group trait

fn clear(&mut self)

Clear a group from all widgets

fn children(&self) -> i32

Return the number of children in a group

fn child(&self, idx: i32) -> Option<Widget>

Return child widget by index

fn find<W: WidgetExt>(&self, widget: &W) -> i32

Find a widget within a group and return its index

fn add<W: WidgetExt>(&mut self, widget: &W)

Add a widget to a group

fn insert<W: WidgetExt>(&mut self, widget: &W, index: i32)

Insert a widget to a group at a certain index

fn remove<W: WidgetExt>(&mut self, widget: &W)

Remove a widget from a group, but does not delete it

fn remove_by_index(&mut self, idx: i32)

Remove a child widget by its index

fn resizable<W: WidgetExt>(&self, widget: &W)

The resizable widget defines both the resizing frame and the resizing behavior of the group and its children.

fn make_resizable(&mut self, val: bool)

Make the group itself resizable, should be called before the widget is shown

fn add_resizable<W: WidgetExt>(&mut self, widget: &W)

Adds a widget to the group and makes it the resizable widget

fn set_clip_children(&mut self, flag: bool)

Clips children outside the group boundaries

fn clip_children(&self) -> bool

Get whether clip_children is set

fn draw_child<W: WidgetExt>(&self, w: &mut W)

Draw a child widget, the call should be in a WidgetBase::draw method

fn update_child<W: WidgetExt>(&self, w: &mut W)

Update a child widget, the call should be in a WidgetBase::draw method

fn draw_outside_label<W: WidgetExt>(&self, w: &mut W)

Draw the outside label, the call should be in a WidgetBase::draw method

fn draw_children(&mut self)

Draw children, the call should be in a WidgetBase::draw method

fn init_sizes(&mut self)

Resets the internal array of widget sizes and positions

fn bounds(&self) -> Vec<(i32, i32, i32, i32)>

Get the bounds of all children widgets (left, upper, right, bottom)

unsafe fn as_group(&self) -> Group

Converts a widget implementing GroupExt into a Group widget

impl IntoIterator for DoubleWindow

type Item = Widget

The type of the elements being iterated over.

type IntoIter = IntoIter<<DoubleWindow as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for DoubleWindow

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl WidgetBase for DoubleWindow

fn delete(wid: Self)

Deletes widgets and their children.

unsafe fn from_widget_ptr(ptr: *mut Fl_Widget) -> Self

transforms a widget pointer to a Widget, for internal use

unsafe fn from_widget<W: WidgetExt>(w: W) -> Self

Get a widget from base widget

fn handle<F: FnMut(&mut Self, 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 should return true, unhandled events should return false. takes the widget as a closure argument. The ability to handle an event might depend on handling other events, as explained here

fn draw<F: FnMut(&mut Self) + 'static>(&mut self, cb: F)

Set a custom draw method. takes the widget as a closure argument. macOS requires that WidgetBase::draw actually calls drawing functions

fn resize_callback<F: FnMut(&mut Self, i32, i32, i32, i32) + 'static>( &mut self, cb: F, )

Perform a callback on resize. Avoid resizing the parent or the same widget to avoid infinite recursion

unsafe fn assume_derived(&mut self)

Makes the widget derived

fn from_dyn_widget<W: WidgetExt>(w: &W) -> Option<Self>

Cast a type-erased widget back to its original widget

fn from_dyn_widget_ptr(w: *mut Fl_Widget) -> Option<Self>

Cast a type-erased widget pointer back to its original widget

impl WidgetExt for DoubleWindow

fn set_label(&mut self, title: &str)

Sets the widget’s label. labels support special symbols preceded by an @ sign. and for the associated formatting.

fn unset_label(&mut self)

Unset a widget’s label

fn redraw(&mut self)

Redraws a widget, necessary for resizing and changing positions

fn show(&mut self)

Shows the widget

fn hide(&mut self)

Hides the widget

fn x(&self) -> i32

Returns the x coordinate of the widget

fn y(&self) -> i32

Returns the y coordinate of the widget

fn w(&self) -> i32

Returns the width of the widget

fn h(&self) -> i32

Returns the height of the widget

fn label(&self) -> Option<String>

Returns the label of the widget

fn measure_label(&self) -> (i32, i32)

Measures the label’s width and height

fn as_widget_ptr(&self) -> *mut Fl_Widget

transforms a widget to a base Fl_Widget, for internal use

fn activate(&mut self)

Activates the widget

fn deactivate(&mut self)

Deactivates the widget

fn redraw_label(&mut self)

Redraws the label of the widget

fn resize(&mut self, x: i32, y: i32, width: i32, height: i32)

Resizes and/or moves the widget, takes x, y, width and height

fn widget_resize(&mut self, x: i32, y: i32, width: i32, height: i32)

Does a simple resize ignoring class-specific resize functionality

fn tooltip(&self) -> Option<String>

Returns the tooltip text

fn set_tooltip(&mut self, txt: &str)

Sets the tooltip text

fn color(&self) -> Color

Returns the widget color

fn set_color(&mut self, color: Color)

Sets the widget’s color

fn label_color(&self) -> Color

Returns the widget label’s color

fn set_label_color(&mut self, color: Color)

Sets the widget label’s color

fn label_font(&self) -> Font

Returns the widget label’s font

fn set_label_font(&mut self, font: Font)

Sets the widget label’s font

fn label_size(&self) -> i32

Returns the widget label’s size

fn set_label_size(&mut self, sz: i32)

Sets the widget label’s size

fn label_type(&self) -> LabelType

Returns the widget label’s type

fn set_label_type(&mut self, typ: LabelType)

Sets the widget label’s type

fn frame(&self) -> FrameType

Returns the widget’s frame type

fn set_frame(&mut self, typ: FrameType)

Sets the widget’s frame type

fn changed(&self) -> bool

Returns whether the widget was changed

fn set_changed(&mut self)

Mark the widget as changed

fn clear_changed(&mut self)

Clears the changed status of the widget

fn align(&self) -> Align

Returns the alignment of the widget

fn set_align(&mut self, align: Align)

Sets the alignment of the widget

fn set_when(&mut self, trigger: When)

Sets the default callback trigger for a widget, equivalent to when()

fn when(&self) -> When

Return the callback trigger, equivalent to when()

fn parent(&self) -> Option<Group>

Returns the parent of the widget

fn selection_color(&self) -> Color

Gets the selection color of the widget

fn set_selection_color(&mut self, color: Color)

Sets the selection color of the widget

fn do_callback(&mut self)

Runs the already registered callback

fn window(&self) -> Option<Box<dyn WindowExt>>

Returns the direct window holding the widget

fn top_window(&self) -> Option<Box<dyn WindowExt>>

Returns the topmost window holding the widget

fn takes_events(&self) -> bool

Checks whether a widget is capable of taking events

fn take_focus(&mut self) -> Result<(), FltkError>

Make the widget take focus

fn set_visible_focus(&mut self)

Set the widget to have visible focus

fn clear_visible_focus(&mut self)

Clear visible focus

fn visible_focus(&mut self, v: bool)

Set the visible focus using a flag

fn has_visible_focus(&self) -> bool

Return whether the widget has visible focus

fn has_focus(&self) -> bool

Return whether the widget has focus

fn was_deleted(&self) -> bool

Check if a widget was deleted

fn damage(&self) -> bool

Return whether the widget was damaged

fn set_damage(&mut self, flag: bool)

Signal the widget as damaged and it should be redrawn in the next event loop cycle

fn damage_type(&self) -> Damage

Return the damage mask

fn set_damage_type(&mut self, mask: Damage)

Signal the type of damage a widget received

fn set_damage_area(&mut self, mask: Damage, x: i32, y: i32, w: i32, h: i32)

Signal damage for an area inside the widget

fn clear_damage(&mut self)

Clear the damaged flag

fn as_window(&self) -> Option<Box<dyn WindowExt>>

Return the widget as a window if it’s a window

fn as_group(&self) -> Option<Group>

Return the widget as a group widget if it’s a group widget

fn inside<W: WidgetExt>(&self, wid: &W) -> bool

Checks whether the self widget is inside another widget

fn get_type<T: WidgetType>(&self) -> T

Returns the widget type when applicable

fn set_type<T: WidgetType>(&mut self, typ: T)

Sets the widget type

fn set_image<I: ImageExt>(&mut self, image: Option<I>)

Sets the image of the widget

fn set_image_scaled<I: ImageExt>(&mut self, image: Option<I>)

Sets the image of the widget scaled to the widget’s size

fn image(&self) -> Option<Box<dyn ImageExt>>

Gets the image associated with the widget

fn set_deimage<I: ImageExt>(&mut self, image: Option<I>)

Sets the deactivated image of the widget

fn set_deimage_scaled<I: ImageExt>(&mut self, image: Option<I>)

Sets the deactivated image of the widget scaled to the widget’s size

fn deimage(&self) -> Option<Box<dyn ImageExt>>

Gets the deactivated image associated with the widget

fn set_callback<F: FnMut(&mut Self) + 'static>(&mut self, cb: F)

Sets the callback when the widget is triggered (clicks for example) takes the widget as a closure argument

fn emit<T: 'static + Clone + Send + Sync>(&mut self, sender: Sender<T>, msg: T)

Emits a message on callback using a sender

unsafe fn as_widget<W: WidgetBase>(&self) -> W

Upcast a WidgetExt to some widget type

fn visible(&self) -> bool

Returns whether a widget is visible

fn visible_r(&self) -> bool

Returns whether a widget or any of its parents are visible (recursively)

fn is_same<W: WidgetExt>(&self, other: &W) -> bool

Return whether two widgets object point to the same widget

fn active(&self) -> bool

Returns whether a widget is active

fn active_r(&self) -> bool

Returns whether a widget or any of its parents are active (recursively)

fn handle_event(&mut self, event: Event) -> bool

Handle a specific event

fn is_derived(&self) -> bool

Check whether a widget is derived

fn as_base_widget(&self) -> Widget

where Self: Sized,

Upcast a WidgetExt to a Widget

impl WidgetProps for DoubleWindow

fn with_pos(self, x: i32, y: i32) -> Self

Initialize to position x, y

fn with_size(self, width: i32, height: i32) -> Self

Initialize to size width, height

fn with_label(self, title: &str) -> Self

Initialize with a label

fn with_align(self, align: Align) -> Self

Initialize with alignment

fn with_type<T: WidgetType>(self, typ: T) -> Self

Initialize with type

fn below_of<W: WidgetExt>(self, wid: &W, padding: i32) -> Self

Initialize at bottom of another widget

fn above_of<W: WidgetExt>(self, wid: &W, padding: i32) -> Self

Initialize above of another widget

fn right_of<W: WidgetExt>(self, wid: &W, padding: i32) -> Self

Initialize right of another widget

fn left_of<W: WidgetExt>(self, wid: &W, padding: i32) -> Self

Initialize left of another widget

fn center_of<W: WidgetExt>(self, w: &W) -> Self

Initialize center of another widget

fn center_x<W: WidgetExt>(self, w: &W) -> Self

Initialize center of another widget on the x axis

fn center_y<W: WidgetExt>(self, w: &W) -> Self

Initialize center of another widget on the y axis

fn center_of_parent(self) -> Self

Initialize center of parent

fn size_of<W: WidgetExt>(self, w: &W) -> Self

Initialize to the size of another widget

fn size_of_parent(self) -> Self

Initialize to the size of the parent

impl WindowExt for DoubleWindow

fn set_center_screen(&mut self)

Positions the window to the center of the screen

fn make_modal(&mut self, val: bool)

Makes a window modal, should be called before show

fn fullscreen(&mut self, val: bool)

Makes a window fullscreen. Requires that the window is resizable.

fn make_current(&mut self)

Makes the window current

fn icon(&self) -> Option<Box<dyn ImageExt>>

Returns the icon of the window

fn set_icon(&mut self, image: Option<RgbImage>)

Sets the windows icon. Supported formats are bmp, jpeg, png and rgb.

fn set_cursor(&mut self, cursor: Cursor)

Sets the cursor style within the window. Needs to be called after the window is shown

fn shown(&self) -> bool

Returns whether a window is shown

fn set_border(&mut self, flag: bool)

Sets whether the window has a border

fn border(&self) -> bool

Returns whether a window has a border

fn free_position(&mut self)

Frees the position of the window

fn raw_handle(&self) -> RawHandle

Get the raw system handle of the window

fn region(&self) -> Region

Get the graphical draw region of the window

unsafe fn set_region(&mut self, region: Region)

Set the graphical draw region of the window

fn iconize(&mut self)

Iconifies the window. You can tell that the window is iconized by checking that it’s shown and not visible

fn fullscreen_active(&self) -> bool

Returns whether the window is fullscreen or not

fn decorated_w(&self) -> i32

Returns the decorated width

fn decorated_h(&self) -> i32

Returns the decorated height

fn size_range(&mut self, min_w: i32, min_h: i32, max_w: i32, max_h: i32)

Set the window’s minimum width, minimum height, max width and max height. You can pass 0 as max_w and max_h to allow unlimited upward resize of the window.

fn hotspot<W: WidgetExt>(&mut self, w: &W)

Set the hotspot widget of the window

fn set_shape(&mut self, image: Option<RgbImage>)

Set the shape of the window. Supported image formats are BMP, RGB and Pixmap. The window covers non-transparent/non-black shape of the image. The image must not be scaled(resized) beforehand. The size will be adapted to the window’s size

fn shape(&self) -> Option<Box<dyn ImageExt>>

Get the shape of the window

fn x_root(&self) -> i32

Get the window’s x coord from the screen

fn y_root(&self) -> i32

Get the window’s y coord from the screen

fn set_cursor_image(&mut self, image: RgbImage, hot_x: i32, hot_y: i32)

Set the cursor image

fn default_cursor(&mut self, cursor: Cursor)

Set the window’s default cursor

fn screen_num(&self) -> i32

Get the screen number

fn set_screen_num(&mut self, n: i32)

Set the screen number

fn wait_for_expose(&self)

wait for the window to be displayed after calling show(). More info here

fn opacity(&self) -> f64

Get the window’s opacity

fn set_opacity(&mut self, val: f64)

Set the window’s opacity, Ranges from 0.0 to 1.0, where 1.0 is fully opaque and 0.0 is fully transparent. This should be called on a shown window. On X11, opacity support depends on the window manager and can be queried:

fn xclass(&self) -> Option<String>

Get the window’s XA_WM_CLASS property

fn set_xclass(&mut self, s: &str)

Set the window’s XA_WM_CLASS property. This should be called before showing the window

fn clear_modal_states(&mut self)

Clear the modal state of the window

fn force_position(&mut self, flag: bool)

Forces the position of the window

fn set_override(&mut self)

removes the window border and sets the window on top, by settings the NOBORDER and OVERRIDE flags

fn is_override(&self) -> bool

Checks whether the OVERRIDE flag was set

fn set_icon_label(&mut self, label: &str)

Set the icon label

fn icon_label(&self) -> Option<String>

Get the icon label

impl Eq for DoubleWindow

impl Send for DoubleWindow

Available on non-crate feature single-threaded only.

impl Sync for DoubleWindow

Available on non-crate feature single-threaded only.