Skip to main content

ActionMenu

Struct ActionMenu 

Source
pub struct ActionMenu { /* private fields */ }
Expand description

The action menu: a stack of pages, a query per page, and the last-drawn window offset so pointer hit-testing agrees with what was rendered.

Implementations§

Source§

impl ActionMenu

Source

pub fn new(items: Vec<ActionMenuItem>) -> Self

Source

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

Source

pub fn query(&self) -> &str

Source

pub fn is_fuzzy(&self) -> bool

Source

pub fn visible_len(&self) -> usize

Source

pub fn selected_position(&self) -> usize

The cursor’s position in the filtered list.

Source

pub fn selected_item(&self) -> Option<&ActionMenuItem>

Source

pub fn item(&self, index: usize) -> Option<&ActionMenuItem>

Source

pub fn push(&mut self, title: impl Into<String>, items: Vec<ActionMenuItem>)

Push a submenu. Its own query starts empty, so the parent filter does not silently hide rows in a list the reader has not seen yet.

Source

pub fn pop(&mut self) -> bool

Return to the parent page. false when this is already the root.

Source

pub fn title(&self) -> &str

Source

pub fn handle_key(&mut self, key: KeyEvent) -> MenuEvent

Source

pub fn bounds(&self, area: Rect) -> Rect

The popup rect for area, size clamped to the content and the area.

Source

pub fn rows(&self) -> Vec<Row>

The row list, shared by the renderer and the pointer handler.

Source

pub fn window_offset(&self) -> usize

Source

pub fn hit(&self, area: Rect, x: u16, y: u16) -> Option<usize>

The item under a terminal cell, if the cell is an item row.

Source

pub fn render(&self, f: &mut Frame<'_>, area: Rect)

Render the current page, keeping the selected item inside the window.

Trait Implementations§

Source§

impl Clone for ActionMenu

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ActionMenu

Source§

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

Formats the value using the given formatter. 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> 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.