Struct gooey::widgets::input::Input

source ·
pub struct Input<Storage> {
    pub value: Dynamic<Storage>,
    pub placeholder: Value<String>,
    /* private fields */
}
Expand description

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§

source§

impl<Storage> Input<Storage>where Storage: InputStorage,

source

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

Returns a new widget containing initial_text.

source

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

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

source

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.

source

pub fn on_key<F>(self, on_key: F) -> Selfwhere 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§

source§

impl<Storage> Debug for Input<Storage>where Storage: Debug,

source§

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

Formats the value using the given formatter. Read more
source§

impl<Storage> Widget for Input<Storage>where Storage: InputStorage + Debug,

source§

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

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

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, Gooey will continue searching for another focus target.
source§

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. Read more
source§

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

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

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.
source§

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.
source§

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

Redraw the contents of this widget.
source§

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.
source§

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.
source§

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.
source§

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

The widget has received focus for user input.
source§

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

The widget is no longer focused for user input.
source§

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

Writes a summary of this widget into fmt. Read more
source§

fn full_control_redraw(&self) -> bool

Returns true if this widget handles all built-in style components that apply. Read more
source§

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

The widget has been mounted into a parent widget.
source§

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

The widget has been removed from its parent widget.
source§

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

The widget is no longer being hovered.
source§

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.
source§

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.
source§

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

The widget has become the active widget.
source§

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

The widget is no longer active.
source§

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.
source§

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.

Auto Trait Implementations§

§

impl<Storage> !RefUnwindSafe for Input<Storage>

§

impl<Storage> Send for Input<Storage>where Storage: Send,

§

impl<Storage> !Sync for Input<Storage>

§

impl<Storage> Unpin for Input<Storage>

§

impl<Storage> !UnwindSafe for Input<Storage>

Blanket Implementations§

source§

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, D: AdaptFrom<S, Swp, Dwp, T>,

source§

fn adapt_into_using<M>(self, method: M) -> Dwhere M: TransformMatrix<T>,

Convert the source color to the destination color using the specified method.
source§

fn adapt_into(self) -> D

Convert the source color to the destination color using the bradford method by default.
source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T, C> ArraysFrom<C> for Twhere C: IntoArrays<T>,

source§

fn arrays_from(colors: C) -> T

Cast a collection of colors into a collection of arrays.
source§

impl<T, C> ArraysInto<C> for Twhere C: FromArrays<T>,

source§

fn arrays_into(self) -> C

Cast this collection of arrays into a collection of colors.
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<A> Cast for A

§

fn cast<To>(self) -> Towhere To: CastFrom<A>,

Casts self to the To type. This may be a lossy operation.
§

impl<A> CastFrom<A> for A

§

fn from_cast(from: A) -> A

Returns from as Self.
§

impl<A, B> CastInto<A> for Bwhere A: CastFrom<B>,

§

fn cast_into(self) -> A

Returns self as To.
source§

impl<T, C> ComponentsFrom<C> for Twhere C: IntoComponents<T>,

source§

fn components_from(colors: C) -> T

Cast a collection of colors into a collection of color components.
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

impl<T> Downcast for Twhere T: Any,

§

fn into_any(self: Box<T, Global>) -> Box<dyn Any, Global>

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

fn into_any_rc(self: Rc<T, Global>) -> Rc<dyn Any, Global>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

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

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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FromAngle<T> for T

source§

fn from_angle(angle: T) -> T

Performs a conversion from angle.
source§

impl<T, U> FromStimulus<U> for Twhere U: IntoStimulus<T>,

source§

fn from_stimulus(other: U) -> T

Converts other into Self, while performing the appropriate scaling, rounding and clamping.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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 Twhere 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, U> IntoAngle<U> for Twhere U: FromAngle<T>,

source§

fn into_angle(self) -> U

Performs a conversion into T.
source§

impl<T, U> IntoColor<U> for Twhere U: FromColor<T>,

source§

fn into_color(self) -> U

Convert into T with values clamped to the color defined bounds Read more
source§

impl<T, U> IntoColorUnclamped<U> for Twhere U: FromColorUnclamped<T>,

