Skip to main content

ContextMenuState

Struct ContextMenuState 

Source
pub struct ContextMenuState {
    pub is_open: bool,
    pub anchor_position: (u16, u16),
    pub highlighted_index: usize,
    pub scroll_offset: u16,
    pub active_submenu: Option<usize>,
    pub submenu_state: Option<Box<ContextMenuState>>,
}
Expand description

State for a context menu.

Fields§

§is_open: bool

Whether the menu is currently open.

§anchor_position: (u16, u16)

Anchor position (x, y) where menu appears.

§highlighted_index: usize

Currently highlighted item index.

§scroll_offset: u16

Scroll offset for long menus.

§active_submenu: Option<usize>

Index of active submenu (if any).

§submenu_state: Option<Box<ContextMenuState>>

State for active submenu (boxed to avoid infinite size).

Implementations§

Source§

impl ContextMenuState

Source

pub fn new() -> Self

Create a new context menu state.

Source

pub fn open_at(&mut self, x: u16, y: u16)

Open the menu at the specified position.

Source

pub fn close(&mut self)

Close the menu.

Source

pub fn highlight_prev(&mut self, items: &[ContextMenuItem])

Move highlight to previous selectable item.

Source

pub fn highlight_next(&mut self, items: &[ContextMenuItem])

Move highlight to next selectable item.

Source

pub fn highlight_first(&mut self, items: &[ContextMenuItem])

Move to first selectable item.

Source

pub fn highlight_last(&mut self, items: &[ContextMenuItem])

Move to last selectable item.

Source

pub fn open_submenu(&mut self)

Open submenu at the highlighted index.

Source

pub fn close_submenu(&mut self)

Close any open submenu.

Source

pub fn has_open_submenu(&self) -> bool

Check if a submenu is open.

Source

pub fn ensure_visible(&mut self, viewport_height: usize)

Ensure highlighted item is visible in viewport.

Trait Implementations§

Source§

impl Clone for ContextMenuState

Source§

fn clone(&self) -> ContextMenuState

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ContextMenuState

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ContextMenuState

Source§

fn default() -> Self

Returns the “default value” for a type. 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 = 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.