Struct Menu 

pub struct Menu { /* private fields */ }

A vertical list of items navigated with the arrow keys.

Key	Action
Up / Down	previous / next item
Home / End	first / last item
Enter / Space	press button, toggle checkbox, next choice, edit text
Left / Right	adjust slider or choice, toggle checkbox
Page Up / Page Down	adjust slider by ten steps
Letters	jump to the next item starting with that letter
Escape	close (if Menu::closable)

let menu = Menu::new("options", "Options")
    .slider("volume", "Volume", 80.0, 0.0, 100.0, 5.0)
    .choice("difficulty", "Difficulty", &["Easy", "Normal", "Hard"], 1)
    .checkbox("subtitles", "Speak hints", true)
    .text_field("name", "Player name", "Hero")
    .button("back", "Back")
    .music("menu_theme");

Implementations

impl Menu

pub fn new(id: impl Into<String>, title: impl Into<String>) -> Self

Creates an empty menu. title is spoken when it opens (may be empty).

Examples found in repository

examples/beacon.rs (line 139)

    fn start(&mut self, ctx: &mut Context) {
        ctx.time.pause();
        ctx.ui.open(Menu::new("pause", "Paused").button("resume", "Resume").button("quit", "Quit game"));
    }

examples/menus.rs (line 18)

fn main_menu() -> Menu {
    Menu::new("main", "Main menu")
        .button("play", "Play")
        .button("options", "Options")
        .button("name", "Change name")
        .button("quit", "Quit")
        .closable(false)
        .wrap(true)
}

fn options_menu(s: &Settings) -> Menu {
    Menu::new("options", "Options")
        .slider("volume", "Volume", s.volume * 100.0, 0.0, 100.0, 10.0)
        .choice("difficulty", "Difficulty", &["Easy", "Normal", "Hard"], s.difficulty)
        .text_field("name", "Player name", s.name.clone())
        .button("back", "Back")
}

examples/bell_catcher.rs (line 52)

fn title_menu(ctx: &Context) -> Menu {
    let voice = ctx.speech.voice().map_or("default".to_string(), |v| v.name.clone());
    let best: u32 = ctx.storage.get_or("best", 0);
    Menu::new("title", "Bell Catcher")
        .button("play", "Play")
        .button("voice", format!("Voice: {voice}"))
        .slider("rate", "Speech rate", ctx.storage.get_or("rate", 50.0), 0.0, 100.0, 5.0)
        .button("help", "How to play")
        .label(format!("Best score: {best}"))
        .button("quit", "Quit")
        .closable(false)
        .wrap(true)
}

/// One button per voice, with the current one focused. `None` if the output has no voices.
fn voice_menu(ctx: &Context) -> Option<Menu> {
    let voices = ctx.speech.voices();
    if voices.is_empty() {
        return None;
    }
    let mut menu = Menu::new("voices", "Choose a voice").button("default", "Default voice");
    for (i, voice) in voices.iter().enumerate() {
        menu = menu.button(format!("voice{i}"), voice.to_string());
    }
    if let Some(i) = ctx.speech.voice().and_then(|current| voices.iter().position(|v| v == current)) {
        menu = menu.focus(&format!("voice{i}"));
    }
    Some(menu.button("back", "Back"))
}

pub fn item(self, item: MenuItem) -> Self

Adds any item.

pub fn button(self, id: impl Into<String>, label: impl Into<String>) -> Self

Adds a button.

Examples found in repository

examples/beacon.rs (line 139)

    fn start(&mut self, ctx: &mut Context) {
        ctx.time.pause();
        ctx.ui.open(Menu::new("pause", "Paused").button("resume", "Resume").button("quit", "Quit game"));
    }

examples/menus.rs (line 19)

fn main_menu() -> Menu {
    Menu::new("main", "Main menu")
        .button("play", "Play")
        .button("options", "Options")
        .button("name", "Change name")
        .button("quit", "Quit")
        .closable(false)
        .wrap(true)
}

fn options_menu(s: &Settings) -> Menu {
    Menu::new("options", "Options")
        .slider("volume", "Volume", s.volume * 100.0, 0.0, 100.0, 10.0)
        .choice("difficulty", "Difficulty", &["Easy", "Normal", "Hard"], s.difficulty)
        .text_field("name", "Player name", s.name.clone())
        .button("back", "Back")
}

examples/bell_catcher.rs (line 53)

fn title_menu(ctx: &Context) -> Menu {
    let voice = ctx.speech.voice().map_or("default".to_string(), |v| v.name.clone());
    let best: u32 = ctx.storage.get_or("best", 0);
    Menu::new("title", "Bell Catcher")
        .button("play", "Play")
        .button("voice", format!("Voice: {voice}"))
        .slider("rate", "Speech rate", ctx.storage.get_or("rate", 50.0), 0.0, 100.0, 5.0)
        .button("help", "How to play")
        .label(format!("Best score: {best}"))
        .button("quit", "Quit")
        .closable(false)
        .wrap(true)
}