source§

fn into_color_unclamped(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more
source§

impl<T> IntoStimulus<T> for T

source§

fn into_stimulus(self) -> T

Converts self into T, while performing the appropriate scaling, rounding and clamping.
source§

impl<T> IntoValue<Option<T>> for T

source§

fn into_value(self) -> Value<Option<T>>

Returns this type as a Value.
source§

impl<T> IntoValue<T> for T

source§

fn into_value(self) -> Value<T>

Returns this type as a Value.
source§

impl<T> MakeWidget for Twhere T: MakeWidgetWithTag,

source§

fn make_widget(self) -> WidgetInstance

Returns a new widget.
source§

fn into_window(self) -> Window<WidgetInstance>

Returns a new window containing self as the root widget.
source§

fn with_styles(self, styles: impl IntoValue<Styles>) -> Stylewhere Self: Sized,

Associates styles with this widget. Read more
source§

fn with<C: ComponentDefinition>( self, name: &C, component: impl IntoValue<C::ComponentType> ) -> Stylewhere Value<C::ComponentType>: IntoComponentValue,

Associates a style component with self.
source§

fn with_dynamic<C: ComponentDefinition>( self, name: &C, dynamic: impl IntoDynamicComponentValue ) -> Stylewhere Value<C::ComponentType>: IntoComponentValue,

Associates a style component with self, resolving its value using dynamic at runtime.
source§

fn h1(self) -> Style

Styles self with the largest of 6 heading styles.
source§

fn h2(self) -> Style

Styles self with the second largest of 6 heading styles.
source§

fn h3(self) -> Style

Styles self with the third largest of 6 heading styles.
source§

fn h4(self) -> Style

Styles self with the third smallest of 6 heading styles.
source§

fn h5(self) -> Style

Styles self with the second smallest of 6 heading styles.
source§

fn h6(self) -> Style

Styles self with the smallest of 6 heading styles.
source§

fn xxxx_large(self) -> Style

Styles self with the largest text size.
source§

fn xxx_large(self) -> Style

Styles self with the second largest text size.
source§

fn xx_large(self) -> Style

Styles self with the third largest text size.
source§

fn x_large(self) -> Style

Styles self with the fourth largest text size.
source§

fn large(self) -> Style

Styles self with the fifth largest text size.
source§

fn default_size(self) -> Style

Styles self with the third smallest text size.
source§

fn small(self) -> Style

Styles self with the second smallest text size.
source§

fn x_small(self) -> Style

Styles self with the smallest text size.
source§

fn with_next_focus( self, next_focus: impl IntoValue<Option<WidgetId>> ) -> WidgetInstance

Sets the widget that should be focused next. Read more
source§

fn with_enabled(self, enabled: impl IntoValue<bool>) -> WidgetInstance

Sets this widget to be enabled/disabled based on enabled and returns self. Read more
source§

fn into_default(self) -> WidgetInstance

Sets this widget as a “default” widget. Read more
source§

fn into_escape(self) -> WidgetInstance

Sets this widget as an “escape” widget. Read more
source§

fn and(self, other: impl MakeWidget) -> Children

Returns a collection of widgets using self and other.
source§

fn expand(self) -> Expand

Expands self to grow to fill its parent.
source§

fn expand_weighted(self, weight: u8) -> Expand

Expands self to grow to fill its parent proportionally with other weighted siblings.
source§

fn expand_horizontally(self) -> Expand

Expands self to grow to fill its parent horizontally.
source§

fn expand_vertically(self) -> Expand

Expands self to grow to fill its parent vertically.
source§

fn size<T>(self, size: Size<T>) -> Resizewhere T: Into<DimensionRange>,

Resizes self to size.
source§

fn width(self, width: impl Into<DimensionRange>) -> Resize

Resizes self to width. Read more
source§

fn height(self, height: impl Into<DimensionRange>) -> Resize

Resizes self to height. Read more
source§

fn into_button(self) -> Button

Returns this widget as the contents of a clickable button.
source§

fn into_checkbox(self, value: impl IntoDynamic<CheckboxState>) -> Checkbox

Returns this widget as the label of a Checkbox.
source§

fn centered(self) -> Align

Aligns self to the center vertically and horizontally.
source§

fn align_left(self) -> Align

Aligns self to the left.
source§

fn align_right(self) -> Align

Aligns self to the right.
source§

fn align_top(self) -> Align

Aligns self to the top.
source§

fn align_bottom(self) -> Align

Aligns self to the bottom.
source§

fn fit_horizontally(self) -> Align

Fits self horizontally within its parent.
source§

fn fit_vertically(self) -> Align

Fits self vertically within its parent.
source§

fn scroll(self) -> Scroll

Allows scrolling self both vertically and horizontally.
source§

fn vertical_scroll(self) -> Scroll

Allows scrolling self vertically.
source§

fn horizontal_scroll(self) -> Scroll

Allows scrolling self horizontally.
source§

fn widget_ref(self) -> WidgetRef

Creates a WidgetRef for use as child widget.
source§

fn contain(self) -> Container

Wraps self in a Container.
source§

fn contain_level(self, level: impl IntoValue<ContainerLevel>) -> Container

Wraps self in a Container with the specified level.
source§

fn background_color(self, color: impl IntoValue<Color>) -> Container

Returns a new widget that renders color behind self.
source§

fn pad(self) -> Container

Wraps self with the default padding.
source§

fn pad_by(self, padding: impl IntoValue<Edges<Dimension>>) -> Container

Wraps self with the specified padding.
source§

fn themed(self, theme: impl IntoValue<ThemePair>) -> Themed

Applies theme to self and its children.
source§

fn themed_mode(self, mode: impl IntoValue<ThemeMode>) -> ThemedMode

Applies mode to self and its children.
source§

fn collapse_horizontally( self, collapse_when: impl IntoDynamic<bool> ) -> Collapse

Returns a widget that collapses self horizontally based on the dynamic boolean value. Read more
source§

fn collapse_vertically(self, collapse_when: impl IntoDynamic<bool>) -> Collapse

Returns a widget that collapses self vertically based on the dynamic boolean value. Read more
source§

fn validation(self, validation: impl IntoDynamic<Validation>) -> Validated

Returns a widget that shows validation errors and/or hints.
source§

fn tooltip(self, layer: &OverlayLayer, tip: impl MakeWidget) -> Tooltipped

Returns a widget that shows tip on layer when self is hovered.
source§

impl<T> MakeWidgetWithTag for Twhere T: Widget,

source§

fn make_with_tag(self, id: WidgetTag) -> WidgetInstance

Returns a new WidgetInstance whose WidgetId comes from tag.
source§

impl<T> Open for Twhere T: MakeWidget,

source§

fn open<App>(self, app: &App) -> Result<Option<WindowHandle>, EventLoopError>where App: Application,

Opens the provided type as a window inside of app.
source§

fn run_in(self, app: PendingApp) -> Result<(), EventLoopError>

Runs the provided type inside of the pending app, returning Ok(()) upon successful execution and program exit. Note that this function may not ever return on some platforms.
source§

impl<T> Run for Twhere T: MakeWidget,

source§

fn run(self) -> Result<(), EventLoopError>

Runs the provided type, returning Ok(()) upon successful execution and program exit. Note that this function may not ever return on some platforms.
source§

impl<'a, T, C> TryComponentsInto<C> for Twhere C: TryFromComponents<T>,

§

type Error = <C as TryFromComponents<T>>::Error

The error for when try_into_colors fails to cast.
source§

fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>

Try to cast this collection of color components into a collection of colors. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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, U> TryIntoColor<U> for Twhere U: TryFromColor<T>,

source§

fn try_into_color(self) -> Result<U, OutOfBounds<U>>

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more
source§

impl<C, U> UintsFrom<C> for Uwhere C: IntoUints<U>,

source§

fn uints_from(colors: C) -> U

Cast a collection of colors into a collection of unsigned integers.
source§

impl<C, U> UintsInto<C> for Uwhere C: FromUints<U>,

source§

fn uints_into(self) -> C

Cast this collection of unsigned integers into a collection of colors.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> WasmNotSend for Twhere T: Send,