pub struct Button { /* private fields */ }Implementations§
Source§impl Button
impl Button
Sourcepub fn new(label: impl Into<String>) -> Button
pub fn new(label: impl Into<String>) -> Button
Creates a neutral, tonal button for an ordinary action.
Examples found in repository?
examples/quickstart.rs (line 22)
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/commands.rs (line 33)
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 111)
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 primary(label: impl Into<String>) -> Button
pub fn primary(label: impl Into<String>) -> Button
Creates a filled accent button for the primary action on a surface.
Sourcepub fn danger(label: impl Into<String>) -> Button
pub fn danger(label: impl Into<String>) -> Button
Creates a filled danger button for a destructive or irreversible action.
pub fn label(&self) -> &str
pub fn set_label(&mut self, label: impl Into<String>)
pub fn semantic_name(self, name: impl Into<String>) -> Button
pub fn description(self, description: impl Into<String>) -> Button
Sourcepub fn appearance(self, appearance: ButtonAppearance) -> Button
pub fn appearance(self, appearance: ButtonAppearance) -> Button
Selects the button’s visual emphasis without changing its semantic
meaning. The default is ButtonAppearance::Tonal.
Sourcepub fn tone(self, tone: SemanticTone) -> Button
pub fn tone(self, tone: SemanticTone) -> Button
Selects the semantic color family used by this button. The default is
SemanticTone::Neutral.
Sourcepub fn primary_action(self) -> Button
pub fn primary_action(self) -> Button
Promotes this button to a filled accent primary action.
Sourcepub fn danger_action(self) -> Button
pub fn danger_action(self) -> Button
Promotes this button to a filled danger action.
Sourcepub fn theme(self, theme: DefaultTheme) -> Button
pub fn theme(self, theme: DefaultTheme) -> Button
Examples found in repository?
examples/quickstart.rs (line 23)
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/stateful_form.rs (line 112)
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}pub fn theme_when<F>(self, theme: F) -> Buttonwhere
F: Fn() -> DefaultTheme + 'static,
pub fn text_style(self, text_style: TextStyle) -> Button
pub fn icon(self, icon: IconGlyph) -> Button
pub fn without_icon(self) -> Button
pub fn icon_size(self, icon_size: f32) -> Button
pub fn icon_gap(self, icon_gap: f32) -> Button
pub fn min_width(self, width: f32) -> Button
pub fn min_height(self, height: f32) -> Button
pub fn padding(self, padding: Padding) -> Button
pub fn enabled(self, enabled: bool) -> Button
Sourcepub fn enabled_when<F>(self, enabled: F) -> Button
pub fn enabled_when<F>(self, enabled: F) -> Button
Examples found in repository?
examples/stateful_form.rs (line 113)
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 on_press<F>(self, on_press: F) -> Buttonwhere
F: FnMut() + 'static,
pub fn on_press<F>(self, on_press: F) -> Buttonwhere
F: FnMut() + 'static,
Examples found in repository?
examples/quickstart.rs (line 24)
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}Sourcepub fn on_press_with_ctx<F>(self, on_press: F) -> Button
pub fn on_press_with_ctx<F>(self, on_press: F) -> Button
Examples found in repository?
examples/commands.rs (lines 33-38)
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}More examples
examples/stateful_form.rs (lines 114-117)
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}Trait Implementations§
Source§impl Widget for Button
impl Widget for Button
fn event(&mut self, ctx: &mut EventCtx, event: &Event)
fn measure(&mut self, ctx: &mut MeasureCtx, constraints: Constraints) -> Size
fn paint(&self, ctx: &mut PaintCtx)
fn semantics(&self, ctx: &mut SemanticsCtx)
fn accepts_focus(&self) -> bool
fn focus_changed(&mut self, ctx: &mut EventCtx, focused: bool)
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 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
fn arrange(&mut self, _ctx: &mut ArrangeCtx, _bounds: Rect)
fn layer_options(&self) -> LayerOptions
fn layer_properties(&self) -> LayerProperties
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
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
Auto Trait Implementations§
impl !RefUnwindSafe for Button
impl !Send for Button
impl !Sync for Button
impl !UnwindSafe for Button
impl Freeze for Button
impl Unpin for Button
impl UnsafeUnpin for Button
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.