Struct CopyModal 

pub struct CopyModal {
    pub focus: CopyFocus,
    pub scope: CopyScope,
    pub format: CopyFormat,
    pub header_row: bool,
    pub header_view: bool,
    pub header_table: bool,
    pub column: Option<String>,
    pub available_columns: Vec<String>,
    pub picker: Option<PickerState>,
    pub attention: bool,
    pub context: CopyContext,
}

Fields

focus: CopyFocus

scope: CopyScope

format: CopyFormat

header_row: bool

Header per tabular scope. A row pasted mid-sheet rarely wants one; a view or table pasted whole usually does. Each remembers its last setting for the session.

header_view: bool

header_table: bool

column: Option<String>

The cell scope’s column: the column cursor’s when the dialog opens.

available_columns: Vec<String>

picker: Option<PickerState>

The one Picker, open for the focused row; None while the form has the keys.

attention: bool

Enter on an incomplete form re-accents the spec line instead of raising a modal; any other key clears it.

context: CopyContext

Implementations

impl CopyModal

pub const MOST_ROWS: u16 = 3

The most rows any scope offers: the dialog’s height, whatever the scope.

pub fn new() -> Self

pub fn open( &mut self, columns: Vec<String>, current: Option<&str>, context: CopyContext, )

Open over the current table. Scope, format and headers are sticky; the cell scope’s column is the column cursor’s, current.

pub fn close(&mut self)

pub fn row_order(&self) -> Vec<CopyFocus>

The rows the dialog offers, in Tab order. The cell scope trades the format and header rows for the column row; a Markdown table without its header row is not a table, so Markdown drops the header row too.

pub fn step_scope(&mut self, delta: i8)

Step the scope. The scope decides which rows exist, so a focus the new scope does not offer goes back to the scope row.

pub fn step_format(&mut self, delta: i8)

Step the format. Markdown has no header row, so focus there moves back.

pub fn step_column(&mut self, delta: i8)

←/→ on the column row: the next or previous column.

pub fn header(&self) -> bool

The header setting the chosen scope carries.

pub fn toggle_header(&mut self)

pub fn is_picker_row(&self, focus: CopyFocus) -> bool

Rows edited through the Picker: the column, a list too long to step. Scope and format step; the header row is a toggle.

pub fn picker_items(&self) -> Vec<String>

What the focused row’s Picker offers.

pub fn open_picker(&mut self)

Open the Picker for the focused row, cursor on the current choice.

pub fn picker_choose(&mut self)

Enter in the column Picker takes the cursor’s item and closes it.

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

Why Enter cannot copy yet, or None when it can.

pub fn spec_line(&self) -> Result<String, String>

What Enter will do, echoed above the footer, or the gap that stops it.

Trait Implementations

impl Default for CopyModal

fn default() -> Self

Returns the “default value” for a type.

impl Form for CopyModal

type Field = CopyFocus

The modal’s name for a field.

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 fields(&self) -> Vec<(CopyFocus, 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) -> CopyFocus

fn set_focused(&mut self, field: CopyFocus)

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