Struct MenuItem 

pub struct MenuItem<T = ()> {
    pub value: T,
    pub label: Label,
    pub enabled: bool,
    pub suffix: Option<(String, SuffixKind)>,
    pub note: Option<String>,
}

One menu entry, standing for a value of the game’s type (() for a menu whose screen only needs to know an item was chosen).

Fields

value: T

What the item stands for: what MenuEvent::Chosen gives back.

label: Label

Text shown: a text key the skin puts in the player’s language, or text as it is.

enabled: bool

Disabled items are drawn dim, skipped by the cursor and can’t be chosen.

suffix: Option<(String, SuffixKind)>

Text shown after the label (e.g. (broken)), and what it is.

note: Option<String>

What the item does, shown under the list while it has the focus (a description in a list).

Implementations

impl MenuItem

pub fn new(label: impl Into<String>) -> Self

An enabled item showing label as it is.

pub fn keyed(key: impl Into<String>) -> Self

An enabled item showing the text for key in the player’s language. Give its placeholders values with with_arg.

pub fn disabled(label: impl Into<String>) -> Self

A disabled item showing label as it is.

pub fn labelled(label: Label) -> Self

An enabled item showing label.

impl<T> MenuItem<T>

pub fn with_value<U>(self, value: U) -> MenuItem<U>

The same item standing for value.

pub fn with_arg(self, name: impl Into<String>, value: impl Display) -> Self

The same item with the placeholder {name} of its keyed label filled by value (a label of text as it is stays as it is).

pub fn with_enabled(self, enabled: bool) -> Self

The same item, enabled or not.

pub fn with_suffix(self, text: impl Into<String>, kind: SuffixKind) -> Self

The same item with text of kind after its label.

pub fn with_note(self, text: impl Into<String>) -> Self

The same item with text saying what it does, shown under the list while it has the focus.

Trait Implementations

impl<T: Clone> Clone for MenuItem<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for MenuItem<T>

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

Formats the value using the given formatter.

impl<T: Eq> Eq for MenuItem<T>

impl<T: PartialEq> PartialEq for MenuItem<T>

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

Equality operator ==.

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

Inequality operator !=.

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