Struct Menu

pub struct Menu<T, Handler = MenuHandler<T>> { /* private fields */ }

An overlayable menu of selectable items.

This widget is designed to implement Cushy’s contextual menu system. When used with an OverlayLayer, this widget can be shown above other widgets or at a specific location.

Implementations

impl<T> Menu<T, ()>

where T: Debug + Send + Clone + 'static,

pub const fn new() -> Self

Returns a new, empty menu.

pub fn on_selected<F>(self, selected: F) -> Menu<T>

where F: FnMut(T) + Send + 'static,

Sets the selected handler to selected, causing it to be invoked when an item is chosen.

impl<T, Handler> Menu<T, Handler>

where T: Debug + Send + Clone + 'static,

pub fn with(self, item: impl Into<MenuItem<T>>) -> Self

Adds another menu item that is displayed using widget.

pub fn with_separator(self) -> Self

Adds a separator after the last item and returns self.

impl<T> Menu<T>

where T: Debug + Send + Clone + 'static,

pub fn overlay_in<'overlay>( &self, overlay: &'overlay OverlayLayer, ) -> MenuOverlay<'overlay>

Presents this menu in overlay, returning an Overlayable that can be positioned relative or absolutely within overlay.

Trait Implementations

impl<T: Clone, Handler: Clone> Clone for Menu<T, Handler>

fn clone(&self) -> Menu<T, Handler>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, Handler: Debug> Debug for Menu<T, Handler>

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

Formats the value using the given formatter.

impl<T> Default for Menu<T, ()>

where T: Debug + Send + Clone + 'static,

fn default() -> Self

Returns the “default value” for a type.