Struct egui::menu::MenuState

pub struct MenuState {
    sub_menu: Option<(Id, Arc<RwLock<MenuState>>)>,
    pub rect: Rect,
    pub response: MenuResponse,
    entry_count: usize,
}

Components of menu state, public for advanced usage.

Usually you don’t need to use it directly.

Fields

sub_menu: Option<(Id, Arc<RwLock<MenuState>>)>

The opened sub-menu and its Id

rect: Rect

Bounding box of this menu (without the sub-menu), including the frame and everything.

response: MenuResponse

Used to check if any menu in the tree wants to close

entry_count: usize

Used to hash different Ids for sub-menus

Implementations

impl MenuState

pub fn new(position: Pos2) -> Self

pub fn close(&mut self)

Close menu hierarchy.

fn show_submenu<R>( &mut self, ctx: &Context, parent_layer: LayerId, id: Id, add_contents: impl FnOnce(&mut Ui) -> R ) -> Option<R>

pub fn area_contains(&self, pos: Pos2) -> bool

Check if position is in the menu hierarchy’s area.

fn next_entry_index(&mut self) -> usize

fn submenu_button_interaction(&mut self, ui: &Ui, sub_id: Id, button: &Response)

Sense button interaction opening and closing submenu.

fn moving_towards_current_submenu(&self, pointer: &PointerState) -> bool

Check if pointer is moving towards current submenu.

fn hovering_current_submenu(&self, pointer: &PointerState) -> bool

Check if pointer is hovering current submenu.

fn cascade_close_response(&mut self, response: MenuResponse)

Cascade close response to menu root.

fn is_open(&self, id: Id) -> bool

fn sub_id(&self) -> Option<Id>

fn current_submenu(&self) -> Option<&Arc<RwLock<Self>>>

fn submenu(&mut self, id: Id) -> Option<&Arc<RwLock<Self>>>

fn open_submenu(&mut self, id: Id, pos: Pos2)

Open submenu at position, if not already open.

fn close_submenu(&mut self)