Struct StringMenuItem 

#[repr(C)]
pub struct StringMenuItem {
    pub label: AzString,
    pub accelerator: OptionVirtualKeyCodeCombo,
    pub callback: OptionCoreMenuCallback,
    pub menu_item_state: MenuItemState,
    pub icon: OptionMenuItemIcon,
    pub children: MenuItemVec,
}

A menu item with a text label and optional features.

StringMenuItem represents a clickable menu entry that can have:

• A text label
• An optional keyboard accelerator (e.g., Ctrl+C)
• An optional callback function
• An optional icon (checkbox or image)
• A state (normal, greyed, or disabled)
• Child menu items (for sub-menus)

Fields

label: AzString

Label of the menu (ex. “File”, “Edit”, “View”)

accelerator: OptionVirtualKeyCodeCombo

Optional accelerator combination (ex. “CTRL + X” = [VirtualKeyCode::Ctrl, VirtualKeyCode::X]) for keyboard shortcut

callback: OptionCoreMenuCallback

Optional callback to call

menu_item_state: MenuItemState

State (normal, greyed, disabled)

icon: OptionMenuItemIcon

Optional icon for the menu entry

children: MenuItemVec

Sub-menus of this item (separators and line-breaks can’t have sub-menus)

Implementations

impl StringMenuItem

pub const fn create(label: AzString) -> Self

Creates a new menu item with the given label and default values.

Default values:

• No accelerator
• No callback
• Normal state
• No icon
• No children

pub fn swap_with_default(&mut self) -> Self

Swaps this menu item with a default item and returns the previous contents.

This is useful for taking ownership without cloning.

pub fn with_children(self, children: MenuItemVec) -> Self

Sets the child menu items for this item, creating a sub-menu.

pub fn with_child(self, child: MenuItem) -> Self

Adds a single child menu item to this item.

pub fn with_callback<I: Into<CoreCallback>>( self, data: RefAny, callback: I, ) -> Self

Attaches a callback function to this menu item.

Parameters

• data - User data passed to the callback
• callback - Function pointer (as usize) to invoke when item is clicked

Note

This uses CoreCallbackType (usize) instead of a real function pointer to avoid circular dependencies. The conversion happens in azul-layout.

Trait Implementations

impl Clone for StringMenuItem

fn clone(&self) -> StringMenuItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StringMenuItem

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

Formats the value using the given formatter.

impl Hash for StringMenuItem

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for StringMenuItem

fn cmp(&self, other: &StringMenuItem) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for StringMenuItem

fn eq(&self, other: &StringMenuItem) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for StringMenuItem

fn partial_cmp(&self, other: &StringMenuItem) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for StringMenuItem

impl StructuralPartialEq for StringMenuItem