Struct prototty_common::MenuInstance

pub struct MenuInstance<T: Copy> { /* fields omitted */ }

An instance of a menu, with a selected entry. When a MenuInstance is rendered, the currently-selected entry is rendered using the Menu's selected_info.

Methods

impl<T: Copy> MenuInstance<T>

pub fn new(menu: Menu<T>) -> Option<Self>

Create a new MenuInstance with the first entry selected. Returns None if the Menu has 0 elements.

pub fn with_index(menu: Menu<T>, index: usize) -> Option<Self>

Create a new MenuInstance with the given index selected. Returns None if index >= menu.entries.len().

pub fn menu(&self) -> &Menu<T>

Returns a reference to the internal menu

pub fn into_menu(self) -> Menu<T>

Consumes the instance, returning its menu

pub fn index(&self) -> usize

Returns the current index

pub fn set_index(&mut self, index: usize)

Sets the index, if the specified index < menu.entries.len()

pub fn up(&mut self)

Select the entry above the current selection, unless the first entry is currently selected.

pub fn down(&mut self)

Select the entry below the current selection, unless the last entry is currently selected.

pub fn selected(&self) -> T

Returns a copy of the currently selected entry's value.

pub fn tick<I>(&mut self, inputs: I) -> Option<MenuOutput<T>> where
    I: IntoIterator<Item = Input>, 

Feed input into the menu instance, possibly changing the selected entry, cancelling the menu, attempting to exit the program, or finalising the selection.

pub fn tick_with_mouse<'a, I, M>(
    &mut self,
    inputs: I,
    view: &'a M
) -> Option<MenuOutput<T>> where
    I: IntoIterator<Item = Input>,
    M: MenuIndexFromScreenCoord, 

Trait Implementations

impl<T: Clone + Copy> Clone for MenuInstance<T>

fn clone(&self) -> MenuInstance<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Copy> Debug for MenuInstance<T>

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

Formats the value using the given formatter.

impl<T: Copy> View<MenuInstance<T>> for DefaultMenuInstanceView

fn view<G: ViewGrid>(
    &mut self,
    value: &MenuInstance<T>,
    offset: Coord,
    depth: i32,
    grid: &mut G
)

Update the cells in grid to describe how a type should be rendered. This mutably borrows self to allow the view to contain buffers/caches which are updated during rendering.

impl<T: Copy> ViewSize<MenuInstance<T>> for DefaultMenuInstanceView

fn size(&mut self, data: &MenuInstance<T>) -> Size

Returns the size in cells of the rectangle containing a ui element. This allows for the implementation of decorator ui components that render a border around some inner element.