pub struct Surface { /* private fields */ }Implementations§
Source§impl Surface
impl Surface
pub fn new<W>(role: SurfaceRole, child: W) -> Surfacewhere
W: Widget + 'static,
Sourcepub fn window<W>(child: W) -> Surfacewhere
W: Widget + 'static,
pub fn window<W>(child: W) -> Surfacewhere
W: Widget + 'static,
Examples found in repository?
examples/quickstart.rs (line 27)
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
examples/rich_document.rs (line 30)
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/stateful_form.rs (line 142)
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}Sourcepub fn panel<W>(child: W) -> Surfacewhere
W: Widget + 'static,
pub fn panel<W>(child: W) -> Surfacewhere
W: Widget + 'static,
Examples found in repository?
examples/stateful_form.rs (line 141)
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}pub fn titlebar<W>(child: W) -> Surfacewhere
W: Widget + 'static,
pub fn field<W>(child: W) -> Surfacewhere
W: Widget + 'static,
Sourcepub fn theme(self, theme: DefaultTheme) -> Surface
pub fn theme(self, theme: DefaultTheme) -> Surface
Examples found in repository?
examples/quickstart.rs (line 28)
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
examples/rich_document.rs (line 31)
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/stateful_form.rs (line 141)
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}pub fn theme_when<F>(self, theme: F) -> Surfacewhere
F: Fn() -> DefaultTheme + 'static,
pub fn name(self, name: impl Into<String>) -> Surface
pub fn border(self, border: SurfaceBorder) -> Surface
pub fn appearance(self, appearance: SurfaceAppearance) -> Surface
pub fn tone(self, tone: SemanticTone) -> Surface
pub fn elevation(self, elevation: SurfaceElevation) -> Surface
Sourcepub fn shadow<F>(self, shadow: F) -> Surface
pub fn shadow<F>(self, shadow: F) -> Surface
Casts the shadow shadow chooses from the surface’s theme, in place of
its elevation’s. Inset layers are drawn inside the surface, over its
fill, as CSS draws them:
ⓘ
Surface::field(child).shadow(|theme| theme.shadows.inset.sm)Sourcepub fn glow(self, tone: GlowTone) -> Surface
pub fn glow(self, tone: GlowTone) -> Surface
Surrounds the surface with the theme’s tone glow, brighter on HDR
outputs where the theme allows it. Light themes have no glow.
pub fn corner_radius(self, corner_radius: f32) -> Surface
Sourcepub fn padding(self, padding: Padding) -> Surface
pub fn padding(self, padding: Padding) -> Surface
Examples found in repository?
examples/quickstart.rs (line 29)
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
examples/rich_document.rs (line 32)
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/stateful_form.rs (line 141)
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}Sourcepub fn fill(self) -> Surface
pub fn fill(self) -> Surface
Examples found in repository?
examples/quickstart.rs (line 30)
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
examples/rich_document.rs (line 33)
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/stateful_form.rs (line 145)
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}pub fn fill_width(self, fill_width: bool) -> Surface
pub fn fill_height(self, fill_height: bool) -> Surface
Trait Implementations§
Source§impl Widget for Surface
impl Widget for Surface
fn measure(&mut self, ctx: &mut MeasureCtx, constraints: Constraints) -> Size
fn arrange(&mut self, ctx: &mut ArrangeCtx, bounds: Rect)
fn paint(&self, ctx: &mut PaintCtx)
fn semantics(&self, ctx: &mut SemanticsCtx)
Source§fn visit_children(&self, visitor: &mut dyn WidgetPodVisitor)
fn visit_children(&self, visitor: &mut dyn WidgetPodVisitor)
Visit this widget’s logical children. Read more
Source§fn visit_children_mut(&mut self, visitor: &mut dyn WidgetPodMutVisitor)
fn visit_children_mut(&mut self, visitor: &mut dyn WidgetPodMutVisitor)
Mutably visit this widget’s logical children. Read more
fn event(&mut self, _ctx: &mut EventCtx, _event: &Event)
Source§fn command(&mut self, _ctx: &mut EventCtx, _command: &Command<'_>)
fn command(&mut self, _ctx: &mut EventCtx, _command: &Command<'_>)
Receive a typed command addressed directly to this widget. Commands are
target-only and do not capture or bubble through the widget tree.
fn debug_name(&self) -> &'static str
Source§fn diagnostics(&self, _ctx: &mut WidgetDiagnosticsCtx)
fn diagnostics(&self, _ctx: &mut WidgetDiagnosticsCtx)
Publish widget-specific state for an inspector snapshot. Read more
Source§fn measure_size(
&mut self,
ctx: &mut MeasureCtx,
constraints: Constraints,
) -> Size
fn measure_size( &mut self, ctx: &mut MeasureCtx, constraints: Constraints, ) -> Size
Compute a provisional size. Containers can override this to query child
sizes without committing their final layouts. The default preserves
existing custom widgets by delegating to
measure; it may mutate state.
Child measure calls still commit state. Use child size probes explicitly
when only their scalar results are needed.
Results must match measure for the same content and constraints.
A final measure is still required before arrangement after a probe miss.Source§fn measure_axis(
&mut self,
ctx: &mut MeasureCtx,
constraints: Constraints,
axis: Axis,
) -> f32
fn measure_axis( &mut self, ctx: &mut MeasureCtx, constraints: Constraints, axis: Axis, ) -> f32
Query one component of
measure_size under exactly the same constraints.
Overrides may avoid computing the other component, but must return the
same extent. Like size probes, this does not replace final measurement.Source§fn intrinsic_size(
&mut self,
ctx: &mut MeasureCtx,
axis: Axis,
available_cross: f32,
) -> IntrinsicSize
fn intrinsic_size( &mut self, ctx: &mut MeasureCtx, axis: Axis, available_cross: f32, ) -> IntrinsicSize
Report the smallest and preferred extent along one axis. Read more
Source§fn supports_output_reuse(&self) -> bool
fn supports_output_reuse(&self) -> bool
Opt into retaining paint and semantics between targeted invalidations.
Output must depend only on widget state, context, and observed sources;
changes must invalidate the widget. Untracked readers and callbacks with
side effects should keep the default. An opaque descendant also prevents
caching its ancestors. Explicit subtree/window requests always rerun them.
A source observed only in paint or semantics invalidates that callback,
not its descendants. Mutating child state requires a child/subtree request.
fn layer_options(&self) -> LayerOptions
fn layer_properties(&self) -> LayerProperties
Source§fn layer_properties_at(&self, frame_time: f64) -> LayerProperties
fn layer_properties_at(&self, frame_time: f64) -> LayerProperties
Layer properties for the frame shown at
frame_time. Override this
instead of Widget::layer_properties when they come from Motion
values; the runtime refreshes them without repainting when the motion
invalidates Transform or Effect.fn stack_host_options(&self) -> Option<StackHostOptions>
fn stack_surface_options(&self) -> Option<StackSurfaceOptions>
Source§fn overlay_options(&self) -> Option<OverlayOptions>
fn overlay_options(&self) -> Option<OverlayOptions>
Describe this widget as the logical owner of a presented overlay. Read more
fn accepts_focus(&self) -> bool
Source§fn hit_test_self(&self) -> bool
fn hit_test_self(&self) -> bool
Whether points inside this widget that none of its children take hit
the widget itself. Containers laid over other content, like a layer of
floating views, return
false so those points reach what is behind
them.fn focus_changed(&mut self, _ctx: &mut EventCtx, _focused: bool)
Auto Trait Implementations§
impl !Freeze for Surface
impl !RefUnwindSafe for Surface
impl !Send for Surface
impl !Sync for Surface
impl !UnwindSafe for Surface
impl Forget for Surface
impl Move for Surface
impl Unpin for Surface
impl UnsafeUnpin for Surface
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.