Skip to main content

PasswordInput

Struct PasswordInput 

Source
pub struct PasswordInput { /* private fields */ }
Expand description

A single-line text input that masks its visible value while retaining the same selection, clipboard, IME, and change-callback behavior as TextInput.

Implementations§

Source§

impl PasswordInput

Source

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

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

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

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

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

Source

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

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

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

Source

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

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

pub fn read_only(self, read_only: bool) -> PasswordInput

Source

pub fn is_read_only(&self) -> bool

Source

pub fn enabled(self, enabled: bool) -> PasswordInput

Whether the user can use the field; see TextInput::enabled.

Source

pub fn enabled_when<F>(self, enabled: F) -> PasswordInput
where F: Fn() -> bool + 'static,

Self::enabled, read whenever the field needs it.

Source

pub fn enabled_from<O>(self, enabled: O) -> PasswordInput
where O: Observable<bool> + 'static,

Self::enabled, following an observable and repainting when it changes.

Source

pub fn is_enabled(&self) -> bool

Source

pub fn interaction_preview(self, preview: InteractionPreview) -> PasswordInput

Pins hover or focus visuals; see InteractionPreview.

Source

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

Source

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

Source

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

Source

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

The text style; see TextInput::text_style.

Source

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

The field chrome; see TextInput::appearance.

Source

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

Source

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

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

pub fn on_submit<F>(self, on_submit: F) -> PasswordInput
where F: FnMut(&str) + 'static,

Call on_submit when the user presses Enter; see TextInput::on_submit.

Source

pub fn on_submit_with_ctx<F>(self, on_submit: F) -> PasswordInput
where F: FnMut(&mut EventCtx, &str) + 'static,

Self::on_submit, with the event context first.

Source

pub fn on_focus_change<F>(self, on_focus_change: F) -> PasswordInput
where F: FnMut(bool) + 'static,

Source

pub fn on_focus_change_with_ctx<F>(self, on_focus_change: F) -> PasswordInput
where F: FnMut(&mut EventCtx, bool) + 'static,

Self::on_focus_change, with the event context first.

Source

pub fn current_value(&self) -> &str

Source

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

Source

pub fn selected_text(&self) -> &str

Source

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

Source

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

Source

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

Source

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

Trait Implementations§

Source§

impl Widget for PasswordInput

Source§

fn event(&mut self, ctx: &mut EventCtx, event: &Event)

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 accepts_focus(&self) -> bool

Source§

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

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 layer_properties_at(&self, frame_time: f64) -> LayerProperties

Layer properties for the frame shown at frame_time. Override this instead of Widget::layer_properties when they come from Motion values; the runtime refreshes them without repainting when the motion invalidates Transform or Effect.
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 hit_test_self(&self) -> bool

Whether points inside this widget that none of its children take hit the widget itself. Containers laid over other content, like a layer of floating views, return false so those points reach what is behind them.
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 = !

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