pub struct Window { /* private fields */ }Expand description
User-facing window builder.
Implementations§
Source§impl Window
impl Window
Sourcepub fn new(title: impl Into<String>) -> Self
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 .spacing(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
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 .spacing(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 147)
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::dynamic("Draft", move || status_state.borrow().status())
106 .theme(theme)
107 .color(theme.palette.text_muted);
108
109 let enabled_state = Rc::clone(&state);
110 let submit_state = Rc::clone(&state);
111 let submit = Button::new("Save profile")
112 .theme(theme)
113 .enabled_when(move || enabled_state.borrow().can_submit())
114 .on_press_with_ctx(move |ctx| {
115 submit_state.borrow_mut().submissions += 1;
116 refresh_window(ctx);
117 });
118
119 let form = Stack::vertical()
120 .spacing(12.0)
121 .alignment(Alignment::Start)
122 .with_child(
123 Label::new("Create a profile")
124 .theme(theme)
125 .font_size(26.0)
126 .line_height(32.0)
127 .color(theme.palette.text),
128 )
129 .with_child(
130 Label::new("Enter a name, password, and local appointment time.")
131 .theme(theme)
132 .color(theme.palette.text_muted),
133 )
134 .with_child(name)
135 .with_child(password)
136 .with_child(scheduled_for)
137 .with_child(submit)
138 .with_child(status);
139
140 let card = Surface::panel(form).theme(theme).padding(Insets::all(20.0));
141 let root = Surface::window(card)
142 .theme(theme)
143 .padding(Insets::all(24.0))
144 .fill();
145
146 App::new()
147 .window(Window::new("Stateful SUI Form").root(root))
148 .run()
149}Sourcepub fn root<W>(self, root: W) -> Selfwhere
W: Widget + 'static,
pub fn root<W>(self, root: W) -> Selfwhere
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 .spacing(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
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 .spacing(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 147)
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::dynamic("Draft", move || status_state.borrow().status())
106 .theme(theme)
107 .color(theme.palette.text_muted);
108
109 let enabled_state = Rc::clone(&state);
110 let submit_state = Rc::clone(&state);
111 let submit = Button::new("Save profile")
112 .theme(theme)
113 .enabled_when(move || enabled_state.borrow().can_submit())
114 .on_press_with_ctx(move |ctx| {
115 submit_state.borrow_mut().submissions += 1;
116 refresh_window(ctx);
117 });
118
119 let form = Stack::vertical()
120 .spacing(12.0)
121 .alignment(Alignment::Start)
122 .with_child(
123 Label::new("Create a profile")
124 .theme(theme)
125 .font_size(26.0)
126 .line_height(32.0)
127 .color(theme.palette.text),
128 )
129 .with_child(
130 Label::new("Enter a name, password, and local appointment time.")
131 .theme(theme)
132 .color(theme.palette.text_muted),
133 )
134 .with_child(name)
135 .with_child(password)
136 .with_child(scheduled_for)
137 .with_child(submit)
138 .with_child(status);
139
140 let card = Surface::panel(form).theme(theme).padding(Insets::all(20.0));
141 let root = Surface::window(card)
142 .theme(theme)
143 .padding(Insets::all(24.0))
144 .fill();
145
146 App::new()
147 .window(Window::new("Stateful SUI Form").root(root))
148 .run()
149}Sourcepub fn controller(self, controller: impl CommandController + 'static) -> Self
pub fn controller(self, controller: impl CommandController + 'static) -> Self
Attach a controller owned by this window rather than by its widget tree.
Sourcepub fn on_command<T, F>(self, key: CommandKey<T>, handler: F) -> Self
pub fn on_command<T, F>(self, key: CommandKey<T>, handler: F) -> Self
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 .spacing(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}Sourcepub fn icon(self, icon: WindowIcon) -> Self
pub fn icon(self, icon: WindowIcon) -> Self
Set a platform icon.
Sourcepub fn without_icon(self) -> Self
pub fn without_icon(self) -> Self
Remove the platform icon.
Sourcepub fn initial_size(self, size: Size) -> Self
pub fn initial_size(self, size: Size) -> Self
Request an initial logical client size for the native window.
Sourcepub fn initial_position(self, position: Point) -> Self
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 Unpin for Window
impl UnsafeUnpin for Window
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
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>
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)
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)
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.