Struct rat_widget::popup_menu::PopupMenu

pub struct PopupMenu<'a> { /* private fields */ }

Popup menu.

Implementations

impl<'a> PopupMenu<'a>

pub fn new() -> Self

New, empty.

pub fn add(self, item: Line<'a>, navchar: Option<char>) -> Self

Add a formatted item. The navchar is optional, any markup for it is your problem.

pub fn add_ext( self, item: Line<'a>, navchar: Option<char>, item_right: Line<'a>, ) -> Self

Add a formatted item. The navchar is optional, any markup for it is your problem.

pub fn add_sep(self, ty: Separator) -> Self

Add a separator item. This is added to the item before, so it is not possible to start the menu with a separator, or to add more than one separator.

pub fn add_str(self, txt: &'a str) -> Self

Add a text-item. The first underscore is used to denote the navchar.

pub fn add_item(self, item: MenuItem<'a>) -> Self

Add an item.

pub fn width(self, width: u16) -> Self

Fixed width for the menu. If not set it uses 1.5 times the length of the longest item.

pub fn placement(self, placement: Placement) -> Self

Placement relative to the render-area.

pub fn boundary(self, boundary: Rect) -> Self

Set outer bounds for the popup-menu. If not used, the buffer-area is used as outer bounds.

pub fn styles(self, styles: MenuStyle) -> Self

Take a style-set.

pub fn style(self, style: Style) -> Self

Base style.

pub fn focus_style(self, style: Style) -> Self

Focus/Selection style.

pub fn block(self, block: Block<'a>) -> Self

Block for borders.

Trait Implementations

impl<'a> Clone for PopupMenu<'a>

fn clone(&self) -> PopupMenu<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for PopupMenu<'a>

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

Formats the value using the given formatter.

impl<'a> Default for PopupMenu<'a>

fn default() -> PopupMenu<'a>

Returns the “default value” for a type.

impl<'a> StatefulWidget for PopupMenu<'a>

type State = PopupMenuState

State associated with the stateful widget.

fn render(self, area: Rect, buf: &mut Buffer, state: &mut Self::State)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom stateful widget.