Struct rat_widget::list::edit::EditListState

pub struct EditListState<EditorState> {
    pub list: ListState<RowSelection>,
    pub mouse: MouseFlags,
    /* private fields */
}

State & even-handling.

Fields

list: ListState<RowSelection>

List state

mouse: MouseFlags

Implementations

impl<EditorState> EditListState<EditorState>

where EditorState: Default,

pub fn new() -> Self

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

impl<EditorState> EditListState<EditorState>

where EditorState: HasFocusFlag,

pub fn is_editing(&self) -> bool

Editing is active?

pub fn editor(&self) -> &EditorState

Editor widget.

Panic Panics if not editing.

pub fn try_editor(&self) -> Option<&EditorState>

Editor widget.

pub fn editor_mut(&mut self) -> &mut EditorState

Editor widget.

Panic Panics if not editing.

pub fn try_editor_mut(&mut self) -> Option<&mut EditorState>

Editor widget.

pub fn start_edit(&mut self, pos: usize, edit: EditorState)

Start editing at the position.

The editor state must be initialized to an appropriate state.

pub fn cancel_edit(&mut self)

Cancel editing.

Updates the state to remove the edited row.

pub fn stop_edit(&mut self)

Stops editing.

Assumes the edited row will be inserted into the base data.

Trait Implementations

impl<EditorState: Debug> Debug for EditListState<EditorState>

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

Formats the value using the given formatter.

impl<EditorState: Default> Default for EditListState<EditorState>

fn default() -> EditListState<EditorState>

Returns the “default value” for a type.

impl<EditorState, EQualifier> HandleEvent<Event, EQualifier, EditOutcome> for EditListState<EditorState>

where EditorState: HandleEvent<Event, EQualifier, EditOutcome> + HandleEvent<Event, MouseOnly, EditOutcome> + HasFocusFlag,

fn handle(&mut self, event: &Event, qualifier: EQualifier) -> EditOutcome

Handle an event.

impl<EditorState> HasFocusFlag for EditListState<EditorState>

where EditorState: HasFocusFlag,

fn focus(&self) -> FocusFlag

Access to the flag for the rest.

fn area(&self) -> Rect

Access the area for mouse focus.

fn z_areas(&self) -> &[ZRect]

The widget might have several disjointed areas. This is the case if it is showing a popup, but there might be other causes.

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<EditorState> HasScreenCursor for EditListState<EditorState>

where EditorState: HasScreenCursor,

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

Does the widget have a screen cursor?