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
pub fn new(name: impl Into<String>) -> Self
pub fn accessible_name(&self) -> &str
pub fn theme(self, theme: DefaultTheme) -> Self
pub fn theme_when<F>(self, theme: F) -> Selfwhere
F: Fn() -> DefaultTheme + 'static,
Sourcepub fn enabled(self, enabled: bool) -> Self
pub fn enabled(self, enabled: bool) -> Self
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) -> Self
pub fn enabled_when<F>(self, enabled: F) -> Self
Self::enabled, read whenever the control needs it.
Sourcepub fn enabled_from<O>(self, enabled: O) -> Selfwhere
O: Observable<bool> + 'static,
pub fn enabled_from<O>(self, enabled: O) -> Selfwhere
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) -> Self
pub fn appearance(self, appearance: FieldAppearance) -> Self
pub fn bare(self) -> Self
pub fn padding(self, padding: Insets) -> Self
pub fn min_width(self, width: f32) -> Self
pub fn min_height(self, height: f32) -> Self
pub fn placeholder(self, placeholder: impl Into<String>) -> Self
pub fn leading_icon(self, icon: IconGlyph) -> Self
pub fn read_only(self, read_only: bool) -> Self
pub fn is_read_only(&self) -> bool
pub fn selectable(self, selection_scope: SelectionScope) -> Self
pub fn selection_scope(self, selection_scope: SelectionScope) -> Self
pub fn clipboard_behavior(self, behavior: SelectionClipboardBehavior) -> Self
pub fn copy_to_clipboard(self, enabled: bool) -> Self
pub fn value(self, value: impl Into<String>) -> Self
pub fn current_value(&self) -> &str
pub fn set_value(&mut self, value: impl Into<String>)
Sourcepub fn interaction_preview(self, preview: InteractionPreview) -> Self
pub fn interaction_preview(self, preview: InteractionPreview) -> Self
Pins hover, press, or focus visuals; see InteractionPreview.
pub fn on_change<F>(self, on_change: F) -> Self
pub fn on_change_with_ctx<F>(self, on_change: F) -> Self
Sourcepub fn on_submit<F>(self, on_submit: F) -> Self
pub fn on_submit<F>(self, on_submit: F) -> Self
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) -> Self
pub fn on_submit_with_ctx<F>(self, on_submit: F) -> Self
Self::on_submit, with the event context first.
pub fn on_focus_change<F>(self, on_focus_change: F) -> Self
Sourcepub fn on_focus_change_with_ctx<F>(self, on_focus_change: F) -> Self
pub fn on_focus_change_with_ctx<F>(self, on_focus_change: F) -> Self
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.