Struct relm4::RelmApp

pub struct RelmApp<M: Debug + 'static> { /* private fields */ }

An app that runs the main application.

Implementations

impl<M: Debug + 'static> RelmApp<M>

pub fn new(app_id: &str) -> Self

Create a new Relm4 application.

This function will create a new gtk::Application object if necessary.

If the libadwaita feature is enabled, then the created gtk::Application will be an instance of adw::Application. This can be overridden by passing your own application object to RelmApp::from_app.

Examples found in repository

examples/menu.rs (line 168)

fn main() {
    let app = RelmApp::new("relm4.example.menu");
    app.run::<App>(0);
}

examples/data_binding.rs (line 102)

fn main() {
    let app = RelmApp::new("relm4.example.simple");
    app.run::<App>(0);
}

examples/entry.rs (line 132)

fn main() {
    let app = RelmApp::new("relm4.example.entry");
    app.run::<App>(());
}

examples/simple.rs (line 76)

fn main() {
    let app = RelmApp::new("relm4.example.simple");
    app.run::<App>(0);
}

examples/to_do.rs (line 162)

fn main() {
    let app = RelmApp::new("relm4.example.to_do");
    app.run::<App>(());
}

examples/toast.rs (line 108)

fn main() {
    let app = RelmApp::new("relm4.example.toast");
    app.run::<App>(());
}

Additional examples can be found in:

• examples/factory.rs
• examples/factory_async.rs
• examples/factory_hash_map.rs
• examples/worker.rs
• examples/actions.rs
• examples/popover.rs
• examples/drawing.rs
• examples/tab_game.rs
• examples/components.rs
• examples/tab_factory.rs
• examples/grid_factory.rs
• examples/simple_manual.rs
• examples/leaflet_sidebar.rs
• examples/message_broker.rs
• examples/message_stream.rs
• examples/typed_grid_view.rs
• examples/typed_list_view.rs
• examples/transient_dialog.rs
• examples/typed_column_view.rs
• examples/progress.rs
• examples/simple_async.rs
• examples/non_blocking_async.rs
• examples/non_blocking_sync.rs
• examples/widget_template.rs
• examples/typed_list_view_async.rs
• examples/macro_reference.rs
• examples/tracker.rs
• examples/log.rs

pub fn from_app(app: impl IsA<Application>) -> Self

Create a Relm4 application with a provided gtk::Application.

pub fn with_broker(self, broker: &'static MessageBroker<M>) -> Self

Add MessageBroker to the top-level component.

pub fn with_args(self, args: Vec<String>) -> Self

Add command line arguments to run with.

pub fn visible_on_activate(self, visible: bool) -> Self

If true, make the window visible whenever the app is activated (e. g. every time RelmApp::run is called).

By default, this value is true. If you don’t want the window to be visible immediately (especially when using async components), you can set this to false and call WidgetExt::set_visible() manually on your window.

pub fn set_global_css(&self, style_data: &str)

Sets a custom global stylesheet.

Examples found in repository

examples/tracker.rs (line 125)

fn main() {
    let app = RelmApp::new("relm4.example.tracker");
    app.set_global_css(".identical { background: #00ad5c; }");

    app.run::<App>(());
}

pub fn set_global_css_from_file<P: AsRef<Path>>( &self, path: P ) -> Result<(), Error>

Sets a custom global stylesheet from a file.

If the file doesn’t exist a tracing::error message will be emitted and an std::io::Error will be returned.

pub fn run<C>(self, payload: C::Init)

where C: Component<Input = M>, C::Root: AsRef<Window>,

Runs the application, returns once the application is closed.

Examples found in repository

examples/menu.rs (line 169)

fn main() {
    let app = RelmApp::new("relm4.example.menu");
    app.run::<App>(0);
}

examples/data_binding.rs (line 103)

fn main() {
    let app = RelmApp::new("relm4.example.simple");
    app.run::<App>(0);
}

examples/entry.rs (line 133)

fn main() {
    let app = RelmApp::new("relm4.example.entry");
    app.run::<App>(());
}

examples/simple.rs (line 77)

fn main() {
    let app = RelmApp::new("relm4.example.simple");
    app.run::<App>(0);
}

examples/to_do.rs (line 163)

fn main() {
    let app = RelmApp::new("relm4.example.to_do");
    app.run::<App>(());
}

examples/toast.rs (line 109)

fn main() {
    let app = RelmApp::new("relm4.example.toast");
    app.run::<App>(());
}

Additional examples can be found in:

• examples/factory.rs
• examples/factory_async.rs
• examples/factory_hash_map.rs
• examples/worker.rs
• examples/actions.rs
• examples/popover.rs
• examples/drawing.rs
• examples/tab_game.rs
• examples/components.rs
• examples/tab_factory.rs
• examples/grid_factory.rs
• examples/simple_manual.rs
• examples/leaflet_sidebar.rs
• examples/message_broker.rs
• examples/message_stream.rs
• examples/typed_grid_view.rs
• examples/typed_list_view.rs
• examples/transient_dialog.rs
• examples/typed_column_view.rs
• examples/progress.rs
• examples/non_blocking_async.rs
• examples/non_blocking_sync.rs
• examples/widget_template.rs
• examples/typed_list_view_async.rs
• examples/macro_reference.rs
• examples/tracker.rs
• examples/log.rs

pub fn run_async<C>(self, payload: C::Init)

where C: AsyncComponent<Input = M>, C::Root: AsRef<Window>,

Runs the application, returns once the application is closed.

Examples found in repository

examples/simple_async.rs (line 108)

fn main() {
    let app = RelmApp::new("relm4.example.simple_async");
    app.run_async::<App>(0);
}

Trait Implementations

impl<M: Debug + Debug + 'static> Debug for RelmApp<M>

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

Formats the value using the given formatter.