Struct ContextMenu 

pub struct ContextMenu { /* private fields */ }

Global context menu state.

Requires a ContextMenuViewer in an ancestor scope.

Example

fn app() -> impl IntoElement {
    rect().child(ContextMenuViewer::new()).child(
        rect()
            .on_secondary_down(move |_| {
                ContextMenu::open_from_down(
                    Menu::new().child(MenuButton::new().child("Option 1")),
                );
            })
            .child("Right click to open menu"),
    )
}

Implementations

impl ContextMenu

pub fn is_open() -> bool

Returns whether the context menu is open, or false if no viewer is mounted.

Example

fn app() -> impl IntoElement {
    rect()
        .child(ContextMenuViewer::new())
        .child(if ContextMenu::is_open() {
            "Menu open"
        } else {
            "Menu closed"
        })
}

pub fn open(menu: Menu)

Open the context menu, from a press event or programmatically.

Example

fn app() -> impl IntoElement {
    rect()
        .child(ContextMenuViewer::new())
        .child(Button::new().child("Open menu").on_press(|_| {
            ContextMenu::open(Menu::new().child(MenuButton::new().child("Copy")));
        }))
}

pub fn open_from_down(menu: Menu)

Open the context menu from a pointer down event, like on_secondary_down.

Example

fn app() -> impl IntoElement {
    rect().child(ContextMenuViewer::new()).child(
        rect().child("Right click here").on_secondary_down(|_| {
            ContextMenu::open_from_down(Menu::new().child(MenuButton::new().child("Copy")));
        }),
    )
}

pub fn close()

Closes the context menu, doing nothing if no viewer is mounted.

Example

fn app() -> impl IntoElement {
    rect().child(ContextMenuViewer::new()).child(
        Button::new()
            .child("Close menu")
            .on_press(|_| ContextMenu::close()),
    )
}

Trait Implementations

impl Clone for ContextMenu

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ContextMenu

impl PartialEq for ContextMenu

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ContextMenu