Struct TextInput

pub struct TextInput(/* private fields */);

W Simple text editor widget.

If txt is set to a variable that can be modified the widget becomes interactive, it implements the usual text box capabilities: keyboard editing of text in a single style, pointer caret positioning and text selection.

You can also use text::cmd to edit the text.

Undo/Redo

Undo/redo is enabled by default, the widget is an undo scope and handles undo commands. Note that external changes to the txt variable clears the undo stack, only changes done by the widget can be undone.

Shorthand

The TextInput! macro provides shorthand syntax that sets the txt property.

let editable_text = TextInput!(var_from(""));

Implementations

impl TextInput

pub fn widget_new() -> Self

Start building a new instance.

pub fn widget_type() -> WidgetType

Gets the widget type info.

impl TextInput

pub fn style_fn(&self, style_fn: impl IntoVar<StyleFn>)

P Extends or replaces the widget style.

Properties and when conditions in the style are applied to the widget. Style instances extend the contextual style by default, you can set replace on a style to true to fully replace.

impl TextInput

pub fn placeholder_txt(&self, txt: impl IntoVar<Txt>)

P Text shown when the txt is empty.

The placeholder has the same text style as the parent widget, with 50% opacity. You can use the placeholder to use a custom widget placeholder.

impl TextInput

pub fn placeholder(&self, placeholder: impl UiNode)

P Widget shown when the txt is empty.

The placeholder can be any widget, the Text! widget is recommended.

Methods from Deref<Target = StyleMix<UndoMix<Text>>>

pub fn style_intrinsic( &mut self, style_var: ContextVar<StyleFn>, style_fn: PropertyId, )

Setup the style build.

pub fn style_base_fn(&self, style: impl IntoVar<StyleFn>)

c Widget’s base style. All other styles set using style_fn are applied over this style.

Is nil by default.

Trait Implementations

impl Deref for TextInput

type Target = StyleMix<UndoMix<Text>>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for TextInput

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.