Skip to main content

ContextMenu

Struct ContextMenu 

Source
pub struct ContextMenu<Msg> { /* private fields */ }
Expand description

Wraps an area and opens a menu of ContextItems at the pointer on a right click, or next to the focused widget on Shift+F10 or the menu key.

The menu is a layer on the overlay surface that unfolds over motion.enter. Hovered and highlighted rows show the pillar and slide their label one cell while shortcuts stay at the right edge. ↑/↓ move (skipping gaps and disabled rows), Home/End jump, typing a letter jumps to the next row starting with it, → or Enter opens a submenu, ← or Esc closes it, Enter or Space chooses. Choosing sends the item’s message. A press anywhere outside the menu closes it and still reaches what it landed on; a right click inside the area reopens it there.

Style keys: see ContextItem.

use qframe::prelude::*;
use qframe::widgets::{ContextMenu, ContextItem};

struct Files { deleted: bool }

#[derive(Clone)]
enum Msg { Delete }

impl App for Files {
    type Msg = Msg;
    fn update(&mut self, Msg::Delete: Msg) -> Command<Msg> {
        self.deleted = true;
        Command::none()
    }
    fn view(&self, ui: &mut View<'_, Msg>) {
        let items = [ContextItem::new("Delete", Msg::Delete).danger(true)];
        ui.add_with(ContextMenu::new(items), |ui| {
            ui.add(Text::new("report.pdf"));
        });
    }
}

let mut app = Harness::new(Files { deleted: false }, 30, 5);
app.set_reduced_motion(true);
app.mouse(qframe::event::MouseKind::Down(qframe::event::MouseButton::Right), 2, 0);
app.press("down").press("enter");
assert!(app.app().deleted);

Implementations§

Source§

impl<Msg: Clone + 'static> ContextMenu<Msg>

Source

pub fn new(items: impl IntoIterator<Item = ContextItem<Msg>>) -> Self

A context menu of items over the widgets added with View::add_with.

Trait Implementations§

Source§

impl<Msg: Clone + 'static> Container<Msg> for ContextMenu<Msg>

Source§

fn set_children(&mut self, children: Vec<Node<Msg>>)

Receives the children built for this widget.
Source§

impl<Msg: Clone + 'static> Widget<Msg> for ContextMenu<Msg>

Source§

fn measure(&self, cx: &mut MeasureCx<'_>, available: Size) -> Size

The size the widget wants when it may use up to available.
Source§

fn paint(&self, cx: &mut PaintCx<'_>, area: Rect)

Draws the widget into area.
Source§

fn paint_overlay(&self, cx: &mut PaintCx<'_>, _area: Rect)

Draws the widget’s overlay after the whole view was painted, when it asked for one with PaintCx::request_overlay. anchor is the area the widget was painted in.
Source§

fn event(&self, cx: &mut EventCx<'_, Msg>, event: &Event) -> bool

Handles input. Returns true when the event was used; unused key and scroll events bubble to the parent widget.
Source§

fn children(&self) -> &[Node<Msg>]

Child nodes, for widgets that contain other widgets.
Source§

fn children_mut(&mut self) -> &mut [Node<Msg>]

Mutable child nodes, used to assign ids.
Source§

fn focusable(&self) -> bool

Whether the widget can take keyboard focus.

Auto Trait Implementations§

§

impl<Msg> !RefUnwindSafe for ContextMenu<Msg>

§

impl<Msg> !Send for ContextMenu<Msg>

§

impl<Msg> !Sync for ContextMenu<Msg>

§

impl<Msg> !UnwindSafe for ContextMenu<Msg>

§

impl<Msg> Freeze for ContextMenu<Msg>
where Vec<ContextItem<Msg>>: Freeze, Vec<Node<Msg>>: Freeze,

§

impl<Msg> Unpin for ContextMenu<Msg>
where Vec<ContextItem<Msg>>: Unpin, Vec<Node<Msg>>: Unpin,

§

impl<Msg> UnsafeUnpin for ContextMenu<Msg>

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> 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, 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.