fltk 0.3.5

Rust bindings for the FLTK GUI library
Documentation

fltk-rs

Rust bindings for the FLTK Graphical User Interface library.

The FLTK crate is a crossplatform lightweight gui library which can be statically linked to produce small, self-contained (no dependencies) and fast gui applications.

This crate is still in active development and is not production ready. However, you can still try it out and give valuable feedback.

Here is a list of software using FLTK.

Usage

Just add the following to your project's Cargo.toml file:

[dependencies]
fltk = "^0.3.5"

The library is automatically statically linked to your binary. If however you would prefer dynamic linking, you can use the fltk-shared feature:

[dependencies.fltk]
version = "^0.3.5"
features = ["fltk-shared"]

You can also enable ninja builds for a faster build of the C++ source using the "use-ninja" feature. Or if you have fltk already installed, you can use the fltk-system feature.

An example hello world application:

use fltk::{app::*, window::*};

fn main() {
    let app = App::default();
    let mut wind = Window::new(100, 100, 400, 300, "Hello from rust");
    wind.end();
    wind.show();
    app.run().unwrap();
}

Another example showing the basic callback functionality:

use fltk::{app::*, button::*, frame::*, window::*};

fn main() {
    let app = App::default();
    let mut wind = Window::new(100, 100, 400, 300, "Hello from rust");
    let mut frame = Frame::new(0, 0, 400, 200, "");
    let mut but = Button::new(160, 210, 80, 40, "Click me!");
    wind.end();
    wind.show();
    but.set_callback(Box::new(move || frame.set_label("Hello World!")));
    app.run().unwrap();
}

Please check the examples directory for more examples. You will notice that all widgets are instantiated with a new() method, taking the x and y coordinates, as well as the width and height of the widget. Most widgets, except the TextDisplay and TextEditor, also take a label which can be left blank if needed. Another way to initialize a widget is using the builder pattern: (The following buttons are equivalent)

let but1 = Button::new(10, 10, 80, 40, "Button 1");

let but2 = Button::default()
    .with_pos(10, 10)
    .with_size(80, 40)
    .with_label("Button 2");

An example of a counter showing use of the builder pattern:

fn main() {
    let app = app::App::default();
    let mut wind = Window::default()
        .with_size(160, 200)
        .center_screen()
        .with_label("Counter");
    let mut frame = Frame::default()
        .with_size(100, 40)
        .center_of(&wind)
        .with_label("0");
    let mut but_inc = Button::default()
        .size_of(&frame)
        .above_of(&frame, 0)
        .with_label("+");
    let mut but_dec = Button::default()
        .size_of(&frame)
        .below_of(&frame, 0)
        .with_label("-");
    wind.make_resizable(true);
    wind.end();
    wind.show();
    /* Event handling */
}

Events

Event handling must be done after the drawing is done and the main window shown. And must be done in fn main()

Events can be handled using the set_callback method (as above) or the available fltk::app::set_callback() free function, which will handle the default trigger of each widget(like clicks for buttons). For custom event handling, the handle() method can be used:

some_widget.handle(Box::new(move |ev: app::Event| {
    match ev {
        /* handle ev */
    }
}));

Handled or ignored events shoult return true, unhandled events should return false.

Theming

FLTK offers 4 application themes (called schemes):

  • Base
  • Gtk
  • Gleam
  • Plastic

These can be set using the App::set_scheme() function. Themes of individual widgets can be optionally modified using the provided methods in the WidgetExt trait, such as set_color(), set_label_font(), set_frame_type() etc:

    some_button.set_color(Color::Light1); // You can use one of the provided colors in the fltk enums
    some_button.set_color(Color::from_rgb(255, 0, 0)); // Or you can specify a color by rgb or hex/u32 value
    some_button.set_color(Color::from_u32(0xffebee));
    some_button.set_frame(FrameType::RoundUpBox);
    some_button.set_font(Font::TimesItalic);

Dependencies

CMake and a C++ compiler need to be installed and in your PATH for a crossplatform build.

  • Windows: No dependencies.
  • MacOs: No dependencies.
  • Linux: X11 development headers need to be installed for development.

For Debian-based distribution, that means running:

$ sudo apt-get install libx11-dev libxext-dev libxft-dev libxinerama-dev libxcursor-dev libxrender-dev libxfixes-dev

For RHEL-based distributions, that means running:

$ sudo yum groupinstall "X Software Development"

If you have ninja-build installed, you can enable it using the "use-ninja" feature. This should accelerate build times significantly.

Building

To build, just run:

$ git clone https://github.com/MoAlyousef/fltk-rs
$ cd fltk-rs
$ cargo build

Examples

To run the examples:

$ cargo run --example editor
$ cargo run --example calculator
$ cargo run --example gallery
$ cargo run --example terminal
$ cargo run --example counter
$ cargo run --example hello
$ cargo run --example hello_button
$ cargo run --example paint

alt_test

alt_test

Setting the scheme to Gtk.

alt_test

alt_test

Check the full code for the custom theming.

alt_test

Setting the scheme to Gtk

alt_test

Currently implemented widgets

Most common widgets are implemented:

  • Image widgets
    • BmpImage
    • JpegImage
    • GifImage
    • PngImage
    • SvgImage
  • Buttons
    • Button
    • RadioButton
    • ToggleButton
    • RoundButton
    • CheckButton
    • LightButton
    • RepeatButton
  • Dialogs
    • Native FileDialog
    • HelpDialog
  • Frame (Fl_Box)
  • Windows
    • Window
    • DoubleWindow
    • MenuWindow
  • Groups
    • Group
    • Pack
    • Tabs
    • Scroll
    • Tile
    • Wizard
  • Text display widgets
    • TextDisplay
    • TextEditor
    • SimpleTerminal
  • Input widgets
    • Input
    • IntInput
    • FloatInput
    • MultilineInput
    • SecretInput
    • FileInput
  • Output widgets
    • Output
    • MultilineOutput
  • Menu widgets
    • MenuBar
    • MenuItem
    • Choice (dropdown list)
  • Valuator widgets
    • Slider
    • NiceSlider
    • ValueSlider
    • Dial
    • LineDial
    • Counter
    • Scrollbar
    • Roller
    • Adjuster
    • ValueInput
  • Browsing widgets
    • Browser
    • SelectBrowser
    • HoldBrowser
    • MultiBrowser
    • FileBrowser
  • Miscelaneous widgets
    • Spinner
    • Clock
    • Chart
    • Progress (progress bar)
    • ColorChooser
    • Tooltip
  • Table widgets
    • Table
    • TableRow
  • Drawing primitives

Todo

  • Complete widget set
  • Better documentation
  • Better testing

Contributions

Contributions are very welcome!

License

Code licensed under the MIT license!