Struct vizia::views::Textbox

source ·
pub struct Textbox<L>
where L: Lens,
{ /* private fields */ }
Expand description

The Textbox view provides an input control for editing a value as a string.

The textbox takes a lens to some value, which must be a type which can convert to and from a String, as determined by the ToString and FromStr traits. The value type is used for validation and returned by the on_submit callback, which is triggered when the textbox is submitted with the enter key or when the textbox loses keyboard focus.

Implementations§

source§

impl<L> Textbox<L>
where L: Lens, <L as Lens>::Target: Data + Clone + ToStringLocalized + FromStr,

source

pub fn new(cx: &mut Context, lens: L) -> Handle<'_, Textbox<L>>

Creates a new single-line textbox.

§Example
Textbox::new(cx, AppData::text);
source

pub fn new_multiline( cx: &mut Context, lens: L, wrap: bool, ) -> Handle<'_, Textbox<L>>

Creates a new multi-line textbox.

The wrap parameter determines whether text which is too long for the textbox should soft-wrap onto multiple lines. If false, then only hard-wraps from line breaks will cause the text to span multiple lines.

§Example
Textbox::new_multiline(cx, AppData::text, true);
source

pub fn draw_selection(&self, cx: &mut DrawContext<'_>, canvas: &Canvas)

source

pub fn draw_text_caret(&self, cx: &mut DrawContext<'_>, canvas: &Canvas)

Draw text caret for the current view.

Trait Implementations§

source§

impl<L> View for Textbox<L>
where L: Lens, <L as Lens>::Target: Data + ToStringLocalized + FromStr,

source§

fn element(&self) -> Option<&'static str>

Specifies a name for the view type which can be used as an element selector in css. Read more
source§

fn accessibility(&self, cx: &mut AccessContext<'_>, node: &mut AccessNode)

source§

fn event(&mut self, cx: &mut EventContext<'_>, event: &mut Event)

Handles any events received by the view. Read more
source§

fn draw(&self, cx: &mut DrawContext<'_>, canvas: &Canvas)

Provides custom drawing for the view. Read more
source§

fn build<F>(self, cx: &mut Context, content: F) -> Handle<'_, Self>
where F: FnOnce(&mut Context),

Builds the view into the tree and returns a handle which can be used to apply style and layout modifiers to the view. Read more

Auto Trait Implementations§

§

impl<L> Freeze for Textbox<L>
where L: Freeze,

§

impl<L> !RefUnwindSafe for Textbox<L>

§

impl<L> !Send for Textbox<L>

§

impl<L> !Sync for Textbox<L>

§

impl<L> Unpin for Textbox<L>
where L: Unpin,

§

impl<L> !UnwindSafe for Textbox<L>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
§

impl<T> Downcast for T
where T: Any,

§

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

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>) -> Rc<dyn Any>

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.

§

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 T
where 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> Same for T

source§

type Output = T

Should always be Self
source§

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

source§

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

source§

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

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