Struct AppLauncher

pub struct AppLauncher<T> { /* private fields */ }

Handles initial setup of an application, and starts the runloop.

Implementations

impl<T: Data> AppLauncher<T>

pub fn with_window(window: WindowDesc<T>) -> Self

Create a new AppLauncher with the provided window.

Examples found in repository

examples/layout.rs (line 82)

pub fn main() {
    let window = WindowDesc::new(build_app()).title("Very flexible");

    AppLauncher::with_window(window)
        .log_to_console()
        .launch(0)
        .expect("launch failed");
}

examples/either.rs (line 52)

pub fn main() {
    let main_window = WindowDesc::new(ui_builder()).title("Switcheroo");
    AppLauncher::with_window(main_window)
        .log_to_console()
        .launch(AppState::default())
        .expect("launch failed");
}

examples/custom_widget.rs (line 158)

pub fn main() {
    let window = WindowDesc::new(CustomWidget {}).title(LocalizedString::new("Fancy Colors"));
    AppLauncher::with_window(window)
        .log_to_console()
        .launch("Druid + Piet".to_string())
        .expect("launch failed");
}

examples/split_demo.rs (line 85)

pub fn main() {
    let window = WindowDesc::new(build_app())
        .title(LocalizedString::new("split-demo-window-title").with_placeholder("Split Demo"));
    AppLauncher::with_window(window)
        .log_to_console()
        .launch(0u32)
        .expect("launch failed");
}

examples/scroll.rs (line 30)

pub fn main() {
    let window = WindowDesc::new(build_widget())
        .title(LocalizedString::new("scroll-demo-window-title").with_placeholder("Scroll demo"));
    AppLauncher::with_window(window)
        .log_to_console()
        .launch(0u32)
        .expect("launch failed");
}

examples/identity.rs (line 51)

pub fn main() {
    let window = WindowDesc::new(make_ui()).title("identity example");
    let data = OurData {
        counter_one: 0,
        counter_two: 0,
    };
    AppLauncher::with_window(window)
        .log_to_console()
        .launch(data)
        .expect("launch failed");
}

Additional examples can be found in:

• examples/blocking_function.rs
• examples/panels.rs
• examples/svg.rs
• examples/anim.rs
• examples/scroll_colors.rs
• examples/view_switcher.rs
• examples/lens.rs
• examples/open_save.rs
• examples/switches.rs
• examples/transparency.rs
• examples/invalidation.rs
• examples/multiwin.rs
• examples/timer.rs
• examples/styled_text.rs
• examples/disabled.rs
• examples/z_stack.rs
• examples/list.rs
• examples/calc.rs
• examples/hello.rs
• examples/slider.rs
• examples/textbox.rs
• examples/markdown_preview.rs
• examples/sub_window.rs
• examples/tabs.rs
• examples/event_viewer.rs
• examples/game_of_life.rs
• examples/input_region.rs
• examples/flex.rs
• examples/async_event.rs
• examples/text.rs

