Struct Menu 

pub struct Menu<T = ()> { /* private fields */ }

A vertical list of items in a single-line box. CursorDown/CursorUp move the focus (wrapping, skipping disabled items), Confirm chooses the focused item, Cancel cancels (unless the menu is without_cancel). A menu showing fewer rows than it has scrolls.

Implementations

impl<T> Menu<T>

pub const ACTIONS: &'static [UiAction]

What a menu reacts to (handle), for the screen that shows it to declare (Screen::actions).

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

A menu focused on its first enabled item (or the first item, if none is enabled).

pub fn without_cancel(self) -> Self

The same menu where Cancel does nothing (and so plays nothing): for menus with nothing to back out of.

pub fn browsing_disabled(self) -> Self

The same menu where the focus also stops on disabled items, so the player can read what they do. Confirm on one still chooses nothing.

pub fn showing(self, rows: usize, scroll: Scroll) -> Self

The same menu showing at most rows rows: a longer one scrolls, its window following the focus by scroll.

pub fn focused(self, index: usize) -> Self

The same menu focused on item index, if it exists and the focus may stop on it (it is enabled, or the menu is browsing_disabled).

pub fn items(&self) -> &[MenuItem<T>]

The items, in order.

pub fn value(&self, index: usize) -> Option<&T>

The value item index stands for, if it exists.

pub fn focus(&self) -> usize

Index of the focused item.

pub fn handle<A: ActionSet>(&mut self, action: A) -> Option<MenuEvent<T>>

where T: Clone,

Handles one action, by what the game takes it for. Returns an event for UiAction::Confirm on an enabled item (with a copy of its value) and for UiAction::Cancel; moves the focus for UiAction::Down and UiAction::Up; ignores everything else.

pub fn handle_with_sound<A: ActionSet, V>( &mut self, action: A, audio: &mut AudioQueue<V>, ) -> Option<MenuEvent<T>>

where T: Clone,

handle, playing the MenuSounds on audio: Move when the focus moves, Select when an item is chosen, Cancel when cancelled, Denied for Confirm on a disabled item. Any other action that does nothing (a move with nowhere to go) plays nothing.

pub fn view(&self) -> MenuView

What the menu shows: every item, which one has the focus, and the window of them the box shows.

Trait Implementations

impl<T: Clone> Clone for Menu<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Menu<T>

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

Formats the value using the given formatter.

impl<T: Eq> Eq for Menu<T>

impl<T: PartialEq> PartialEq for Menu<T>

fn eq(&self, other: &Menu<T>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<T: PartialEq> StructuralPartialEq for Menu<T>