Skip to main content

ContextMenu

Struct ContextMenu 

Source
pub struct ContextMenu { /* private fields */ }

Implementations§

Source§

impl ContextMenu

Source

pub fn new<W>(name: impl Into<String>, trigger: W) -> Self
where W: Widget + 'static,

Source

pub fn theme(self, theme: DefaultTheme) -> Self

Source

pub fn theme_when<F>(self, theme: F) -> Self
where F: Fn() -> DefaultTheme + 'static,

Source

pub fn handle(self, handle: ContextMenuHandle) -> Self

Let handle open this menu from code; see ContextMenuHandle.

Source

pub fn item(self, item: MenuItem) -> Self

Source

pub fn items<I>(self, items: I) -> Self
where I: IntoIterator<Item = MenuItem>,

Source

pub fn items_when<F>(self, provider: F) -> Self
where F: Fn() -> Vec<MenuItem> + 'static,

Rebuild the item list every time the menu opens, so per-item enabled state can reflect current application state (selection, clipboard, …).

Source

pub fn trigger_id(&self) -> WidgetId

Widget id of the wrapped trigger. Menu activations can route commands back to it via EventCtx::post_event — for example the standard text editing commands (TextCommand) understood by the text widgets.

Source

pub fn on_activate<F>(self, on_activate: F) -> Self
where F: FnMut(usize, MenuItem) + 'static,

Handle leaf activation.

Flat menus receive the activated item index as before. A nested leaf receives the index of its root submenu owner; use Self::on_activate_path when the complete path is significant.

Source

pub fn on_activate_with_ctx<F>(self, on_activate: F) -> Self
where F: FnMut(&mut EventCtx, usize, MenuItem) + 'static,

Event-context variant of Self::on_activate.

Source

pub fn on_activate_path<F>(self, on_activate: F) -> Self
where F: FnMut(Vec<usize>, MenuItem) + 'static,

Handle leaf activation with the complete index path from the root item to the activated nested item.

Source

pub fn on_activate_path_with_ctx<F>(self, on_activate: F) -> Self
where F: FnMut(&mut EventCtx, Vec<usize>, MenuItem) + 'static,

Handle leaf activation with event context and its complete nested index path.

Source

pub fn activation_button(self, activation_button: PointerButton) -> Self

Set the pointer button that opens the menu.

Primary activation owns the trigger click during capture, so an interactive trigger such as crate::Button does not consume or also execute the click. Secondary activation remains in target/bubble order so context-menu triggers can update their targeted row before opening.

Source

pub fn anchor_to_pointer(self, anchor_to_pointer: bool) -> Self

Whether the menu opens at the press position instead of dropping below the trigger. Defaults by activation button: right-click menus anchor to the pointer (standard context-menu behavior, and the only sensible placement for large triggers), other buttons keep the dropdown layout.

Source

pub fn show_inline(self) -> Self

Keeps the menu open and lays its panels out in flow beneath the trigger, as part of this widget’s own size, instead of floating in the window overlay stack. The menu ignores dismissal but stays interactive. Widget galleries and documentation use this to show an open menu beside other content; see also Self::highlighted_path.

Source

pub fn highlighted_path(self, path: impl IntoIterator<Item = usize>) -> Self

Highlights the item at path (indices from the root menu) and opens the submenus leading to it, or its own submenu when it has one. Call after adding items; useful with Self::show_inline.

Trait Implementations§

Source§

impl Widget for ContextMenu

Source§

fn command(&mut self, ctx: &mut EventCtx, command: &Command<'_>)

Receive a typed command addressed directly to this widget. Commands are target-only and do not capture or bubble through the widget tree.
Source§

fn event(&mut self, ctx: &mut EventCtx, event: &Event)

Source§

fn measure_size( &mut self, ctx: &mut MeasureCtx, constraints: Constraints, ) -> Size

Compute a provisional size. Containers can override this to query child sizes without committing their final layouts. The default preserves existing custom widgets by delegating to measure; it may mutate state. Child measure calls still commit state. Use child size probes explicitly when only their scalar results are needed. Results must match measure for the same content and constraints. A final measure is still required before arrangement after a probe miss.
Source§

fn measure(&mut self, ctx: &mut MeasureCtx, constraints: Constraints) -> Size

Source§

fn arrange(&mut self, ctx: &mut ArrangeCtx, bounds: Rect)

Source§

fn paint(&self, ctx: &mut PaintCtx)

Source§

fn semantics(&self, ctx: &mut SemanticsCtx)

Source§

fn accepts_focus(&self) -> bool

Source§

fn overlay_options(&self) -> Option<OverlayOptions>

Describe this widget as the logical owner of a presented overlay. Read more
Source§

fn focus_changed(&mut self, ctx: &mut EventCtx, focused: bool)

Source§

fn visit_children(&self, visitor: &mut dyn WidgetPodVisitor)

Visit this widget’s logical children. Read more
Source§

fn visit_children_mut(&mut self, visitor: &mut dyn WidgetPodMutVisitor)

Mutably visit this widget’s logical children. Read more
Source§

fn debug_name(&self) -> &'static str

Source§

fn diagnostics(&self, _ctx: &mut WidgetDiagnosticsCtx)

Publish widget-specific state for an inspector snapshot. Read more
Source§

fn measure_axis( &mut self, ctx: &mut MeasureCtx, constraints: Constraints, axis: Axis, ) -> f32

Query one component of measure_size under exactly the same constraints. Overrides may avoid computing the other component, but must return the same extent. Like size probes, this does not replace final measurement.
Source§

fn intrinsic_size( &mut self, ctx: &mut MeasureCtx, axis: Axis, available_cross: f32, ) -> IntrinsicSize

Report the smallest and preferred extent along one axis. Read more
Source§

fn supports_output_reuse(&self) -> bool

Opt into retaining paint and semantics between targeted invalidations. Output must depend only on widget state, context, and observed sources; changes must invalidate the widget. Untracked readers and callbacks with side effects should keep the default. An opaque descendant also prevents caching its ancestors. Explicit subtree/window requests always rerun them. A source observed only in paint or semantics invalidates that callback, not its descendants. Mutating child state requires a child/subtree request.
Source§

fn layer_options(&self) -> LayerOptions

Source§

fn layer_properties(&self) -> LayerProperties

Source§

fn layer_properties_at(&self, frame_time: f64) -> LayerProperties

Layer properties for the frame shown at frame_time. Override this instead of Widget::layer_properties when they come from Motion values; the runtime refreshes them without repainting when the motion invalidates Transform or Effect.
Source§

fn stack_host_options(&self) -> Option<StackHostOptions>

Source§

fn stack_surface_options(&self) -> Option<StackSurfaceOptions>

Source§

fn hit_test_self(&self) -> bool

Whether points inside this widget that none of its children take hit the widget itself. Containers laid over other content, like a layer of floating views, return false so those points reach what is behind them.

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