Skip to main content

TextInput

Struct TextInput 

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

Implementations§

Source§

impl TextInput

Source

pub fn new(name: impl Into<String>) -> TextInput

Examples found in repository?
examples/stateful_form.rs (line 74)
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 name(&self) -> &str

Source

pub fn theme(self, theme: DefaultTheme) -> TextInput

Examples found in repository?
examples/stateful_form.rs (line 77)
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) -> TextInput
where F: Fn() -> DefaultTheme + 'static,

Source

pub fn text_style(self, text_style: TextStyle) -> TextInput

Source

pub fn appearance(self, appearance: FieldAppearance) -> TextInput

Source

pub fn bare(self) -> TextInput

Source

pub fn padding(self, padding: Padding) -> TextInput

Source

pub fn min_width(self, width: f32) -> TextInput

Examples found in repository?
examples/stateful_form.rs (line 76)
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 min_height(self, height: f32) -> TextInput

Source

pub fn placeholder(self, placeholder: impl Into<String>) -> TextInput

Examples found in repository?
examples/stateful_form.rs (line 75)
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 leading_icon(self, icon: IconGlyph) -> TextInput

Source

pub fn read_only(self) -> TextInput

Source

pub fn selectable(self, selection_scope: SelectionScope) -> TextInput

Source

pub fn selection_scope(self, selection_scope: SelectionScope) -> TextInput

Source

pub fn clipboard_behavior( self, behavior: SelectionClipboardBehavior, ) -> TextInput

Source

pub fn copy_to_clipboard(self, enabled: bool) -> TextInput

Source

pub fn value(self, value: impl Into<String>) -> TextInput

Source

pub fn current_value(&self) -> &str

Source

pub fn set_value(&mut self, value: impl Into<String>)

Source

pub fn on_change<F>(self, on_change: F) -> TextInput
where F: FnMut(String) + 'static,

Source

pub fn on_change_with_ctx<F>(self, on_change: F) -> TextInput
where F: FnMut(&mut EventCtx, String) + 'static,

Examples found in repository?
examples/stateful_form.rs (lines 78-81)
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 on_focus_change<F>(self, on_focus_change: F) -> TextInput
where F: FnMut(bool) + 'static,

Source

pub fn select_all(&mut self, ctx: &mut EventCtx)

Select the entire document.

Source

pub fn copy(&mut self, ctx: &mut EventCtx)

Copy the current selection to the clipboard. No-op when the selection is collapsed.

Source

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.

Source

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.

Source

pub fn selected_text(&self) -> &str

Currently selected document text (empty when the selection is collapsed).

Trait Implementations§

Source§

impl Widget for TextInput

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 measure(&mut self, ctx: &mut MeasureCtx, constraints: Constraints) -> Size

Source§

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

Source§

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

Source§

fn accepts_focus(&self) -> bool

Source§

fn focus_changed(&mut self, ctx: &mut EventCtx, focused: bool)

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 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 arrange(&mut self, _ctx: &mut ArrangeCtx, _bounds: Rect)

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 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

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 = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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