pub struct TextInput { /* private fields */ }Expand description
A single-line text field. Text wider than the field scrolls sideways inside it, keeping the caret in view while the field has focus.
Implementations§
Source§impl TextInput
impl TextInput
Sourcepub fn new(name: impl Into<String>) -> TextInput
pub fn new(name: impl Into<String>) -> TextInput
Examples found in repository?
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 accessible_name(&self) -> &str
Sourcepub fn theme(self, theme: DefaultTheme) -> TextInput
pub fn theme(self, theme: DefaultTheme) -> TextInput
Examples found in repository?
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) -> TextInputwhere
F: Fn() -> DefaultTheme + 'static,
Sourcepub fn enabled(self, enabled: bool) -> TextInput
pub fn enabled(self, enabled: bool) -> TextInput
Whether the user can use the control. Disabled, it ignores input, can’t take focus, draws in the theme’s disabled colors, and tells assistive technology it is unavailable.
Sourcepub fn enabled_when<F>(self, enabled: F) -> TextInput
pub fn enabled_when<F>(self, enabled: F) -> TextInput
Self::enabled, read whenever the control needs it.
Sourcepub fn enabled_from<O>(self, enabled: O) -> TextInputwhere
O: Observable<bool> + 'static,
pub fn enabled_from<O>(self, enabled: O) -> TextInputwhere
O: Observable<bool> + 'static,
Self::enabled, following an observable and repainting when it
changes.
pub fn is_enabled(&self) -> bool
pub fn text_style(self, text_style: TextStyle) -> TextInput
pub fn appearance(self, appearance: FieldAppearance) -> TextInput
pub fn bare(self) -> TextInput
pub fn padding(self, padding: Padding) -> TextInput
Sourcepub fn min_width(self, width: f32) -> TextInput
pub fn min_width(self, width: f32) -> TextInput
Examples found in repository?
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 min_height(self, height: f32) -> TextInput
Sourcepub fn placeholder(self, placeholder: impl Into<String>) -> TextInput
pub fn placeholder(self, placeholder: impl Into<String>) -> TextInput
Examples found in repository?
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 leading_icon(self, icon: IconGlyph) -> TextInput
pub fn read_only(self, read_only: bool) -> TextInput
pub fn is_read_only(&self) -> bool
pub fn selectable(self, selection_scope: SelectionScope) -> TextInput
pub fn selection_scope(self, selection_scope: SelectionScope) -> TextInput
pub fn clipboard_behavior( self, behavior: SelectionClipboardBehavior, ) -> TextInput
pub fn copy_to_clipboard(self, enabled: bool) -> TextInput
pub fn value(self, value: impl Into<String>) -> TextInput
pub fn current_value(&self) -> &str
pub fn set_value(&mut self, value: impl Into<String>)
Sourcepub fn interaction_preview(self, preview: InteractionPreview) -> TextInput
pub fn interaction_preview(self, preview: InteractionPreview) -> TextInput
Pins hover, press, or focus visuals; see InteractionPreview.
pub fn on_change<F>(self, on_change: F) -> TextInput
Sourcepub fn on_change_with_ctx<F>(self, on_change: F) -> TextInput
pub fn on_change_with_ctx<F>(self, on_change: F) -> TextInput
Examples found in repository?
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 on_submit<F>(self, on_submit: F) -> TextInput
pub fn on_submit<F>(self, on_submit: F) -> TextInput
Call on_submit with the current text when the user presses a plain
Enter while the field is focused. The key is consumed only while a
submit callback is set, so an unwired field still lets Enter reach
its ancestors (a dialog’s default action, for example).
Sourcepub fn on_submit_with_ctx<F>(self, on_submit: F) -> TextInput
pub fn on_submit_with_ctx<F>(self, on_submit: F) -> TextInput
Self::on_submit, with the event context first.
pub fn on_focus_change<F>(self, on_focus_change: F) -> TextInput
Sourcepub fn on_focus_change_with_ctx<F>(self, on_focus_change: F) -> TextInput
pub fn on_focus_change_with_ctx<F>(self, on_focus_change: F) -> TextInput
Self::on_focus_change, with the event context first.
Sourcepub fn select_all(&mut self, ctx: &mut EventCtx)
pub fn select_all(&mut self, ctx: &mut EventCtx)
Select the entire document.
Sourcepub fn copy(&mut self, ctx: &mut EventCtx)
pub fn copy(&mut self, ctx: &mut EventCtx)
Copy the current selection to the clipboard. No-op when the selection is collapsed.
Sourcepub fn cut(&mut self, ctx: &mut EventCtx)
pub fn cut(&mut self, ctx: &mut EventCtx)
Copy the current selection to the clipboard and delete it. No-op when read-only or the selection is collapsed.
Sourcepub fn paste(&mut self, ctx: &mut EventCtx)
pub fn paste(&mut self, ctx: &mut EventCtx)
Replace the current selection with the clipboard text (coerced to a single line). No-op when read-only or the clipboard has no text.
Sourcepub fn selected_text(&self) -> &str
pub fn selected_text(&self) -> &str
Currently selected document text (empty when the selection is collapsed).
Trait Implementations§
Source§impl Widget for TextInput
impl Widget for TextInput
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<'_>)
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)
fn accepts_focus(&self) -> bool
fn focus_changed(&mut self, ctx: &mut EventCtx, focused: bool)
fn debug_name(&self) -> &'static str
Source§fn diagnostics(&self, _ctx: &mut WidgetDiagnosticsCtx)
fn diagnostics(&self, _ctx: &mut WidgetDiagnosticsCtx)
Source§fn measure_size(
&mut self,
ctx: &mut MeasureCtx,
constraints: Constraints,
) -> Size
fn measure_size( &mut self, ctx: &mut MeasureCtx, constraints: Constraints, ) -> Size
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
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
Source§fn supports_output_reuse(&self) -> bool
fn supports_output_reuse(&self) -> bool
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
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>
Source§fn hit_test_self(&self) -> bool
fn hit_test_self(&self) -> bool
false so those points reach what is behind
them.Source§fn visit_children(&self, _visitor: &mut dyn WidgetPodVisitor)
fn visit_children(&self, _visitor: &mut dyn WidgetPodVisitor)
Source§fn visit_children_mut(&mut self, _visitor: &mut dyn WidgetPodMutVisitor)
fn visit_children_mut(&mut self, _visitor: &mut dyn WidgetPodMutVisitor)
Auto Trait Implementations§
impl !RefUnwindSafe for TextInput
impl !Send for TextInput
impl !Sync for TextInput
impl !UnwindSafe for TextInput
impl Forget for TextInput
impl Freeze for TextInput
impl Move for TextInput
impl Unpin for TextInput
impl UnsafeUnpin for TextInput
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
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>
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>
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)
&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)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.