Struct PopupMenu 

pub struct PopupMenu { /* private fields */ }

Implementations

impl PopupMenu

pub fn build( window: &mut Window, cx: &mut App, f: impl FnOnce(Self, &mut Window, &mut Context<'_, PopupMenu>) -> Self, ) -> Entity<Self>

pub fn action_context(self, handle: FocusHandle) -> Self

Set the focus handle of Entity to handle actions.

When the menu is dismissed or before an action is triggered, the focus will be returned to this handle.

Then the action will be dispatched to this handle.

pub fn min_w(self, width: impl Into<Pixels>) -> Self

Set min width of the popup menu, default is 120px

pub fn max_w(self, width: impl Into<Pixels>) -> Self

Set max width of the popup menu, default is 500px

pub fn max_h(self, height: impl Into<Pixels>) -> Self

Set max height of the popup menu, default is half of the window height

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

Set the menu to be scrollable to show vertical scrollbar.

NOTE: If this is true, the sub-menus will cannot be support.

pub fn external_link_icon(self, visible: bool) -> Self

Set the menu to show external link icon, default is true.

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

Add Menu Item

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

Add Menu Item with enable state

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

Add Menu Item with disabled state

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

Add label

pub fn link( self, label: impl Into<SharedString>, href: impl Into<String>, ) -> Self

Add Menu to open link

pub fn link_with_disabled( self, label: impl Into<SharedString>, href: impl Into<String>, disabled: bool, ) -> Self

Add Menu to open link with disabled state

pub fn link_with_icon( self, label: impl Into<SharedString>, icon: impl Into<Icon>, href: impl Into<String>, ) -> Self

Add Menu to open link

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

Add Menu Item with Icon.

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

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

Add Menu Item with check icon

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

Add Menu Item with check icon and disabled state

pub fn menu_element<F, E>(self, action: Box<dyn Action>, builder: F) -> Self

where F: Fn(&mut Window, &mut App) -> E + 'static, E: IntoElement,

Add Menu Item with custom element render.

pub fn menu_element_with_disabled<F, E>( self, action: Box<dyn Action>, disabled: bool, builder: F, ) -> Self

where F: Fn(&mut Window, &mut App) -> E + 'static, E: IntoElement,

Add Menu Item with custom element render with disabled state.

pub fn menu_element_with_icon<F, E>( self, icon: impl Into<Icon>, action: Box<dyn Action>, builder: F, ) -> Self

where F: Fn(&mut Window, &mut App) -> E + 'static, E: IntoElement,

Add Menu Item with custom element render with icon.

pub fn menu_element_with_check<F, E>( self, checked: bool, action: Box<dyn Action>, builder: F, ) -> Self

where F: Fn(&mut Window, &mut App) -> E + 'static, E: IntoElement,

Add Menu Item with custom element render with check state

pub fn separator(self) -> Self

Add a separator Menu Item

pub fn submenu( self, label: impl Into<SharedString>, window: &mut Window, cx: &mut Context<'_, Self>, f: impl Fn(PopupMenu, &mut Window, &mut Context<'_, PopupMenu>) -> PopupMenu + 'static, ) -> Self

Add a Submenu

pub fn submenu_with_icon( self, icon: Option<Icon>, label: impl Into<SharedString>, window: &mut Window, cx: &mut Context<'_, Self>, f: impl Fn(PopupMenu, &mut Window, &mut Context<'_, PopupMenu>) -> PopupMenu + 'static, ) -> Self

Add a Submenu item with icon

pub fn item(self, item: impl Into<PopupMenuItem>) -> Self

Add menu item.

pub fn is_empty(&self) -> bool

Trait Implementations

impl FluentBuilder for PopupMenu

fn map<U>(self, f: impl FnOnce(Self) -> U) -> U

where Self: Sized,

Imperatively modify self with the given closure.

fn when(self, condition: bool, then: impl FnOnce(Self) -> Self) -> Self

where Self: Sized,

Conditionally modify self with the given closure.

fn when_else( self, condition: bool, then: impl FnOnce(Self) -> Self, else_fn: impl FnOnce(Self) -> Self, ) -> Self

where Self: Sized,

Conditionally modify self with the given closure.

fn when_some<T>( self, option: Option<T>, then: impl FnOnce(Self, T) -> Self, ) -> Self

where Self: Sized,

Conditionally unwrap and modify self with the given closure, if the given option is Some.

fn when_none<T>( self, option: &Option<T>, then: impl FnOnce(Self) -> Self, ) -> Self

where Self: Sized,

Conditionally unwrap and modify self with the given closure, if the given option is None.

impl Focusable for PopupMenu

fn focus_handle(&self, _: &App) -> FocusHandle

Returns the focus handle associated with this view.

impl Render for PopupMenu

fn render( &mut self, window: &mut Window, cx: &mut Context<'_, Self>, ) -> impl IntoElement

Render this view into an element tree.

impl EventEmitter<DismissEvent> for PopupMenu