Struct SchemaForm 

pub struct SchemaForm { /* private fields */ }

A form built from a schema.

It is a view rather than a builder because the fields it composes — TextInput, NumberInput, Select, Combobox, TagInput — each own a caret, an open menu, or a selection that has to survive a frame.

Implementations

impl SchemaForm

pub fn new( ident: impl Into<Ident>, schema: Schema, window: &mut Window, cx: &mut Context<'_, Self>, ) -> Self

pub fn set_error( &mut self, path: impl Into<SharedString>, message: impl Into<SharedString>, cx: &mut Context<'_, Self>, )

Shows an error the host returned, next to the field it is about.

pub fn clear_host_errors(&mut self, cx: &mut Context<'_, Self>)

Withdraws every error the host reported. What the form worked out for itself is untouched, because the host did not put it there.

pub fn validate(&mut self, cx: &mut Context<'_, Self>) -> bool

Marks every required field nobody filled in, and reports whether the form is answerable at all.

A form holding a field it cannot draw is never answerable, whatever is typed into the rest of it. Neither is one holding a number outside the range the schema gave it: the control already draws that as wrong, and a form that called it answerable anyway would be contradicting what is on screen.

pub fn values(&self, cx: &App) -> Vec<(SharedString, FieldValue)>

Every field and what it holds, including the ones the form could not draw. A caller that builds a call from this cannot lose a field without seeing it.

pub fn unrenderable(&self) -> &[UnrenderableField]

The fields that have to be filled in somewhere else.

pub fn has_unrenderable_required(&self) -> bool

Whether any field the form could not draw is one the call requires.

pub fn set_disabled(&mut self, disabled: bool, cx: &mut Context<'_, Self>)

Trait Implementations

impl Debug for SchemaForm

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

Formats the value using the given formatter.

impl Disableable for SchemaForm

fn disabled(self, disabled: bool) -> Self

impl EventEmitter<SchemaFormEvent> for SchemaForm

impl Render for SchemaForm

fn render( &mut self, _window: &mut Window, cx: &mut Context<'_, Self>, ) -> impl IntoElement

Render this view into an element tree.

impl Sizable for SchemaForm

fn control_size(self, size: ControlSize) -> Self

fn xs(self) -> Self

fn small(self) -> Self

fn medium(self) -> Self

fn large(self) -> Self