Struct ListState 

pub struct ListState<T, I>
where
    T: ListItem<I>,
    I: ApplicationInfo,
{ /* private fields */ }

Persistent state for List.

Implementations

impl<T, I> ListState<T, I>

where T: ListItem<I>, I: ApplicationInfo,

pub fn new(id: I::ContentId, items: Vec<T>) -> Self

Create state for a list.

pub fn id(&self) -> I::ContentId

Get the content identifier for this list.

pub fn is_empty(&self) -> bool

Indicates whether or not this list contains any items.

pub fn len(&self) -> usize

Returns the number of items in this list.

pub fn set(&mut self, items: Vec<T>)

Replace the set of items with a new list.

pub fn get(&self) -> Option<&T>

Get a reference to the currently selected value.

pub fn get_mut(&mut self) -> Option<&mut T>

Get a mutable reference to the currently selected value.

pub fn set_term_info(&mut self, area: Rect)

Set the dimensions and placement within the terminal window for this list.

Trait Implementations

impl<T, I> CursorMovements<ListCursor> for ListState<T, I>

where T: ListItem<I>, I: ApplicationInfo,

fn first_word( &self, pos: &ListCursor, _: &CursorMovementsContext<'_, ListCursor>, ) -> ListCursor

Calculate the position of the first word on the line of the provided cursor.

fn movement( &self, pos: &ListCursor, movement: &MoveType, count: &Count, ctx: &CursorMovementsContext<'_, ListCursor>, ) -> Option<ListCursor>

Calculate the position of the cursor after performing a movement.

fn range_of_movement( &self, pos: &ListCursor, movement: &MoveType, count: &Count, ctx: &CursorMovementsContext<'_, ListCursor>, ) -> Option<EditRange<ListCursor>>

Calculate a cursor range from the given cursor to the location after performing the given movement.

fn range( &self, pos: &ListCursor, range: &RangeType, _: bool, count: &Count, ctx: &CursorMovementsContext<'_, ListCursor>, ) -> Option<EditRange<ListCursor>>

Calculate a cursor range based on a given cursor position and a RangeType.

impl<T, I> CursorSearch<ListCursor> for ListState<T, I>

where T: ListItem<I>, I: ApplicationInfo,

fn find_char( &self, _: &ListCursor, _: bool, _: MoveDir1D, _: bool, _: char, _: usize, ) -> Option<ListCursor>

Search for a specific character.

fn find_matches( &self, _: &ListCursor, _: &ListCursor, _: &Regex, ) -> Vec<EditRange<ListCursor>>

Find matches for a regular expression within a range.

fn find_regex( &self, pos: &ListCursor, dir: MoveDir1D, needle: &Regex, count: usize, ) -> Option<EditRange<ListCursor>>

Search for a regular expression.

impl<T, I> Editable<EditContext, Store<I>, I> for ListState<T, I>

where T: ListItem<I>, I: ApplicationInfo,

fn editor_command( &mut self, act: &EditorAction, ctx: &EditContext, store: &mut Store<I>, ) -> EditResult<EditInfo, I>

Execute an editor action.

impl<T, I> EditorActions<EditContext, Store<I>, I> for ListState<T, I>

where T: ListItem<I>, I: ApplicationInfo,

fn edit( &mut self, operation: &EditAction, motion: &EditTarget, ctx: &EditContext, store: &mut Store<I>, ) -> EditResult<EditInfo, I>

Perform an editing operation over the targeted text.

fn mark( &mut self, name: Mark, _: &EditContext, store: &mut Store<I>, ) -> EditResult<EditInfo, I>

Create or update a cursor mark based on the leader’s cursor position.

fn complete( &mut self, _: &CompletionStyle, _: &CompletionType, _: &CompletionDisplay, _: &EditContext, _: &mut Store<I>, ) -> EditResult<EditInfo, I>

Complete the text before the cursor group leader.

fn insert_text( &mut self, _: &InsertTextAction, _: &EditContext, _: &mut Store<I>, ) -> EditResult<EditInfo, I>

Insert text relative to the current cursor position.

fn selection_command( &mut self, _: &SelectionAction, _: &EditContext, _: &mut Store<I>, ) -> EditResult<EditInfo, I>

Modify the current selection.

fn history_command( &mut self, act: &HistoryAction, _: &EditContext, _: &mut Store<I>, ) -> EditResult<EditInfo, I>

Move to a different point in the buffer’s editing history.

fn cursor_command( &mut self, act: &CursorAction, ctx: &EditContext, store: &mut Store<I>, ) -> EditResult<EditInfo, I>

Perform an action over a cursor group.

impl<T, I> Jumpable<EditContext, I> for ListState<T, I>

where T: ListItem<I>, I: ApplicationInfo,

fn jump( &mut self, list: PositionList, dir: MoveDir1D, count: usize, _: &EditContext, ) -> UIResult<usize, I>

Move through a PositionList in MoveDir1D direction count times.

impl<C, I, T> Promptable<C, Store<I>, I> for ListState<T, I>

where I: ApplicationInfo, T: ListItem<I> + Promptable<C, Store<I>, I>,

fn prompt( &mut self, act: &PromptAction, ctx: &C, store: &mut Store<I>, ) -> EditResult<Vec<(Action<I>, C)>, I>

Execute a prompt action.

impl<I, T> ScrollActions<EditContext, Store<I>, I> for ListState<T, I>

where I: ApplicationInfo, T: ListItem<I>,

fn dirscroll( &mut self, dir: MoveDir2D, size: ScrollSize, count: &Count, ctx: &EditContext, store: &mut Store<I>, ) -> EditResult<EditInfo, I>

Pan the viewport.

fn cursorpos( &mut self, pos: MovePosition, axis: Axis, _: &EditContext, store: &mut Store<I>, ) -> EditResult<EditInfo, I>

Scroll so that the cursor is placed along a viewport boundary.

fn linepos( &mut self, pos: MovePosition, count: &Count, ctx: &EditContext, store: &mut Store<I>, ) -> EditResult<EditInfo, I>

Scroll so that a specific line is placed at a given place in the viewport.

impl<I, T> Scrollable<EditContext, Store<I>, I> for ListState<T, I>

where I: ApplicationInfo, T: ListItem<I>,

fn scroll( &mut self, style: &ScrollStyle, ctx: &EditContext, store: &mut Store<I>, ) -> EditResult<EditInfo, I>

Scroll the viewable content in this object.

impl<I, T> Searchable<EditContext, Store<I>, I> for ListState<T, I>

where I: ApplicationInfo, T: ListItem<I>,

fn search( &mut self, dir: MoveDirMod, count: Count, ctx: &EditContext, store: &mut Store<I>, ) -> UIResult<EditInfo, I>

Search for the n^th result in MoveDirMod direction.

impl<T, I> TerminalCursor for ListState<T, I>

where T: ListItem<I>, I: ApplicationInfo,

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

Returns the current offset of the cursor, relative to the upper left corner of the terminal.

impl<I, T> WindowOps<I> for ListState<T, I>

where T: ListItem<I>, I: ApplicationInfo,

fn dup(&self, _: &mut Store<I>) -> Self

Create a copy of this window during a window split.

fn close(&mut self, _: CloseFlags, _: &mut Store<I>) -> bool

Perform any necessary cleanup for this window and close it.

fn write( &mut self, _: Option<&str>, _: WriteFlags, _: &mut Store<I>, ) -> UIResult<EditInfo, I>

Write the contents of the window.

fn draw( &mut self, area: Rect, buf: &mut Buffer, focused: bool, store: &mut Store<I>, )

Draw this window into the buffer for the prescribed area.

fn get_completions(&self) -> Option<CompletionList>

Get completion candidates to show the user.

fn get_cursor_word(&self, _: &WordStyle) -> Option<String>

Returns the word following the current cursor position in this window.

fn get_selected_word(&self) -> Option<String>

Returns the currently selected text in this window.