Struct NativeMenu 

pub struct NativeMenu { /* private fields */ }

A menu rendered by the operating system.

Build it with the NativeMenu::menu / NativeMenu::separator builders, then call NativeMenu::show to display it at a position.

Implementations

impl NativeMenu

pub fn new() -> Self

Create an empty native menu.

pub fn menu( self, label: impl Into<SharedString>, action: Box<dyn Action>, ) -> Self

Append a clickable item that dispatches action when selected.

pub fn menu_with_disabled( self, label: impl Into<SharedString>, disabled: bool, action: Box<dyn Action>, ) -> Self

Append an item, controlling its disabled state.

pub fn menu_with_check( self, label: impl Into<SharedString>, checked: bool, action: Box<dyn Action>, ) -> Self

Append an item, controlling its checked state (a check mark is shown).

pub fn menu_with_icon( self, label: impl Into<SharedString>, icon: impl Into<Icon>, action: Box<dyn Action>, ) -> Self

Append an item showing icon next to its label.

Native platform menus load absolute paths ([Path::is_absolute]) from the filesystem, and every other path through the application gpui::AssetSource. crate::IconName resolves as an asset and works across all backends.

• macOS: loaded into an NSImage as a template image, so it tints with the item text and assigned to the item ([NSMenuItem::image]).
• Windows: loaded into an HBITMAP and set as the item’s content bitmap (MENUITEMINFOW::hbmpItem), shown beside the label. SVG files are rasterized, with resvg; other formats (PNG, JPEG, BMP, …) are decoded by GDI+. Other platforms (fallback): rendered as the menu item’s crate::Icon.

Note: this is the menu item’s content icon, not its state/check-mark indicator.

pub fn menu_with_icon_disabled( self, label: impl Into<SharedString>, icon: impl Into<Icon>, disabled: bool, action: Box<dyn Action>, ) -> Self

Append an item showing icon next to its label, controlling its disabled state.

Same icon behavior as Self::menu_with_icon. Use this when an item carries an icon but should be greyed out.

pub fn menu_with_icon_and_disabled( self, label: impl Into<SharedString>, icon: impl Into<Icon>, action: Box<dyn Action>, disabled: bool, ) -> Self

Add Menu Item with Icon and disabled state.

Alias for Self::menu_with_icon_disabled, matching crate::menu::PopupMenu.

pub fn separator(self) -> Self

Append a separator line.

pub fn submenu( self, label: impl Into<SharedString>, submenu: NativeMenu, ) -> Self

Append a submenu built from another NativeMenu.

pub fn is_empty(&self) -> bool

Whether the menu has no items.

pub fn show(self, position: Point<Pixels>, window: &mut Window, cx: &mut App)

Pop up the menu at position (window coordinates, in logical pixels).

The menu is shown without blocking the caller: the OS tracking loop runs off GPUI’s call stack, so GPUI is not borrowed while it is open. When an item is selected, its action is dispatched via Window::dispatch_action.

Trait Implementations

impl Default for NativeMenu

fn default() -> NativeMenu

Returns the “default value” for a type.

impl From<Menu> for NativeMenu

Reuse an existing GPUI menu definition as a native menu.

Actions, separators, submenus, checked, and disabled are mapped over; system menus (e.g. macOS Services) have no native popup equivalent and are skipped.

fn from(menu: Menu) -> Self

Converts to this type from the input type.