Struct Menubar

Source
pub struct Menubar {
    pub autohide: bool,
    /* private fields */
}
Expand description

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.

Implementations§

Source§

impl Menubar

Source

pub fn new() -> Menubar

Creates a new, empty menubar.

Source

pub fn receive_events(&self) -> bool

True if we should be receiving events.

Source

pub fn has_submenu(&self) -> bool

True if some submenus are visible.

Source

pub fn visible(&self) -> bool

Returns true if we should be drawn.

Source

pub fn insert(&mut self, i: usize, item: Item) -> &mut Menubar

Adds a new item to the menubar.

Source

pub fn item(&mut self, item: Item) -> &mut Menubar

Adds a new item to the menubar.

Source

pub fn add_subtree<S>(&mut self, title: S, menu: Tree) -> &mut Menubar

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.

Source

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

Adds a delimiter to the menubar.

Source

pub fn add_leaf<S, F>(&mut self, title: S, cb: F) -> &mut Menubar
where S: Into<SpannedString<Style>>, F: 'static + Fn(&mut Cursive) + Send + Sync,

Adds a leaf node to the menubar.

Source

pub fn insert_subtree<S>( &mut self, i: usize, title: S, menu: Tree, ) -> &mut Menubar

Insert a new item at the given position.

Source

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

Inserts a new delimiter at the given position.

It will show up as |.

Source

pub fn insert_leaf<S, F>(&mut self, i: usize, title: S, cb: F) -> &mut Menubar
where S: Into<SpannedString<Style>>, F: 'static + Fn(&mut Cursive) + Send + Sync,

Inserts a new leaf node at the given position.

It will be directly actionable.

Source

pub fn clear(&mut self)

Removes all menu items from this menubar.

Source

pub fn len(&self) -> usize

Returns the number of items in this menubar.

Source

pub fn is_empty(&self) -> bool

Returns true if this menubar is empty.

Source

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

Returns the item at the given position.

Returns None if i > self.len()

Source

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

Looks for an item with the given label.

Source

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.

Source

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

Remove the item at the given position.

Trait Implementations§

Source§

impl Default for Menubar

Source§

fn default() -> Menubar

Returns the “default value” for a type. Read more
Source§

impl View for Menubar

Source§

fn draw(&self, printer: &Printer<'_, '_>)

Draws the view with the given printer (includes bounds) and focus. Read more
Source§

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

Called when an event is received (key press, mouse event, …). Read more
Source§

fn take_focus(&mut self, _: Direction) -> Result<EventResult, CannotFocus>

Attempt to give this view the focus. Read more
Source§

fn required_size(&mut self, _: XY<usize>) -> XY<usize>

Returns the minimum size the view requires with the given restrictions. Read more
Source§

fn important_area(&self, size: XY<usize>) -> Rect

What part of the view is important and should be visible? Read more
Source§

fn layout(&mut self, _: XY<usize>)

Called once the size for this view has been decided. Read more
Source§

fn needs_relayout(&self) -> bool

Should return true if the view content changed since the last call to layout(). Read more
Source§

fn call_on_any( &mut self, _: &Selector<'_>, _: &mut dyn FnMut(&mut (dyn View + 'static)), )

Runs a closure on the view identified by the given selector. Read more
Source§

fn focus_view(&mut self, _: &Selector<'_>) -> Result<EventResult, ViewNotFound>

Moves the focus to the view identified by the given selector. Read more
Source§

fn type_name(&self) -> &'static str

Returns the type of this view. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> AnyView for T
where T: View,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Downcast self to a Any.

Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Downcast self to a mutable Any.

Source§

fn as_boxed_any(self: Box<T>) -> Box<dyn Any>

Returns a boxed any from a boxed self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Finder for T
where T: View,

Source§

fn call_on_all<V, F>(&mut self, sel: &Selector<'_>, callback: F)
where V: View, F: FnMut(&mut V),

Runs a callback on all views identified by sel. Read more
Source§

fn call_on<V, F, R>(&mut self, sel: &Selector<'_>, callback: F) -> Option<R>
where V: View, F: FnOnce(&mut V) -> R,

Runs a callback on the view identified by sel. Read more
Source§

fn call_on_name<V, F, R>(&mut self, name: &str, callback: F) -> Option<R>
where V: View, F: FnOnce(&mut V) -> R,

Convenient method to use call_on with a view::Selector::Name.
Source§

fn find_name<V>(&mut self, name: &str) -> Option<ViewRef<V>>
where V: View,

Convenient method to find a view wrapped in an NamedView.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoBoxedView for T
where T: View,

Source§

fn into_boxed_view(self) -> Box<dyn View>

Returns a Box<View>.
Source§

impl<T> Nameable for T
where T: View,

Source§

fn with_name<S>(self, name: S) -> NamedView<Self>
where S: Into<String>,

Wraps this view into an NamedView with the given id. Read more
Source§

impl<T> Resizable for T
where T: View,

Source§

fn resized( self, width: SizeConstraint, height: SizeConstraint, ) -> ResizedView<Self>

Wraps self in a ResizedView with the given size constraints.
Source§

fn fixed_size<S>(self, size: S) -> ResizedView<Self>
where S: Into<XY<usize>>,

Wraps self into a fixed-size ResizedView.
Source§

fn fixed_width(self, width: usize) -> ResizedView<Self>

Wraps self into a fixed-width ResizedView.
Source§

fn fixed_height(self, height: usize) -> ResizedView<Self>

Wraps self into a fixed-width ResizedView.
Source§

fn full_screen(self) -> ResizedView<Self>

Wraps self into a full-screen ResizedView.
Source§

fn full_width(self) -> ResizedView<Self>

Wraps self into a full-width ResizedView.
Source§

fn full_height(self) -> ResizedView<Self>

Wraps self into a full-height ResizedView.
Source§

fn max_size<S>(self, size: S) -> ResizedView<Self>
where S: Into<XY<usize>>,

Wraps self into a limited-size ResizedView.
Source§

fn max_width(self, max_width: usize) -> ResizedView<Self>

Wraps self into a limited-width ResizedView.
Source§

fn max_height(self, max_height: usize) -> ResizedView<Self>

Wraps self into a limited-height ResizedView.
Source§

fn min_size<S>(self, size: S) -> ResizedView<Self>
where S: Into<XY<usize>>,

Wraps self into a ResizedView at least sized size.
Source§

fn min_width(self, min_width: usize) -> ResizedView<Self>

Wraps self in a ResizedView at least min_width wide.
Source§

fn min_height(self, min_height: usize) -> ResizedView<Self>

Wraps self in a ResizedView at least min_height tall.
Source§

impl<T> Scrollable for T
where T: View,

Source§

fn scrollable(self) -> ScrollView<Self>

Wraps self in a ScrollView.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> With for T

Source§

fn wrap_with<U, F>(self, f: F) -> U
where F: FnOnce(Self) -> U,

Calls the given closure and return the result. Read more
Source§

fn with<F>(self, f: F) -> Self
where F: FnOnce(&mut Self),

Calls the given closure on self.
Source§

fn try_with<E, F>(self, f: F) -> Result<Self, E>
where F: FnOnce(&mut Self) -> Result<(), E>,

Calls the given closure on self.
Source§

fn with_if<F>(self, condition: bool, f: F) -> Self
where F: FnOnce(&mut Self),

Calls the given closure if condition == true.