Skip to main content

Window

Struct Window 

Source
pub struct Window { /* private fields */ }
Expand description

User-facing window builder.

Implementations§

Source§

impl Window

Source

pub fn new(title: impl Into<String>) -> Self

Create a window with a title and the default SUI icon.

Examples found in repository?
examples/quickstart.rs (line 33)
3fn main() -> Result<()> {
4    let theme = DefaultTheme::light();
5
6    let content = Stack::vertical()
7        .gap(12.0)
8        .alignment(Alignment::Start)
9        .with_child(
10            Label::new("Your first SUI window")
11                .theme(theme)
12                .font_size(24.0)
13                .line_height(30.0)
14                .color(theme.palette.text),
15        )
16        .with_child(
17            Label::new("Widgets are retained Rust values arranged into one tree.")
18                .theme(theme)
19                .color(theme.palette.text_muted),
20        )
21        .with_child(
22            Button::new("Say hello")
23                .theme(theme)
24                .on_press(|| println!("Hello from SUI!")),
25        );
26
27    let root = Surface::window(content)
28        .theme(theme)
29        .padding(Insets::all(24.0))
30        .fill();
31
32    App::new()
33        .window(Window::new("SUI Quickstart").root(root))
34        .run()
35}
More examples
Hide additional examples
examples/rich_document.rs (line 36)
3fn main() -> Result<()> {
4    let theme = DefaultTheme::dark();
5    let document = RichDocumentModel::from_markdown(
6        r#"# Deployment report
7
8SUI keeps this document selectable across blocks. Follow the [runbook](https://example.test/runbook) for details.
9
10- [x] Build artifacts
11- [x] Run tests
12- [ ] Publish release
13
14```rust
15let status = deploy().await?;
16assert!(status.ready());
17```
18"#,
19    );
20
21    let mut operation = RichExtensionBlock::new("operation-log", "Release operation");
22    operation.status = RichDocumentStatus::Running;
23    operation.summary = Some("2 of 3 stages complete".into());
24    operation.body = "build   complete\ntest    complete\npublish running".into();
25    document.append_extension(operation);
26
27    let view = RichDocumentView::new(document)
28        .theme(theme)
29        .on_link(|destination| println!("Application URL policy received: {destination}"));
30    let root = Surface::window(ScrollView::vertical(view).retain_content_layer())
31        .theme(theme)
32        .padding(Insets::all(24.0))
33        .fill();
34
35    App::new()
36        .window(Window::new("SUI Rich Document").root(root))
37        .run()
38}
examples/commands.rs (line 51)
6fn main() -> Result<()> {
7    let worker_status = Signal::named(
8        "worker_status",
9        "Waiting for the background worker…".to_string(),
10    );
11    let application_status = Signal::named(
12        "application_status",
13        "No application multicast received yet.".to_string(),
14    );
15    let window_status = Signal::named(
16        "window_status",
17        "No window multicast received yet.".to_string(),
18    );
19
20    let worker_handler = worker_status.clone();
21    let application_handler = application_status.clone();
22    let window_handler = window_status.clone();
23    let root = Padding::all(
24        24.0,
25        Stack::vertical()
26            .gap(12.0)
27            .alignment(Alignment::Stretch)
28            .with_child(Label::new("Typed commands"))
29            .with_child(Label::new("").text_from(worker_status))
30            .with_child(Label::new("").text_from(application_status))
31            .with_child(Label::new("").text_from(window_status))
32            .with_child(
33                Button::new("Broadcast announcement").on_press_with_ctx(|ctx| {
34                    ctx.command_sender().broadcast_application(
35                        ANNOUNCEMENT,
36                        "Hello from a widget callback".to_string(),
37                    );
38                }),
39            ),
40    );
41
42    App::new()
43        .on_command(WORK_FINISHED, move |ctx, message| {
44            worker_handler.set(format!("Worker result: {message}"));
45            ctx.set_handled();
46        })
47        .on_command(ANNOUNCEMENT, move |_, message| {
48            application_handler.set(format!("Application received: {message}"));
49        })
50        .window(
51            Window::new("Commands")
52                .on_command(ANNOUNCEMENT, move |_, message| {
53                    window_handler.set(format!("Window received: {message}"));
54                })
55                .root(root),
56        )
57        .run_with_handle(|ui| {
58            std::thread::spawn(move || {
59                // Replace this with blocking I/O or CPU work.
60                ui.send_application(WORK_FINISHED, "loaded".to_string());
61            });
62        })
63}
examples/stateful_form.rs (line 148)
69fn main() -> Result<()> {
70    let theme = DefaultTheme::dark();
71    let state = Rc::new(RefCell::new(FormState::default()));
72
73    let name_state = Rc::clone(&state);
74    let name = TextInput::new("Display name")
75        .placeholder("Ada Lovelace")
76        .min_width(360.0)
77        .theme(theme)
78        .on_change_with_ctx(move |ctx, value| {
79            name_state.borrow_mut().name = value;
80            refresh_window(ctx);
81        });
82
83    let password_state = Rc::clone(&state);
84    let password = PasswordInput::new("Password")
85        .placeholder("At least eight characters")
86        .min_width(360.0)
87        .theme(theme)
88        .on_change_with_ctx(move |ctx, value| {
89            password_state.borrow_mut().password = value;
90            refresh_window(ctx);
91        });
92
93    let initial_schedule = state.borrow().scheduled_for.clone();
94    let schedule_state = Rc::clone(&state);
95    let scheduled_for = DateTimeInput::new("Scheduled for")
96        .value(initial_schedule)
97        .min_width(360.0)
98        .theme(theme)
99        .on_change_with_ctx(move |ctx, value| {
100            schedule_state.borrow_mut().scheduled_for = value;
101            refresh_window(ctx);
102        });
103
104    let status_state = Rc::clone(&state);
105    let status = Label::new("Draft")
106        .text_when(move || status_state.borrow().status())
107        .theme(theme)
108        .color(theme.palette.text_muted);
109
110    let enabled_state = Rc::clone(&state);
111    let submit_state = Rc::clone(&state);
112    let submit = Button::new("Save profile")
113        .theme(theme)
114        .enabled_when(move || enabled_state.borrow().can_submit())
115        .on_press_with_ctx(move |ctx| {
116            submit_state.borrow_mut().submissions += 1;
117            refresh_window(ctx);
118        });
119
120    let form = Stack::vertical()
121        .gap(12.0)
122        .alignment(Alignment::Start)
123        .with_child(
124            Label::new("Create a profile")
125                .theme(theme)
126                .font_size(26.0)
127                .line_height(32.0)
128                .color(theme.palette.text),
129        )
130        .with_child(
131            Label::new("Enter a name, password, and local appointment time.")
132                .theme(theme)
133                .color(theme.palette.text_muted),
134        )
135        .with_child(name)
136        .with_child(password)
137        .with_child(scheduled_for)
138        .with_child(submit)
139        .with_child(status);
140
141    let card = Surface::panel(form).theme(theme).padding(Insets::all(20.0));
142    let root = Surface::window(card)
143        .theme(theme)
144        .padding(Insets::all(24.0))
145        .fill();
146
147    App::new()
148        .window(Window::new("Stateful SUI Form").root(root))
149        .run()
150}
Source

pub fn root<W>(self, root: W) -> Self
where W: Widget + 'static,

Set the window root widget.

Examples found in repository?
examples/quickstart.rs (line 33)
3fn main() -> Result<()> {
4    let theme = DefaultTheme::light();
5
6    let content = Stack::vertical()
7        .gap(12.0)
8        .alignment(Alignment::Start)
9        .with_child(
10            Label::new("Your first SUI window")
11                .theme(theme)
12                .font_size(24.0)
13                .line_height(30.0)
14                .color(theme.palette.text),
15        )
16        .with_child(
17            Label::new("Widgets are retained Rust values arranged into one tree.")
18                .theme(theme)
19                .color(theme.palette.text_muted),
20        )
21        .with_child(
22            Button::new("Say hello")
23                .theme(theme)
24                .on_press(|| println!("Hello from SUI!")),
25        );
26
27    let root = Surface::window(content)
28        .theme(theme)
29        .padding(Insets::all(24.0))
30        .fill();
31
32    App::new()
33        .window(Window::new("SUI Quickstart").root(root))
34        .run()
35}
More examples
Hide additional examples
examples/rich_document.rs (line 36)
3fn main() -> Result<()> {
4    let theme = DefaultTheme::dark();
5    let document = RichDocumentModel::from_markdown(
6        r#"# Deployment report
7
8SUI keeps this document selectable across blocks. Follow the [runbook](https://example.test/runbook) for details.
9
10- [x] Build artifacts
11- [x] Run tests
12- [ ] Publish release
13
14```rust
15let status = deploy().await?;
16assert!(status.ready());
17```
18"#,
19    );
20
21    let mut operation = RichExtensionBlock::new("operation-log", "Release operation");
22    operation.status = RichDocumentStatus::Running;
23    operation.summary = Some("2 of 3 stages complete".into());
24    operation.body = "build   complete\ntest    complete\npublish running".into();
25    document.append_extension(operation);
26
27    let view = RichDocumentView::new(document)
28        .theme(theme)
29        .on_link(|destination| println!("Application URL policy received: {destination}"));
30    let root = Surface::window(ScrollView::vertical(view).retain_content_layer())
31        .theme(theme)
32        .padding(Insets::all(24.0))
33        .fill();
34
35    App::new()
36        .window(Window::new("SUI Rich Document").root(root))
37        .run()
38}
examples/commands.rs (line 55)
6fn main() -> Result<()> {
7    let worker_status = Signal::named(
8        "worker_status",
9        "Waiting for the background worker…".to_string(),
10    );
11    let application_status = Signal::named(
12        "application_status",
13        "No application multicast received yet.".to_string(),
14    );
15    let window_status = Signal::named(
16        "window_status",
17        "No window multicast received yet.".to_string(),
18    );
19
20    let worker_handler = worker_status.clone();
21    let application_handler = application_status.clone();
22    let window_handler = window_status.clone();
23    let root = Padding::all(
24        24.0,
25        Stack::vertical()
26            .gap(12.0)
27            .alignment(Alignment::Stretch)
28            .with_child(Label::new("Typed commands"))
29            .with_child(Label::new("").text_from(worker_status))
30            .with_child(Label::new("").text_from(application_status))
31            .with_child(Label::new("").text_from(window_status))
32            .with_child(
33                Button::new("Broadcast announcement").on_press_with_ctx(|ctx| {
34                    ctx.command_sender().broadcast_application(
35                        ANNOUNCEMENT,
36                        "Hello from a widget callback".to_string(),
37                    );
38                }),
39            ),
40    );
41
42    App::new()
43        .on_command(WORK_FINISHED, move |ctx, message| {
44            worker_handler.set(format!("Worker result: {message}"));
45            ctx.set_handled();
46        })
47        .on_command(ANNOUNCEMENT, move |_, message| {
48            application_handler.set(format!("Application received: {message}"));
49        })
50        .window(
51            Window::new("Commands")
52                .on_command(ANNOUNCEMENT, move |_, message| {
53                    window_handler.set(format!("Window received: {message}"));
54                })
55                .root(root),
56        )
57        .run_with_handle(|ui| {
58            std::thread::spawn(move || {
59                // Replace this with blocking I/O or CPU work.
60                ui.send_application(WORK_FINISHED, "loaded".to_string());
61            });
62        })
63}
examples/stateful_form.rs (line 148)
69fn main() -> Result<()> {
70    let theme = DefaultTheme::dark();
71    let state = Rc::new(RefCell::new(FormState::default()));
72
73    let name_state = Rc::clone(&state);
74    let name = TextInput::new("Display name")
75        .placeholder("Ada Lovelace")
76        .min_width(360.0)
77        .theme(theme)
78        .on_change_with_ctx(move |ctx, value| {
79            name_state.borrow_mut().name = value;
80            refresh_window(ctx);
81        });
82
83    let password_state = Rc::clone(&state);
84    let password = PasswordInput::new("Password")
85        .placeholder("At least eight characters")
86        .min_width(360.0)
87        .theme(theme)
88        .on_change_with_ctx(move |ctx, value| {
89            password_state.borrow_mut().password = value;
90            refresh_window(ctx);
91        });
92
93    let initial_schedule = state.borrow().scheduled_for.clone();
94    let schedule_state = Rc::clone(&state);
95    let scheduled_for = DateTimeInput::new("Scheduled for")
96        .value(initial_schedule)
97        .min_width(360.0)
98        .theme(theme)
99        .on_change_with_ctx(move |ctx, value| {
100            schedule_state.borrow_mut().scheduled_for = value;
101            refresh_window(ctx);
102        });
103
104    let status_state = Rc::clone(&state);
105    let status = Label::new("Draft")
106        .text_when(move || status_state.borrow().status())
107        .theme(theme)
108        .color(theme.palette.text_muted);
109
110    let enabled_state = Rc::clone(&state);
111    let submit_state = Rc::clone(&state);
112    let submit = Button::new("Save profile")
113        .theme(theme)
114        .enabled_when(move || enabled_state.borrow().can_submit())
115        .on_press_with_ctx(move |ctx| {
116            submit_state.borrow_mut().submissions += 1;
117            refresh_window(ctx);
118        });
119
120    let form = Stack::vertical()
121        .gap(12.0)
122        .alignment(Alignment::Start)
123        .with_child(
124            Label::new("Create a profile")
125                .theme(theme)
126                .font_size(26.0)
127                .line_height(32.0)
128                .color(theme.palette.text),
129        )
130        .with_child(
131            Label::new("Enter a name, password, and local appointment time.")
132                .theme(theme)
133                .color(theme.palette.text_muted),
134        )
135        .with_child(name)
136        .with_child(password)
137        .with_child(scheduled_for)
138        .with_child(submit)
139        .with_child(status);
140
141    let card = Surface::panel(form).theme(theme).padding(Insets::all(20.0));
142    let root = Surface::window(card)
143        .theme(theme)
144        .padding(Insets::all(24.0))
145        .fill();
146
147    App::new()
148        .window(Window::new("Stateful SUI Form").root(root))
149        .run()
150}
Source

pub fn controller(self, controller: impl CommandController + 'static) -> Self

Attach a controller owned by this window rather than by its widget tree.

Source

pub fn on_command<T, F>(self, key: CommandKey<T>, handler: F) -> Self
where T: Send + Sync + 'static, F: FnMut(&mut CommandCtx, &T) + 'static,

Subscribe a lifecycle-safe handler owned by this window.

Examples found in repository?
examples/commands.rs (lines 52-54)
6fn main() -> Result<()> {
7    let worker_status = Signal::named(
8        "worker_status",
9        "Waiting for the background worker…".to_string(),
10    );
11    let application_status = Signal::named(
12        "application_status",
13        "No application multicast received yet.".to_string(),
14    );
15    let window_status = Signal::named(
16        "window_status",
17        "No window multicast received yet.".to_string(),
18    );
19
20    let worker_handler = worker_status.clone();
21    let application_handler = application_status.clone();
22    let window_handler = window_status.clone();
23    let root = Padding::all(
24        24.0,
25        Stack::vertical()
26            .gap(12.0)
27            .alignment(Alignment::Stretch)
28            .with_child(Label::new("Typed commands"))
29            .with_child(Label::new("").text_from(worker_status))
30            .with_child(Label::new("").text_from(application_status))
31            .with_child(Label::new("").text_from(window_status))
32            .with_child(
33                Button::new("Broadcast announcement").on_press_with_ctx(|ctx| {
34                    ctx.command_sender().broadcast_application(
35                        ANNOUNCEMENT,
36                        "Hello from a widget callback".to_string(),
37                    );
38                }),
39            ),
40    );
41
42    App::new()
43        .on_command(WORK_FINISHED, move |ctx, message| {
44            worker_handler.set(format!("Worker result: {message}"));
45            ctx.set_handled();
46        })
47        .on_command(ANNOUNCEMENT, move |_, message| {
48            application_handler.set(format!("Application received: {message}"));
49        })
50        .window(
51            Window::new("Commands")
52                .on_command(ANNOUNCEMENT, move |_, message| {
53                    window_handler.set(format!("Window received: {message}"));
54                })
55                .root(root),
56        )
57        .run_with_handle(|ui| {
58            std::thread::spawn(move || {
59                // Replace this with blocking I/O or CPU work.
60                ui.send_application(WORK_FINISHED, "loaded".to_string());
61            });
62        })
63}
Source

pub fn icon(self, icon: WindowIcon) -> Self

Set a platform icon.

Source

pub fn icon_svg(self, svg: impl Into<Vec<u8>>) -> Self

Set an SVG platform icon.

Source

pub fn without_icon(self) -> Self

Remove the platform icon.

Source

pub fn initial_size(self, size: Size) -> Self

Request an initial logical client size for the native window.

Source

pub fn initial_position(self, position: Point) -> Self

Request an initial physical desktop position for the native window.

Desktop hosts may adjust or ignore an unsafe position after monitor topology changes.

Auto Trait Implementations§

§

impl !Freeze for Window

§

impl !RefUnwindSafe for Window

§

impl !Send for Window

§

impl !Sync for Window

§

impl !UnwindSafe for Window

§

impl Forget for Window

§

impl Move for Window

§

impl Unpin for Window

§

impl UnsafeUnpin for Window

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more