PopupMenu

gpui_component::popup_menu

Struct PopupMenu 

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

Implementations§

Source§

impl PopupMenu

Source

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

Source

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

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

Source

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

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

Source

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

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

Source

pub fn scrollable(self) -> Self

Set the menu to be scrollable to show vertical scrollbar.

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

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

Source

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

Add Menu Item

Source

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

Add Menu Item with enable state

Source

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

Add Menu Item with disabled state

Source

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

Add label

Add Menu to open link

Add Menu to open link with disabled state

Add Menu to open link

Add Menu to open link with icon and disabled state

Source

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

Add Menu Item with Icon.

Source

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

Source

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

Add Menu Item with check icon

Source

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

Source

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.

Source

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.

Source

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.

Source

pub fn menu_element_with_icon_and_disabled<F, E>( self, icon: impl Into<Icon>, 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 icon and disabled state

Source

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

Source

pub fn menu_element_with_check_and_disabled<F, E>( self, checked: bool, 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 check state and disabled state

Source

pub fn separator(self) -> Self

Add a separator Menu Item

Source

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

Source

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

Add a Submenu item with disabled state

Source

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

Source

pub fn submenu_with_icon_with_disabled( self, icon: Option<Icon>, label: impl Into<SharedString>, disabled: bool, 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 and disabled state

Source

pub fn is_empty(&self) -> bool

Trait Implementations§

Source§

impl FluentBuilder for PopupMenu

Source§

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

Imperatively modify self with the given closure.
Source§

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

Conditionally modify self with the given closure.
Source§

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.
Source§

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.
Source§

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.
Source§

impl Focusable for PopupMenu

Source§

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

Returns the focus handle associated with this view.
Source§

impl Render for PopupMenu

Source§

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

Render this view into an element tree.
Source§

impl EventEmitter<DismissEvent> for PopupMenu

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<M> ManagedView for M
where M: Focusable + EventEmitter<DismissEvent> + Render,