Enum PopupIntent

#[non_exhaustive]
pub enum PopupIntent {
    Present {
        popup_id: PopupId,
    },
    MoveFocusInto {
        popup_id: PopupId,
        trap: bool,
    },
    Dismiss {
        popup_id: PopupId,
        reason: PopupDismissReason,
    },
    RestoreFocus {
        owner: PopupOwner,
    },
}

Host-independent side effect emitted by PopupPortal.

Intents are ordered: presentation precedes focus movement on open; subtree dismissals precede optional owner focus restoration on close. The enum is non-exhaustive.

Examples

use ailloli_ui_runtime::popup::{PopupId, PopupIntent};
assert!(matches!(PopupIntent::Present { popup_id: PopupId::new(1) }, PopupIntent::Present { .. }));

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Present

Ask the selected backend to present or raise a popup.

Fields

popup_id: PopupId

Stable registration ID.

MoveFocusInto

Ask input routing to focus the first retained popup descendant.

Fields

popup_id: PopupId

Popup whose mounted subtree should receive focus.

trap: bool

Whether subsequent focus cycling should remain inside the subtree.

Dismiss

Ask a backend to hide a popup for the recorded reason.

Fields

popup_id: PopupId

Stable registration ID.

reason: PopupDismissReason

Lifecycle/input reason for dismissal.

RestoreFocus

Restore focus only if the host can still resolve this complete owner.

Fields

owner: PopupOwner

Exact owner that should regain focus if it is still live/current.

Trait Implementations

impl Clone for PopupIntent

fn clone(&self) -> PopupIntent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PopupIntent

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

Formats the value using the given formatter.

impl PartialEq for PopupIntent

fn eq(&self, other: &PopupIntent) -> 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 Eq for PopupIntent

impl StructuralPartialEq for PopupIntent