Struct PopupMenu

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

Popup menu.

Implementations

impl<'a> PopupMenu<'a>

pub fn new() -> Self

New, empty.

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

Add an item.

pub fn item_parsed(self, text: &'a str) -> Self

Parse the text.

See

MenuItem::new_parsed

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

Add a text-item.

pub fn item_string(self, txt: String) -> Self

Add an owned text as item.

pub fn separator(self, separator: Separator) -> Self

Sets the separator for the last item added. If there is none adds this as an empty menu-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 width_opt(self, width: Option<u16>) -> Self

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

pub fn constraint(self, placement: PopupConstraint) -> Self

Set relative placement.

pub fn offset(self, offset: (i16, i16)) -> Self

Adds an extra offset.

pub fn x_offset(self, offset: i16) -> Self

Adds an extra x offset.

pub fn y_offset(self, offset: i16) -> Self

Adds an extra y offset.

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

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

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

Set a style-set.

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

Base style.

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

Highlight style.

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

Highlight style.

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

Disabled item style.

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

Disabled item style.

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

Style for the hotkey.

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

Style for the hotkey.

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

Focus/Selection style.

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

Focus/Selection style.

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

Block for borders.

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

Block for borders.

pub fn get_block_size(&self) -> Size

Get the padding the block imposes as a Size.

pub fn get_block_padding(&self) -> Padding

Get the padding the block imposes as a Size.

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 StatefulWidget for PopupMenu<'_>

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.