Struct pixel_widgets::widget::input::Input

pub struct Input<'a, T, F, S> { /* fields omitted */ }

Editable text input

Implementations

impl<'a, T, F, S> Input<'a, T, F, S> where
    T: 'a + Send,
    F: 'a + Send + Fn(String) -> T,
    S: 'a + Send + AsRef<str>, 

pub fn new(
    state: &'a mut State,
    placeholder: &'a str,
    value: S,
    on_change: F
) -> Self

Construct a new Input

pub fn password(
    state: &'a mut State,
    placeholder: &'a str,
    value: S,
    on_change: F
) -> Self

Construct a new Input that renders the text as dots, for passwords.

pub fn with_on_submit(self, message: T) -> Self

Sets the message to post when the users submits using the enter key

pub fn with_trigger_key(self, key: Key) -> Self

Sets a key that will trigger input focus

Trait Implementations

impl<'a, T, F, S> IntoNode<'a, T> for Input<'a, T, F, S> where
    T: 'a + Send,
    F: 'a + Send + Fn(String) -> T,
    S: 'a + Send + AsRef<str>, 

fn into_node(self) -> Node<'a, T>

Perform the conversion.

fn class(self, class: &'a str) -> Node<'a, Message>

Convenience function that converts to a node and then adds a style class to the Node.

fn on_event(
    self,
    event: NodeEvent,
    f: impl 'a + Send + Fn(&mut Context<Message>)
) -> Node<'a, Message>

Convenience function that converts to a node and then sets a handler for when a node event occurs.

impl<'a, T, F, S> Widget<'a, T> for Input<'a, T, F, S> where
    T: 'a + Send,
    F: 'a + Send + Fn(String) -> T,
    S: 'a + Send + AsRef<str>, 

fn widget(&self) -> &'static str

The name of this widget, used to identify widgets of this type in stylesheets.

fn len(&self) -> usize

Should return the amount of children this widget has. Must be consistent with visit_children().

fn visit_children(&mut self, _: &mut dyn FnMut(&mut Node<'a, T>))

Applies a visitor to all childs of the widget. If an widget fails to visit it’s children, the children won’t be able to resolve their stylesheet, resulting in a panic when calling size, hit, event or draw.

fn size(&self, stylesheet: &Stylesheet) -> (Size, Size)

Returns the (width, height) of this widget. The extents are defined as a Size, which will later be resolved to actual dimensions.

fn event(
    &mut self,
    layout: Rectangle,
    clip: Rectangle,
    stylesheet: &Stylesheet,
    event: Event,
    context: &mut Context<T>
)

Handle an event. If an event changes the graphical appearance of an Widget, redraw should be called to let the Ui know that the ui should be redrawn.

fn draw(
    &mut self,
    layout: Rectangle,
    clip: Rectangle,
    stylesheet: &Stylesheet
) -> Vec<Primitive<'a>>

Draw the widget. Returns a list of Primitives that should be drawn.

fn state(&self) -> StateVec

The state of this widget, used for computing the style. If None is returned, Node will automatically compute a state, such as “hover” and “pressed”.

fn is_empty(&self) -> bool

Returns whether this children has no children. Must be consistent with visit_children().

fn hit(
    &self,
    layout: Rectangle,
    clip: Rectangle,
    _style: &Stylesheet,
    x: f32,
    y: f32
) -> bool

Perform a hit detect on the widget. Most widgets are fine with the default implementation, but some widgets (like Window need to report a miss (false) even when the queried position is within their layout.

fn focused(&self) -> bool

Test the widget for focus exclusivity. If the widget or one of it’s descendants is in an exclusive focus state, this function should return true. In all other cases, it should return false. When a widget is in an exclusive focus state it is the only widget that is allowed to receive events in event. Widgets that intended to use this behaviour are modal dialogs, dropdown boxes, context menu’s, etc.

fn node_event(
    &mut self,
    _layout: Rectangle,
    _style: &Stylesheet,
    _event: NodeEvent,
    _context: &mut Context<Message>
)

Handle a node event. If an event changes the graphical appearance of an Widget, redraw should be called to let the Ui know that the ui should be redrawn.