/// One button per voice, with the current one focused. `None` if the output has no voices.
fn voice_menu(ctx: &Context) -> Option<Menu> {
    let voices = ctx.speech.voices();
    if voices.is_empty() {
        return None;
    }
    let mut menu = Menu::new("voices", "Choose a voice").button("default", "Default voice");
    for (i, voice) in voices.iter().enumerate() {
        menu = menu.button(format!("voice{i}"), voice.to_string());
    }
    if let Some(i) = ctx.speech.voice().and_then(|current| voices.iter().position(|v| v == current)) {
        menu = menu.focus(&format!("voice{i}"));
    }
    Some(menu.button("back", "Back"))
}

pub fn checkbox( self, id: impl Into<String>, label: impl Into<String>, checked: bool, ) -> Self

Adds a checkbox.

pub fn slider( self, id: impl Into<String>, label: impl Into<String>, value: f32, min: f32, max: f32, step: f32, ) -> Self

Adds a slider. value is the start value, min and max the range, and step how much Left and Right change it (Page Up and Page Down change it by ten steps). slider("volume", "Volume", 80.0, 0.0, 100.0, 5.0) starts at 80 and goes from 0 to 100 in steps of 5. Read the value with Value::as_f32.

Examples found in repository

examples/menus.rs (line 29)

fn options_menu(s: &Settings) -> Menu {
    Menu::new("options", "Options")
        .slider("volume", "Volume", s.volume * 100.0, 0.0, 100.0, 10.0)
        .choice("difficulty", "Difficulty", &["Easy", "Normal", "Hard"], s.difficulty)
        .text_field("name", "Player name", s.name.clone())
        .button("back", "Back")
}

examples/bell_catcher.rs (line 55)

fn title_menu(ctx: &Context) -> Menu {
    let voice = ctx.speech.voice().map_or("default".to_string(), |v| v.name.clone());
    let best: u32 = ctx.storage.get_or("best", 0);
    Menu::new("title", "Bell Catcher")
        .button("play", "Play")
        .button("voice", format!("Voice: {voice}"))
        .slider("rate", "Speech rate", ctx.storage.get_or("rate", 50.0), 0.0, 100.0, 5.0)
        .button("help", "How to play")
        .label(format!("Best score: {best}"))
        .button("quit", "Quit")
        .closable(false)
        .wrap(true)
}

pub fn choice( self, id: impl Into<String>, label: impl Into<String>, options: &[&str], selected: usize, ) -> Self

Adds a choice between several options. selected is the index of the option chosen at the start (0 = the first one).

Examples found in repository

examples/menus.rs (line 30)

fn options_menu(s: &Settings) -> Menu {
    Menu::new("options", "Options")
        .slider("volume", "Volume", s.volume * 100.0, 0.0, 100.0, 10.0)
        .choice("difficulty", "Difficulty", &["Easy", "Normal", "Hard"], s.difficulty)
        .text_field("name", "Player name", s.name.clone())
        .button("back", "Back")
}

pub fn text_field( self, id: impl Into<String>, label: impl Into<String>, value: impl Into<String>, ) -> Self

Adds an editable text field.

Examples found in repository

examples/menus.rs (line 31)

fn options_menu(s: &Settings) -> Menu {
    Menu::new("options", "Options")
        .slider("volume", "Volume", s.volume * 100.0, 0.0, 100.0, 10.0)
        .choice("difficulty", "Difficulty", &["Easy", "Normal", "Hard"], s.difficulty)
        .text_field("name", "Player name", s.name.clone())
        .button("back", "Back")
}

pub fn password_field( self, id: impl Into<String>, label: impl Into<String>, ) -> Self

Adds a password field (content is never spoken).

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

Adds a line of information that cannot be activated.

Examples found in repository

examples/bell_catcher.rs (line 57)

fn title_menu(ctx: &Context) -> Menu {
    let voice = ctx.speech.voice().map_or("default".to_string(), |v| v.name.clone());
    let best: u32 = ctx.storage.get_or("best", 0);
    Menu::new("title", "Bell Catcher")
        .button("play", "Play")
        .button("voice", format!("Voice: {voice}"))
        .slider("rate", "Speech rate", ctx.storage.get_or("rate", 50.0), 0.0, 100.0, 5.0)
        .button("help", "How to play")
        .label(format!("Best score: {best}"))
        .button("quit", "Quit")
        .closable(false)
        .wrap(true)
}

pub fn wrap(self, wrap: bool) -> Self

