Struct IntentForm 

pub struct IntentForm {
    pub column: String,
    pub dtype: DataType,
    pub time: Option<TimeInterpretation>,
    pub field: IntentField,
    pub in_key: bool,
    pub required: bool,
    pub number: Option<NumberReading>,
    pub allowed: TextInput,
    pub min: TextInput,
    pub max: TextInput,
    pub error: Option<String>,
}

One column’s declaration, being edited.

Fields

column: String

dtype: DataType

time: Option<TimeInterpretation>

How Text as time reads the column, when it does: the reading here, set there.

field: IntentField

in_key: bool

required: bool

number: Option<NumberReading>

allowed: TextInput

min: TextInput

max: TextInput

error: Option<String>

Why Enter did not apply, until the next edit.

Implementations

impl IntentForm

pub fn new( column: &str, dtype: DataType, time: Option<TimeInterpretation>, declared: &DeclaredIntent, theme: &Theme, ) -> Self

pub fn value_kind(&self) -> ValueKind

What the column’s values are, read as the form says now.

pub fn fields(&self) -> Vec<IntentField>

The rows this column takes: a set where values are codes, a reading where it is text, a range where values have an order.

pub fn adjust(&mut self, forward: bool)

Space, or ←→, on a row that is a choice: the key and required boxes, and the reading, which a Text as time format holds when there is one.

pub fn reading_label(&self) -> String

The reading as the row echoes it.

pub fn input(&self, field: IntentField) -> Option<&TextInput>

pub fn input_mut(&mut self) -> Option<&mut TextInput>

pub fn sync_focus(&mut self)

The text field under the cursor shows its cursor; the others do not.

pub fn typing(&self) -> bool

Whether the cursor is in a text field, so typed keys are text.

pub fn finish(&self) -> Result<(bool, ColumnIntent), String>

The declaration as the form stands, and whether the column is in the key; or why it cannot be measured. Rows the type does not take are left out.

pub fn apply(&self, declared: &mut DeclaredIntent) -> Result<(), String>

Put the declaration into declared, or say why not.

Trait Implementations

impl Form for IntentForm

type Field = IntentField

The modal’s name for a field.

fn fields(&self) -> Vec<(IntentField, FieldKind)>

The fields on screen, top to bottom, each with its kind. A field the current state hides or disables is left out, so focus never lands on it.

fn focused(&self) -> IntentField

fn set_focused(&mut self, field: IntentField)

Put focus on field. Called only with a field of Form::fields; a modal that shows a text cursor in the focused field syncs it here.

fn text_edge(&self, _field: Self::Field) -> (bool, bool)

For a multiline field: whether its cursor is on the first line, and on the last, where ↑ and ↓ leave it.

fn list_row(&self, _field: Self::Field) -> bool

Whether field is a row of a list (a sort, a filter, a column) rather than a setting. A click on a list row only focuses it, so it can be picked to move or remove without changing it; a click on it once focused acts. A setting (a checkbox, a choice, a button) acts on the first click.

fn focused_kind(&self) -> Option<FieldKind>

The focused field’s kind; None when focus is on a field not shown.

fn shown_picker(&mut self) -> Option<(&mut PickerState, bool)>

The picker open over a field, and whether it takes several values; None for a form with no picker open.

fn dismiss_picker(&mut self)

Close the open picker, choosing nothing.

fn pick(&mut self, _toggle: bool)

Take the picker’s item and close it, or with toggle, flip it and stay open.

fn focus(&mut self, field: Self::Field) -> bool

Focus field if the form shows it: a click on a row, or a modal moving focus itself. Returns whether it did.

fn move_focus(&mut self, delta: isize)

Move focus delta fields along, wrapping. A focus the form no longer shows counts from the top.

fn focus_next(&mut self)

fn focus_prev(&mut self)

fn settle_focus(&mut self)

After a change that hides fields: when the focused one went, focus the first field instead, so it never points at nothing.