Struct modalkit::ui::FocusList

pub struct FocusList<T> { /* private fields */ }

List of items that tracks a current and previous focus.

Implementations

impl<T> FocusList<T>

pub fn new(items: Vec<T>) -> Self

Create a new FocusList given an original set of items.

pub fn len(&self) -> usize

Returns how many items are in this list.

pub fn is_empty(&self) -> bool

Indicates whether this list is empty.

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

Get a reference to the currently focused item.

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

Get a mutable reference to the currently focused item.

pub fn pos(&self) -> usize

Get the currently focused position in this list.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut T>

Iterate over mutable references to the items in this list.

pub fn iter(&self) -> impl Iterator<Item = &T>

Iterate over references to the items in this list.

pub fn try_close<E, F>( &mut self, target: &TabTarget, f: F, ctx: &EditContext, ) -> Result<(), E>

where F: FnMut(&mut T) -> Result<(), E>,

Try closing targeted items using f until one fails or all targets are closed.

If the target cannot be closed, focus will be moved to it.

pub fn target( &self, change: &FocusChange, ctx: &EditContext, ) -> Option<(usize, MoveDir1D)>

Determine the index of the item targeted by a given FocusChange.

The MoveDir1D value returned indicates which side of the index to insert at.

pub fn insert(&mut self, idx: usize, side: MoveDir1D, item: T)

Insert an item before or after a given index.

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

Remove the item located at a given index.

pub fn remove_current(&mut self)

Remove the currently focused item.

pub fn focus(&mut self, change: &FocusChange, ctx: &EditContext)

Switch focus to a new item.

pub fn transfer(&mut self, change: &FocusChange, ctx: &EditContext)

Move the currently focused item to a new position.

pub fn push(&mut self, item: T)

Push a new item onto the end of this list.

Trait Implementations

impl<T> AsRef<[T]> for FocusList<T>

fn as_ref(&self) -> &[T]

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> Default for FocusList<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> From<T> for FocusList<T>

fn from(item: T) -> Self

Converts to this type from the input type.

impl<T> Index<usize> for FocusList<T>

type Output = T

The returned type after indexing.

fn index(&self, index: usize) -> &T

Performs the indexing (container[index]) operation.