Jump from the last to the first item and back (default false).

Examples found in repository

examples/menus.rs (line 24)

fn main_menu() -> Menu {
    Menu::new("main", "Main menu")
        .button("play", "Play")
        .button("options", "Options")
        .button("name", "Change name")
        .button("quit", "Quit")
        .closable(false)
        .wrap(true)
}

examples/bell_catcher.rs (line 60)

fn title_menu(ctx: &Context) -> Menu {
    let voice = ctx.speech.voice().map_or("default".to_string(), |v| v.name.clone());
    let best: u32 = ctx.storage.get_or("best", 0);
    Menu::new("title", "Bell Catcher")
        .button("play", "Play")
        .button("voice", format!("Voice: {voice}"))
        .slider("rate", "Speech rate", ctx.storage.get_or("rate", 50.0), 0.0, 100.0, 5.0)
        .button("help", "How to play")
        .label(format!("Best score: {best}"))
        .button("quit", "Quit")
        .closable(false)
        .wrap(true)
}

pub fn closable(self, closable: bool) -> Self

Allow closing with Escape (default true). A main menu often sets this to false.

Examples found in repository

examples/menus.rs (line 23)

fn main_menu() -> Menu {
    Menu::new("main", "Main menu")
        .button("play", "Play")
        .button("options", "Options")
        .button("name", "Change name")
        .button("quit", "Quit")
        .closable(false)
        .wrap(true)
}

examples/bell_catcher.rs (line 59)

fn title_menu(ctx: &Context) -> Menu {
    let voice = ctx.speech.voice().map_or("default".to_string(), |v| v.name.clone());
    let best: u32 = ctx.storage.get_or("best", 0);
    Menu::new("title", "Bell Catcher")
        .button("play", "Play")
        .button("voice", format!("Voice: {voice}"))
        .slider("rate", "Speech rate", ctx.storage.get_or("rate", 50.0), 0.0, 100.0, 5.0)
        .button("help", "How to play")
        .label(format!("Best score: {best}"))
        .button("quit", "Quit")
        .closable(false)
        .wrap(true)
}

pub fn positions(self, positions: bool) -> Self

Speak “2 of 5” after each item (default false).

pub fn close_on_activate(self, close: bool) -> Self

Close the menu automatically after a button was pressed (default false).

pub fn sounds(self, sounds: UiSounds) -> Self

Use these sounds instead of the global ones for this menu.

pub fn sound(self, kind: UiSound, name: Option<&str>) -> Self

Changes one sound for this menu only, e.g. a special click for the main menu. None makes it silent. All other sounds stay as they are.

pub fn music(self, name: impl Into<String>) -> Self

Plays the music name in a loop while this menu is open (a file or registered sound). Submenus and dialogs on top keep it playing unless they have music of their own. When the menu closes, the music that played before comes back, or the music fades out.

pub fn focus(self, id: &str) -> Self

Start with the item id focused.

Examples found in repository

examples/bell_catcher.rs (line 74)

fn voice_menu(ctx: &Context) -> Option<Menu> {
    let voices = ctx.speech.voices();
    if voices.is_empty() {
        return None;
    }
    let mut menu = Menu::new("voices", "Choose a voice").button("default", "Default voice");
    for (i, voice) in voices.iter().enumerate() {
        menu = menu.button(format!("voice{i}"), voice.to_string());
    }
    if let Some(i) = ctx.speech.voice().and_then(|current| voices.iter().position(|v| v == current)) {
        menu = menu.focus(&format!("voice{i}"));
    }
    Some(menu.button("back", "Back"))
}

/// Reopens the title menu so its labels show the new values, focused on `item`.
fn refresh_title(ctx: &mut Context, item: &str) {
    ctx.ui.close_id("title");
    let menu = title_menu(ctx).focus(item);
    ctx.ui.open(menu);
}

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

The items of this menu.

pub fn current(&self) -> Option<&MenuItem>

The focused item.

Trait Implementations

impl Clone for Menu

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Menu

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

Formats the value using the given formatter.

impl Widget for Menu

fn id(&self) -> &str

Identifier used in events.

fn open(&mut self, ui: &mut UiContext<'_>)

Called once when the widget becomes active. Announce yourself here.

fn resume(&mut self, value: Option<Value>, ui: &mut UiContext<'_>)

Called when the widget becomes the top again after the one above closed. value is what the closed widget passed with Status::CloseWith.

fn update(&mut self, ui: &mut UiContext<'_>) -> Status

Called every frame while this widget is on top of the stack.

fn value(&self, item: &str) -> Option<Value>

Current value of an item, used by Ui::value.

fn music(&self) -> Option<&str>

Music that plays while this widget is open, see Menu::music. Widgets above it without music of their own keep it playing.