Struct Input

pub struct Input<Storage = String> {
    pub value: Dynamic<Storage>,
    pub placeholder: Value<String>,
    /* private fields */
}

A text input widget.

Fields

value: Dynamic<Storage>

The value of this widget.

placeholder: Value<String>

The placeholder text to display when no value is present.

Implementations

impl<Storage> Input<Storage>

where Storage: InputStorage,

pub fn new(initial_value: impl IntoDynamic<Storage>) -> Self

Returns a new widget containing initial_text.

pub fn placeholder(self, placeholder: impl IntoValue<String>) -> Self

Sets the placeholder text, which is displayed when the field has an empty value.

pub fn mask_symbol(self, symbol: impl IntoValue<CowString>) -> Self

Sets the symbol to use for masking sensitive content to symbol.

Only the first unicode grapheme will be used for the symbol. A warning will be printed if a multi-grapheme string is provided.

When using a InputStorage that is masked by default, the unicode bullet character (\u{2022}) is used as the default.

pub fn on_key<F>(self, on_key: F) -> Self

where F: FnMut(KeyEvent) -> EventHandling + Send + 'static,

Sets the on_key callback.

This function is called for every keyboard input event. If HANDLED is returned, this widget will ignore the event.

Trait Implementations

impl<Storage> Debug for Input<Storage>

where Storage: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<Storage> Widget for Input<Storage>

where Storage: InputStorage + Debug,

fn hit_test( &mut self, _location: Point<Px>, _context: &mut EventContext<'_>, ) -> bool

Returns true if this widget should respond to mouse input at location.

fn accept_focus(&mut self, _context: &mut EventContext<'_>) -> bool

This widget has been targeted to be focused. If this function returns true, the widget will be focused. If false, Cushy will continue searching for another focus target.

fn mouse_down( &mut self, location: Point<Px>, _device_id: DeviceId, _button: MouseButton, context: &mut EventContext<'_>, ) -> EventHandling

A mouse button event has occurred at location. Returns whether the event has been handled or not.

fn hover( &mut self, _location: Point<Px>, _context: &mut EventContext<'_>, ) -> Option<CursorIcon>

The widget is currently has a cursor hovering it at location.

fn mouse_drag( &mut self, location: Point<Px>, _device_id: DeviceId, _button: MouseButton, context: &mut EventContext<'_>, )

A mouse button is being held down as the cursor is moved across the widget.

fn mouse_up( &mut self, _location: Option<Point<Px>>, _device_id: DeviceId, _button: MouseButton, _context: &mut EventContext<'_>, )

A mouse button is no longer being pressed.

fn redraw(&mut self, context: &mut GraphicsContext<'_, '_, '_, '_>)

Redraw the contents of this widget.

fn layout( &mut self, available_space: Size<ConstraintLimit>, context: &mut LayoutContext<'_, '_, '_, '_>, ) -> Size<UPx>

Layout this widget and returns the ideal size based on its contents and the available_space.

fn keyboard_input( &mut self, _device_id: DeviceId, input: KeyEvent, _is_synthetic: bool, context: &mut EventContext<'_>, ) -> EventHandling

A keyboard event has been sent to this widget. Returns whether the event has been handled or not.

fn ime(&mut self, ime: Ime, context: &mut EventContext<'_>) -> EventHandling

An input manager event has been sent to this widget. Returns whether the event has been handled or not.

fn focus(&mut self, context: &mut EventContext<'_>)

The widget has received focus for user input.

fn blur(&mut self, context: &mut EventContext<'_>)

The widget is no longer focused for user input.

fn summarize(&self, f: &mut Formatter<'_>) -> Result

Writes a summary of this widget into fmt.

fn full_control_redraw(&self) -> bool

Returns true if this widget handles all built-in style components that apply.

fn mounted(&mut self, context: &mut EventContext<'_>)

The widget has been mounted into a parent widget.

fn unmounted(&mut self, context: &mut EventContext<'_>)

The widget has been removed from its parent widget.

fn unhover(&mut self, context: &mut EventContext<'_>)

The widget is no longer being hovered.

fn advance_focus( &mut self, direction: VisualOrder, context: &mut EventContext<'_>, ) -> EventHandling

The widget should switch to the next focusable area within this widget, honoring direction in a consistent manner. Returning HANDLED will cause the search for the next focus widget stop.

fn allow_blur(&mut self, context: &mut EventContext<'_>) -> bool

The widget is about to lose focus. Returning true allows the focus to switch away from this widget.

fn activate(&mut self, context: &mut EventContext<'_>)

The widget has become the active widget.

fn deactivate(&mut self, context: &mut EventContext<'_>)

The widget is no longer active.

fn mouse_wheel( &mut self, device_id: DeviceId, delta: MouseScrollDelta, phase: TouchPhase, context: &mut EventContext<'_>, ) -> EventHandling

A mouse wheel event has been sent to this widget. Returns whether the event has been handled or not.

fn root_behavior( &mut self, context: &mut EventContext<'_>, ) -> Option<(RootBehavior, WidgetInstance)>

Returns a reference to a single child widget if this widget is a widget that primarily wraps a single other widget to customize its behavior.