Struct druid::widget::ValueTextBox

pub struct ValueTextBox<T> { /* fields omitted */ }

A TextBox that uses a Formatter to handle formatting and validation of its data.

There are a number of ways to customize the behaviour of the text box in relation to the provided Formatter:

• ValueTextBox::validate_while_editing takes a flag that determines whether or not the textbox can display text that is not valid, while editing is in progress. (Text will still be validated when the user attempts to complete editing.)

• ValueTextBox::update_data_while_editing takes a flag that determines whether the output value is updated during editing, when possible.

• ValueTextBox::delegate allows you to provide some implementation of the ValidationDelegate trait, which receives a callback during editing; this can be used to report errors further back up the tree.

Implementations

impl<T: Data> ValueTextBox<T>

pub fn new(
    inner: TextBox<String>,
    formatter: impl Formatter<T> + 'static
) -> Self

Create a new ValueTextBox from a normal TextBox and a Formatter.

pub fn delegate(self, delegate: impl ValidationDelegate + 'static) -> Self

Builder-style method to set an optional ValidationDelegate on this textbox.

pub fn validate_while_editing(self, validate: bool) -> Self

Builder-style method to set whether or not this text box validates its contents during editing.

If true (the default) edits that fail validation (Formatter::validate_partial_input) will be rejected. If false, those edits will be accepted, and the text box will be updated.

pub fn update_data_while_editing(self, flag: bool) -> Self

Builder-style method to set whether or not this text box updates the incoming data during editing.

If false (the default) the data is only updated when editing completes.

Trait Implementations

impl<T: Data> Widget<T> for ValueTextBox<T>

pub fn event(
    &mut self,
    ctx: &mut EventCtx<'_, '_>,
    event: &Event,
    data: &mut T,
    env: &Env
)

Handle an event.

pub fn lifecycle(
    &mut self,
    ctx: &mut LifeCycleCtx<'_, '_>,
    event: &LifeCycle,
    data: &T,
    env: &Env
)

Handle a life cycle notification.

pub fn update(
    &mut self,
    ctx: &mut UpdateCtx<'_, '_>,
    old_data: &T,
    data: &T,
    env: &Env
)

Update the widget's appearance in response to a change in the app's Data or Env.

pub fn layout(
    &mut self,
    ctx: &mut LayoutCtx<'_, '_>,
    bc: &BoxConstraints,
    _data: &T,
    env: &Env
) -> Size

Compute layout.

pub fn paint(&mut self, ctx: &mut PaintCtx<'_, '_, '_>, _data: &T, env: &Env)

Paint the widget appearance.