Struct EditListState 

pub struct EditListState<S> {
    pub mode: Mode,
    pub list: ListState<RowSelection>,
    pub editor: S,
    pub mouse: MouseFlags,
}

State & event-handling.

Contains mode to differentiate between edit/non-edit. This will lock the focus to the input line while editing.

Fields

mode: Mode

Editing mode.

list: ListState<RowSelection>

List state

editor: S

EditorState. Some indicates editing is active.

mouse: MouseFlags

Flags for mouse interaction.

Implementations

impl<S> EditListState<S>

pub fn new(editor: S) -> Self

New state.

pub fn named(name: &str, editor: S) -> Self

New state with a named focus.

impl<S> EditListState<S>

where S: HasFocus,

pub fn is_editing(&self) -> bool

Editing is active?

pub fn is_insert(&self) -> bool

Is the current edit an insert?

pub fn remove(&mut self, row: usize)

Remove the item at the selected row.

This doesn’t change the actual list of items, but does all the bookkeeping with the list-state.

pub fn edit_new(&mut self, row: usize)

Edit a new item inserted at the selected row.

The editor state must be initialized to an appropriate state beforehand.

This does all the bookkeeping with the list-state and switches the mode to Mode::Insert.

pub fn edit(&mut self, row: usize)

Edit the item at the selected row.

The editor state must be initialized to an appropriate state beforehand.

This does all the bookkeeping with the list-state and switches the mode to Mode::Edit.

pub fn cancel(&mut self)

Cancel editing.

This doesn’t reset the edit-widget.

But it does all the bookkeeping with the list-state and switches the mode back to Mode::View.

pub fn commit(&mut self)

Commit the changes in the editor.

This doesn’t copy the data back from the editor to the row-item.

But it does all the bookkeeping with the list-state and switches the mode back to Mode::View.

Trait Implementations

impl<S: Clone> Clone for EditListState<S>

fn clone(&self) -> EditListState<S>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S: Debug> Debug for EditListState<S>

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

Formats the value using the given formatter.

impl<S> Default for EditListState<S>

where S: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<S, C> HandleEvent<Event, C, EditOutcome> for EditListState<S>

where S: HandleEvent<Event, C, EditOutcome> + HandleEvent<Event, MouseOnly, EditOutcome> + HasFocus,

fn handle(&mut self, event: &Event, ctx: C) -> EditOutcome

Handle an event.

impl<S> HasFocus for EditListState<S>

where S: HasFocus,

fn build(&self, builder: &mut FocusBuilder)

Build the focus-structure for the container/widget.

fn focus(&self) -> FocusFlag

Access to the flag for the rest.

fn area(&self) -> Rect

Area for mouse focus.

fn build_nav(&self, navigable: Navigation, builder: &mut FocusBuilder)

Build the focus-structure for the container/widget. This is called when the default navigation will be overridden by the builder.

fn id(&self) -> usize

Provide a unique id for the widget.

fn area_z(&self) -> u16

Z value for the area.

fn navigable(&self) -> Navigation

Declares how the widget interacts with focus.

fn is_focused(&self) -> bool

Focused?

fn lost_focus(&self) -> bool

Just lost focus.

fn gained_focus(&self) -> bool

Just gained focus.

impl<S> HasScreenCursor for EditListState<S>

where S: HasScreenCursor,

fn screen_cursor(&self) -> Option<(u16, u16)>

This returns the cursor position if

impl<S> RelocatableState for EditListState<S>

where S: RelocatableState,

fn relocate(&mut self, shift: (i16, i16), clip: Rect)

Relocate the areas in this widgets state.

fn relocate_popup(&mut self, shift: (i16, i16), clip: Rect)

Relocate only popup areas. As rendering the popups is a separate render, this has to be separate too.

fn relocate_popup_hidden(&mut self)

Relocate all popup areas to a clip-rect (0,0+0x0).

fn relocate_hidden(&mut self)

Relocate all areas to a clip-rect (0,0+0x0).