Struct cursive::views::Menubar

pub struct Menubar {
    pub autohide: bool,
    // some fields omitted
}

Shows a single-line list of items, with pop-up menus when one is selected.

The Cursive root already includes a menubar that you just need to configure.

Fields

autohide: bool

TODO: move this out of this view.

Methods

impl Menubar

pub fn new() -> Self

Creates a new, empty menubar.

pub fn receive_events(&self) -> bool

True if we should be receiving events.

pub fn has_submenu(&self) -> bool

True if some submenus are visible.

pub fn visible(&self) -> bool

Returns true if we should be drawn.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn add_subtree<S>(&mut self, title: S, menu: MenuTree) -> &mut Self where
    S: Into<String>, 

Adds a new item to the menubar.

The item will use the given title, and on selection, will open a popup-menu with the given menu tree.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn add_delimiter(&mut self) -> &mut Self

Adds a delimiter to the menubar.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn add_leaf<S, F>(&mut self, title: S, cb: F) -> &mut Self where
    S: Into<String>,
    F: 'static + Fn(&mut Cursive), 

Adds a leaf node to the menubar.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn insert_subtree<S>(
    &mut self,
    i: usize,
    title: S,
    menu: MenuTree
) -> &mut Self where
    S: Into<String>, 

Insert a new item at the given position.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn insert_delimiter(&mut self, i: usize) -> &mut Self

Inserts a new delimiter at the given position.

It will show up as |.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn insert_leaf<S, F>(&mut self, i: usize, title: S, cb: F) -> &mut Self where
    S: Into<String>,
    F: 'static + Fn(&mut Cursive), 

Inserts a new leaf node at the given position.

It will be directly actionable.

pub fn clear(&mut self)

Removes all menu items from this menubar.

pub fn len(&self) -> usize

Returns the number of items in this menubar.

pub fn is_empty(&self) -> bool

Returns true if this menubar is empty.

pub fn get_subtree(&mut self, i: usize) -> Option<&mut MenuTree>

Returns the item at the given position.

Returns None if i > self.len()

pub fn find_subtree(&mut self, label: &str) -> Option<&mut MenuTree>

Looks for an item with the given label.

pub fn find_position(&mut self, label: &str) -> Option<usize>

Returns the position of the item with the given label.

Returns None if no such label was found.

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

Remove the item at the given position.

Trait Implementations

impl Default for Menubar

fn default() -> Self

Returns the "default value" for a type.

impl View for Menubar

fn draw(&self, printer: &Printer)

Draws the view with the given printer (includes bounds) and focus.

fn on_event(&mut self, event: Event) -> EventResult

Called when a key was pressed.

fn take_focus(&mut self, _: Direction) -> bool

This view is offered focus. Will it take it?

fn required_size(&mut self, _: Vec2) -> Vec2

Returns the minimum size the view requires with the given restrictions.

fn needs_relayout(&self) -> bool

Returns true if the view content changed since last layout phase.

fn layout(&mut self, Vec2)

Called once the size for this view has been decided,

fn call_on_any<'a>(&mut self, _: &Selector, _: Box<FnMut(&mut Any) + 'a>)

Runs a closure on the view identified by the given selector.

fn focus_view(&mut self, &Selector) -> Result<(), ()>

Moves the focus to the view identified by the given selector.