Skip to main content

Form

Struct Form 

Source
pub struct Form<Msg> { /* private fields */ }
Expand description

A column of Fields that share one label layout, with an optional summary of problems above them.

Enter in a field whose control does not use it (a text input without on_submit) moves focus to the next field, and from the last field on to whatever follows the form, usually its submit button. The form does not validate: the application checks its values into FormErrors, passes each message to its field and, on submit, returns FormErrors::focus_first.

Style keys: form-summary (bg, padding), form-summary-title (fg, bold), form-summary-marker and form-summary-item (fg). The summary title is quvyta.form.summary with n problems; its marker is the error icon.

Implementations§

Source§

impl<Msg: 'static> Form<Msg>

Source

pub fn new() -> Self

A form with labels above controls and a row between fields.

Source

pub fn label_width(self, cells: u16) -> Self

Puts every field’s label in a column cells wide beside its control while the form is wide enough; on narrow screens labels move above controls.

Source

pub fn gap(self, rows: u16) -> Self

Rows between fields; 1 by default.

Source

pub fn summary(self, errors: &FormErrors) -> Self

Lists every problem of errors above the fields. Nothing is shown while there are none.

Source

pub fn show<'v>( self, ui: &'v mut View<'_, Msg>, build: impl FnOnce(&mut FormFields<'_, '_, Msg>), ) -> NodeMut<'v, Msg>

Adds the form to ui with the fields build adds.

Trait Implementations§

Source§

impl<Msg: 'static> Default for Form<Msg>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<Msg: 'static> Widget<Msg> for Form<Msg>

Source§

fn measure(&self, cx: &mut MeasureCx<'_>, available: Size) -> Size

The size the widget wants when it may use up to available.
Source§

fn paint(&self, cx: &mut PaintCx<'_>, area: Rect)

Draws the widget into area.
Source§

fn event(&self, cx: &mut EventCx<'_, Msg>, event: &Event) -> bool

Handles input. Returns true when the event was used; unused key and scroll events bubble to the parent widget.
Source§

fn children(&self) -> &[Node<Msg>]

Child nodes, for widgets that contain other widgets.
Source§

fn children_mut(&mut self) -> &mut [Node<Msg>]

Mutable child nodes, used to assign ids.
Source§

fn paint_overlay(&self, _cx: &mut PaintCx<'_>, _anchor: Rect)

Draws the widget’s overlay after the whole view was painted, when it asked for one with PaintCx::request_overlay. anchor is the area the widget was painted in.
Source§

fn focusable(&self) -> bool

Whether the widget can take keyboard focus.

Auto Trait Implementations§

§

impl<Msg> !RefUnwindSafe for Form<Msg>

§

impl<Msg> !Send for Form<Msg>

§

impl<Msg> !Sync for Form<Msg>

§

impl<Msg> !UnwindSafe for Form<Msg>

§

impl<Msg> Freeze for Form<Msg>
where Vec<Node<Msg>>: Freeze,

§

impl<Msg> Unpin for Form<Msg>
where Vec<Node<Msg>>: Unpin,

§

impl<Msg> UnsafeUnpin for Form<Msg>
where Vec<Node<Msg>>: UnsafeUnpin,

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.