pub fn configure_env(self, f: impl Fn(&mut Env, &T) + 'static) -> Self

Provide an optional closure that will be given mutable access to the environment and immutable access to the app state before launch.

This can be used to set or override theme values.

Examples found in repository

examples/event_viewer.rs (lines 340-345)

pub fn main() {
    //describe the main window
    let main_window = WindowDesc::new(build_root_widget())
        .title("Event Viewer")
        .window_size((760.0, 680.0));

    //start the application
    AppLauncher::with_window(main_window)
        .log_to_console()
        .configure_env(|env, _| {
            env.set(theme::UI_FONT, FontDescriptor::default().with_size(12.0));
            env.set(theme::TEXT_COLOR, TEXT_COLOR);
            env.set(theme::WIDGET_PADDING_HORIZONTAL, 2.0);
            env.set(theme::WIDGET_PADDING_VERTICAL, 2.0);
        })
        .launch(AppState {
            text_input: String::new(),
            events: Arc::new(Vec::new()),
        })
        .expect("Failed to launch application");
}

pub fn delegate(self, delegate: impl AppDelegate<T> + 'static) -> Self

Set the AppDelegate.

Examples found in repository

examples/blocking_function.rs (line 109)

fn main() {
    let main_window =
        WindowDesc::new(ui_builder()).title(LocalizedString::new("Blocking functions"));
    AppLauncher::with_window(main_window)
        .delegate(Delegate {})
        .log_to_console()
        .launch(AppState::default())
        .expect("launch failed");
}

examples/open_save.rs (line 33)

pub fn main() {
    let main_window = WindowDesc::new(ui_builder())
        .title(LocalizedString::new("open-save-demo").with_placeholder("Opening/Saving Demo"));
    let data = "Type here.".to_owned();
    AppLauncher::with_window(main_window)
        .delegate(Delegate)
        .log_to_console()
        .launch(data)
        .expect("launch failed");
}

examples/multiwin.rs (lines 43-45)

pub fn main() {
    let main_window = WindowDesc::new(ui_builder()).menu(make_menu).title(
        LocalizedString::new("multiwin-demo-window-title").with_placeholder("Many windows!"),
    );
    AppLauncher::with_window(main_window)
        .delegate(Delegate {
            windows: Vec::new(),
        })
        .log_to_console()
        .launch(State::default())
        .expect("launch failed");
}

examples/markdown_preview.rs (line 110)

pub fn main() {
    // describe the main window
    let main_window = WindowDesc::new(build_root_widget())
        .title(WINDOW_TITLE)
        .menu(make_menu)
        .window_size((700.0, 600.0));

    // create the initial app state
    let initial_state = AppState {
        raw: TEXT.to_owned(),
        rendered: rebuild_rendered_text(TEXT),
    };

    // start the application
    AppLauncher::with_window(main_window)
        .log_to_console()
        .delegate(Delegate)
        .launch(initial_state)
        .expect("Failed to launch application");
}

pub fn start_console_logging(self, enable: bool) -> Self

Initialize a minimal tracing subscriber with DEBUG max level for printing logs out to stderr.

This is meant for quick-and-dirty debugging. If you want more serious trace handling, it’s probably better to implement it yourself.

Panics

Panics if enable is true and the subscriber fails to initialize, for example if a tracing/tracing_wasm global logger was already set.

Never panics when enable is false, or have any other side effect.

Passing in false is useful if you want to enable a global logger as feature but log to console otherwise.

pub fn log_to_console(self) -> Self

Calls start_console_logging with true.

Examples found in repository

examples/layout.rs (line 83)

pub fn main() {
    let window = WindowDesc::new(build_app()).title("Very flexible");

    AppLauncher::with_window(window)
        .log_to_console()
        .launch(0)
        .expect("launch failed");
}

examples/either.rs (line 53)

pub fn main() {
    let main_window = WindowDesc::new(ui_builder()).title("Switcheroo");
    AppLauncher::with_window(main_window)
        .log_to_console()
        .launch(AppState::default())
        .expect("launch failed");
}

examples/custom_widget.rs (line 159)

pub fn main() {
    let window = WindowDesc::new(CustomWidget {}).title(LocalizedString::new("Fancy Colors"));
    AppLauncher::with_window(window)
        .log_to_console()
        .launch("Druid + Piet".to_string())
        .expect("launch failed");
}

examples/split_demo.rs (line 86)

pub fn main() {
    let window = WindowDesc::new(build_app())
        .title(LocalizedString::new("split-demo-window-title").with_placeholder("Split Demo"));
    AppLauncher::with_window(window)
        .log_to_console()
        .launch(0u32)
        .expect("launch failed");
}

examples/scroll.rs (line 31)

pub fn main() {
    let window = WindowDesc::new(build_widget())
        .title(LocalizedString::new("scroll-demo-window-title").with_placeholder("Scroll demo"));
    AppLauncher::with_window(window)
        .log_to_console()
        .launch(0u32)
        .expect("launch failed");
}

examples/identity.rs (line 52)

pub fn main() {
    let window = WindowDesc::new(make_ui()).title("identity example");
    let data = OurData {
        counter_one: 0,
        counter_two: 0,
    };
    AppLauncher::with_window(window)
        .log_to_console()
        .launch(data)
        .expect("launch failed");
}

Additional examples can be found in:

• examples/blocking_function.rs
• examples/panels.rs
• examples/svg.rs
• examples/anim.rs
• examples/scroll_colors.rs
• examples/view_switcher.rs
• examples/open_save.rs
• examples/switches.rs
• examples/transparency.rs
• examples/invalidation.rs
• examples/multiwin.rs
• examples/timer.rs
• examples/styled_text.rs
• examples/disabled.rs
• examples/z_stack.rs
• examples/list.rs
• examples/calc.rs
• examples/hello.rs
• examples/slider.rs
• examples/textbox.rs
• examples/markdown_preview.rs
• examples/sub_window.rs
• examples/tabs.rs
• examples/event_viewer.rs
• examples/game_of_life.rs
• examples/input_region.rs
• examples/flex.rs
• examples/async_event.rs
• examples/text.rs

pub fn localization_resources( self, resources: Vec<String>, base_dir: String, ) -> Self

Use custom localization resource

resources is a list of file names that contain strings. base_dir is a path to a directory that includes per-locale subdirectories.

This directory should be of the structure base_dir/{locale}/{resource}, where ‘{locale}’ is a valid BCP47 language tag, and {resource} is a .ftl included in resources.

pub fn get_external_handle(&self) -> ExtEventSink

Returns an ExtEventSink that can be moved between threads, and can be used to submit commands back to the application.

Examples found in repository

examples/async_event.rs (line 39)

pub fn main() {
    let window = WindowDesc::new(make_ui()).title("External Event Demo");

    let launcher = AppLauncher::with_window(window);

    // If we want to create commands from another thread `launcher.get_external_handle()`
    // should be used. For sending commands from within widgets you can always call
    // `ctx.submit_command`
    let event_sink = launcher.get_external_handle();
    // We create a new thread and generate colours in it.
    // This happens on a second thread so that we can run the UI in the
    // main thread. Generating some colours nicely follows the pattern for what
    // should be done like this: generating something over time
    // (like this or reacting to external events), or something that takes a
    // long time and shouldn't block main UI updates.
    thread::spawn(move || generate_colors(event_sink));

    launcher
        .log_to_console()
        .launch(Color::BLACK)
        .expect("launch failed");
}

pub fn launch(self, data: T) -> Result<(), PlatformError>

Build the windows and start the runloop.

Returns an error if a window cannot be instantiated. This is usually a fatal error.

Examples found in repository

examples/layout.rs (line 84)

pub fn main() {
    let window = WindowDesc::new(build_app()).title("Very flexible");

    AppLauncher::with_window(window)
        .log_to_console()
        .launch(0)
        .expect("launch failed");
}

examples/either.rs (line 54)

pub fn main() {
    let main_window = WindowDesc::new(ui_builder()).title("Switcheroo");
    AppLauncher::with_window(main_window)
        .log_to_console()
        .launch(AppState::default())
        .expect("launch failed");
}

examples/custom_widget.rs (line 160)

pub fn main() {
    let window = WindowDesc::new(CustomWidget {}).title(LocalizedString::new("Fancy Colors"));
    AppLauncher::with_window(window)
        .log_to_console()
        .launch("Druid + Piet".to_string())
        .expect("launch failed");
}

examples/split_demo.rs (line 87)

pub fn main() {
    let window = WindowDesc::new(build_app())
        .title(LocalizedString::new("split-demo-window-title").with_placeholder("Split Demo"));
    AppLauncher::with_window(window)
        .log_to_console()
        .launch(0u32)
        .expect("launch failed");
}

examples/scroll.rs (line 32)

pub fn main() {
    let window = WindowDesc::new(build_widget())
        .title(LocalizedString::new("scroll-demo-window-title").with_placeholder("Scroll demo"));
    AppLauncher::with_window(window)
        .log_to_console()
        .launch(0u32)
        .expect("launch failed");
}

examples/identity.rs (line 53)

pub fn main() {
    let window = WindowDesc::new(make_ui()).title("identity example");
    let data = OurData {
        counter_one: 0,
        counter_two: 0,
    };
    AppLauncher::with_window(window)
        .log_to_console()
        .launch(data)
        .expect("launch failed");
}

Additional examples can be found in:

• examples/blocking_function.rs
• examples/panels.rs
• examples/svg.rs
• examples/anim.rs
• examples/scroll_colors.rs
• examples/view_switcher.rs
• examples/lens.rs
• examples/open_save.rs
• examples/switches.rs
• examples/transparency.rs
• examples/invalidation.rs
• examples/multiwin.rs
• examples/timer.rs
• examples/styled_text.rs
• examples/disabled.rs
• examples/z_stack.rs
• examples/list.rs
• examples/calc.rs
• examples/hello.rs
• examples/slider.rs
• examples/textbox.rs
• examples/markdown_preview.rs
• examples/sub_window.rs
• examples/tabs.rs
• examples/event_viewer.rs
• examples/game_of_life.rs
• examples/input_region.rs
• examples/flex.rs
• examples/async_event.rs
• examples/text.rs