Struct druid::widget::TextBox

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

A widget that allows user text input.

Editing values

If the text you are editing represents a value of some other type, such as a number, you should use a ValueTextBox and an appropriate Formatter. You can create a ValueTextBox by passing the appropriate Formatter to TextBox::with_formatter.

Implementations

impl TextBox<()>

pub const PERFORM_EDIT: Selector<EditAction>

Perform an EditAction.

You can send a Command to a textbox containing an EditAction that the textbox should perform.

impl<T> TextBox<T>

pub fn new() -> Self

Create a new TextBox widget.

pub fn multiline() -> Self

Create a new multi-line TextBox.

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

Builder-style method to set the TextBox's placeholder text.

pub fn with_text_size(self, size: impl Into<KeyOrValue<f64>>) -> Self

Builder-style method for setting the text size.

The argument can be either an f64 or a Key<f64>.

pub fn with_text_alignment(self, alignment: TextAlignment) -> Self

Builder-style method to set the TextAlignment.

This is only relevant when the TextBox is not multiline, in which case it determines how the text is positioned inside the TextBox when it does not fill the available space.

Note:

This does not behave exactly like TextAlignment does when used with label; in particular this does not account for reading direction. This means that TextAlignment::Start (the default) always means left aligned, and TextAlignment::End always means right aligned.

This should be considered a bug, but it will not be fixed until proper BiDi support is implemented.

pub fn with_font(self, font: impl Into<KeyOrValue<FontDescriptor>>) -> Self

Builder-style method for setting the font.

The argument can be a FontDescriptor or a Key<FontDescriptor> that refers to a font defined in the Env.

pub fn with_text_color(self, color: impl Into<KeyOrValue<Color>>) -> Self

Builder-style method for setting the text color.

The argument can be either a Color or a Key<Color>.

pub fn set_placeholder(&mut self, placeholder: impl Into<String>)

Set the TextBox's placeholder text.

pub fn set_text_size(&mut self, size: impl Into<KeyOrValue<f64>>)

Set the text size.

The argument can be either an f64 or a Key<f64>.

pub fn set_font(&mut self, font: impl Into<KeyOrValue<FontDescriptor>>)

Set the font.

The argument can be a FontDescriptor or a Key<FontDescriptor> that refers to a font defined in the Env.

pub fn set_text_alignment(&mut self, alignment: TextAlignment)

Set the TextAlignment for this `TextBox``.

This is only relevant when the TextBox is not multiline, in which case it determines how the text is positioned inside the TextBox when it does not fill the available space.

Note:

This does not behave exactly like TextAlignment does when used with label; in particular this does not account for reading direction. This means that TextAlignment::Start (the default) always means left aligned, and TextAlignment::End always means right aligned.

This should be considered a bug, but it will not be fixed until proper BiDi support is implemented.

pub fn set_text_color(&mut self, color: impl Into<KeyOrValue<Color>>)

Set the text color.

The argument can be either a Color or a Key<Color>.

If you change this property, you are responsible for calling request_layout to ensure the label is updated.

pub fn editor(&self) -> &Editor<T>

Return the Editor used by this TextBox.

This is only needed in advanced cases, such as if you want to customize the drawing of the text.

pub fn text_position(&self) -> Point

The point, relative to the origin, where this text box draws its TextLayout.

This is exposed in case the user wants to do additional drawing based on properties of the text.

This is not valid until layout has been called.

impl TextBox<String>

pub fn with_formatter<T: Data>(
    self,
    formatter: impl Formatter<T> + 'static
) -> ValueTextBox<T>

Turn this TextBox into a ValueTextBox, using the Formatter to manage the value.

For simple value formatting, you can use the ParseFormatter.

impl<T: TextStorage + EditableText> TextBox<T>

pub fn set_selection(&mut self, selection: Selection)

Set the textbox's selection.

pub fn force_rebuild(&mut self, text: T, factory: &mut PietText, env: &Env)

Set the text and force the editor to update.

This should be rarely needed; the main use-case would be if you need to manually set the text and then immediately do hit-testing or other tasks that rely on having an up-to-date text layout.

Trait Implementations

impl<T: Clone> Clone for TextBox<T>

pub fn clone(&self) -> TextBox<T>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for TextBox<T>

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

Formats the value using the given formatter.

impl<T> Default for TextBox<T>

pub fn default() -> Self

Returns the "default value" for a type.

impl<T: TextStorage + EditableText> Widget<T> for TextBox<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<'_, '_>,
    _: &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.