Skip to main content

Surface

Struct Surface 

Source
pub struct Surface { /* private fields */ }

Implementations§

Source§

impl Surface

Source

pub fn new<W>(role: SurfaceRole, child: W) -> Surface
where W: Widget + 'static,

Source

pub fn window<W>(child: W) -> Surface
where 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        .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
Hide additional 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 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::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}
Source

pub fn sidebar<W>(child: W) -> Surface
where W: Widget + 'static,

Source

pub fn panel<W>(child: W) -> Surface
where W: Widget + 'static,

Examples found in repository?
examples/stateful_form.rs (line 140)
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}
Source

pub fn titlebar<W>(child: W) -> Surface
where W: Widget + 'static,

Source

pub fn field<W>(child: W) -> Surface
where W: Widget + 'static,

Source

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        .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
Hide additional 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 140)
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}
Source

pub fn theme_when<F>(self, theme: F) -> Surface
where F: Fn() -> DefaultTheme + 'static,

Source

pub fn name(self, name: impl Into<String>) -> Surface

Source

pub fn border(self, border: SurfaceBorder) -> Surface

Source

pub fn appearance(self, appearance: SurfaceAppearance) -> Surface

Source

pub fn tone(self, tone: SemanticTone) -> Surface

Source

pub fn elevation(self, elevation: SurfaceElevation) -> Surface

Source

pub fn radius(self, radius: f32) -> Surface

Source

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        .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
Hide additional 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 140)
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}
Source

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        .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
Hide additional 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 144)
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}
Source

pub fn fill_width(self) -> Surface

Source

pub fn fill_height(self) -> Surface

Trait Implementations§

Source§

impl Widget for Surface

Source§

fn measure(&mut self, ctx: &mut MeasureCtx, constraints: Constraints) -> Size

Source§

fn arrange(&mut self, ctx: &mut ArrangeCtx, bounds: Rect)

Source§

fn paint(&self, ctx: &mut PaintCtx)

Source§

fn semantics(&self, ctx: &mut SemanticsCtx)

Source§

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)

Mutably visit this widget’s logical children. Read more
Source§

fn event(&mut self, _ctx: &mut EventCtx, _event: &Event)

Source§

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.
Source§

fn debug_name(&self) -> &'static str

Source§

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

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

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

Report the smallest and preferred extent along one axis. Read more
Source§

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.
Source§

fn layer_options(&self) -> LayerOptions

Source§

fn layer_properties(&self) -> LayerProperties

Source§

fn stack_host_options(&self) -> Option<StackHostOptions>

Source§

fn stack_surface_options(&self) -> Option<StackSurfaceOptions>

Source§

fn overlay_options(&self) -> Option<OverlayOptions>

Describe this widget as the logical owner of a presented overlay. Read more
Source§

fn accepts_focus(&self) -> bool

Source§

fn focus_changed(&mut self, _ctx: &mut EventCtx, _focused: bool)

Auto Trait Implementations§

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