Struct Popup 

pub struct Popup {
    pub align: RectAlign,
    pub gap: f64,
    pub close_behavior: PopupCloseBehavior,
    /* private fields */
}

Controller for a single anchored popup surface.

Fields

align: RectAlign

gap: f64

close_behavior: PopupCloseBehavior

Implementations

impl Popup

pub fn new() -> Self

pub fn is_open(&self) -> bool

pub fn open(&mut self)

pub fn close(&mut self)

pub fn set_open(&mut self, open: bool)

pub fn toggle(&mut self) -> bool

Flip the open flag; returns the new state.

pub fn set_anchor(&mut self, anchor: Rect)

Record the anchor rect (the opener widget’s bounds, in the coordinate space the popup is placed and hit-tested in).

pub fn anchor(&self) -> Rect

pub fn set_size(&mut self, size: Size)

Record the measured content size used for placement.

pub fn effective_align(&self, viewport: Size) -> RectAlign

The placement actually used this frame: the configured align if the popup fits on-screen with it, otherwise the first of its RectAlign::symmetries (then RectAlign::MENU_ALIGNS) that does — egui’s overflow-flip (Popup::get_best_align in egui/src/containers/popup.rs).

pub fn rect(&self, viewport: Size) -> Rect

The placed popup rect: best-fit alignment first (overflow flip), then clamped to the viewport as the final fallback when even the best candidate overflows.

pub fn contains(&self, pos: Point, viewport: Size) -> bool

Whether pos falls inside the placed popup rect.

pub fn on_escape(&mut self) -> bool

Close on Escape, regardless of PopupCloseBehavior — egui closes any popup on Escape (popup.rs should_close), so even an IgnoreClicks popup stays keyboard-dismissable. Returns true if this call closed the popup (callers should consume the key event then).

pub fn on_mouse_down(&mut self, pos: Point, viewport: Size) -> PopupClickOutcome

Apply the close behavior to a left mouse-down at pos.

Returns the PopupClickOutcome so the host knows whether the popup closed and whether to consume the event. A no-op (returns all-false) when the popup is already closed.

Trait Implementations

impl Clone for Popup

fn clone(&self) -> Popup

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Popup

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

Formats the value using the given formatter.

impl Default for Popup

fn default() -> Self

Returns the “default value” for a type.