Struct PopupSemantics

#[non_exhaustive]
pub struct PopupSemantics { /* private fields */ }

Provider-neutral interaction and accessibility contract for a popup.

Defaults describe an interactive generic popup: outside press/Escape close it, pointer input is consumed, and focus is restored on close, but opening does not move focus. Builder booleans mean exactly whether each behavior is requested; the portal does not infer a role-specific override.

Examples

use ailloli_ui_runtime::popup::PopupSemantics;
let semantics = PopupSemantics::new();
assert!(semantics.dismisses_on_escape() && semantics.consumes_pointer_input());

Implementations

impl PopupSemantics

Constructors, accessors, and immutable-style semantic builders.

pub const fn new() -> Self

Creates the interactive generic defaults.

Examples

use ailloli_ui_runtime::popup::{PopupFocusPolicy, PopupRole, PopupSemantics};
let value = PopupSemantics::new();
assert_eq!((value.role(), value.focus_policy()), (PopupRole::Generic, PopupFocusPolicy::None));
assert!(value.dismisses_on_outside_press() && value.dismisses_on_escape() && value.consumes_pointer_input() && value.restores_focus_on_close());

pub const fn role(&self) -> PopupRole

Returns the semantic category.

Examples

use ailloli_ui_runtime::popup::{PopupRole, PopupSemantics};
assert_eq!(PopupSemantics::new().with_role(PopupRole::Menu).role(), PopupRole::Menu);

pub const fn focus_policy(&self) -> PopupFocusPolicy

Returns requested focus behavior on open.

Examples

use ailloli_ui_runtime::popup::{PopupFocusPolicy, PopupSemantics};
assert_eq!(PopupSemantics::new().with_focus_policy(PopupFocusPolicy::MoveIntoPopup).focus_policy(), PopupFocusPolicy::MoveIntoPopup);

pub const fn dismisses_on_outside_press(&self) -> bool

Reports whether an outside press requests dismissal.

Examples

use ailloli_ui_runtime::popup::PopupSemantics;
assert!(!PopupSemantics::new().dismiss_on_outside_press(false).dismisses_on_outside_press());

pub const fn dismisses_on_escape(&self) -> bool

Reports whether Escape requests dismissal.

Examples

use ailloli_ui_runtime::popup::PopupSemantics;
assert!(!PopupSemantics::new().dismiss_on_escape(false).dismisses_on_escape());

pub const fn consumes_pointer_input(&self) -> bool

Reports whether routed pointer input is considered handled.

Examples

use ailloli_ui_runtime::popup::PopupSemantics;
assert!(!PopupSemantics::new().consume_pointer_input(false).consumes_pointer_input());

pub const fn restores_focus_on_close(&self) -> bool

Reports whether close emits owner focus restoration.

Examples

use ailloli_ui_runtime::popup::PopupSemantics;
assert!(!PopupSemantics::new().restore_focus_on_close(false).restores_focus_on_close());

pub const fn with_role(self, role: PopupRole) -> Self

Replaces the semantic category without changing other behavior.

Examples

use ailloli_ui_runtime::popup::{PopupRole, PopupSemantics};
assert_eq!(PopupSemantics::new().with_role(PopupRole::Listbox).role(), PopupRole::Listbox);

pub const fn with_focus_policy(self, focus_policy: PopupFocusPolicy) -> Self

Replaces focus-on-open behavior.

Examples

use ailloli_ui_runtime::popup::{PopupFocusPolicy, PopupSemantics};
assert_eq!(PopupSemantics::new().with_focus_policy(PopupFocusPolicy::TrapWithinPopup).focus_policy(), PopupFocusPolicy::TrapWithinPopup);

pub const fn dismiss_on_outside_press(self, dismiss: bool) -> Self

Sets outside-press dismissal exactly to dismiss.

Examples

use ailloli_ui_runtime::popup::PopupSemantics;
assert!(!PopupSemantics::new().dismiss_on_outside_press(false).dismisses_on_outside_press());

pub const fn dismiss_on_escape(self, dismiss: bool) -> Self

Sets Escape dismissal exactly to dismiss.

Examples

use ailloli_ui_runtime::popup::PopupSemantics;
assert!(!PopupSemantics::new().dismiss_on_escape(false).dismisses_on_escape());

pub const fn consume_pointer_input(self, consume: bool) -> Self

Sets pointer-input consumption exactly to consume.

Examples

use ailloli_ui_runtime::popup::PopupSemantics;
assert!(!PopupSemantics::new().consume_pointer_input(false).consumes_pointer_input());

pub const fn restore_focus_on_close(self, restore: bool) -> Self

Sets owner focus restoration exactly to restore.

Examples

use ailloli_ui_runtime::popup::PopupSemantics;
assert!(!PopupSemantics::new().restore_focus_on_close(false).restores_focus_on_close());

pub const fn tooltip() -> Self

Non-interactive semantics suitable for a tooltip.

Role is tooltip; Escape dismissal stays enabled, while outside press, pointer consumption, and focus restoration are disabled.

Examples

use ailloli_ui_runtime::popup::{PopupRole, PopupSemantics};
let value = PopupSemantics::tooltip();
assert_eq!(value.role(), PopupRole::Tooltip);
assert!(value.dismisses_on_escape());
assert!(!value.dismisses_on_outside_press() && !value.consumes_pointer_input());
assert!(!value.restores_focus_on_close());

Trait Implementations

impl Clone for PopupSemantics

fn clone(&self) -> PopupSemantics

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PopupSemantics

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

Formats the value using the given formatter.

impl Default for PopupSemantics

Uses the interactive defaults from PopupSemantics::new.

fn default() -> Self

Returns PopupSemantics::new.

impl PartialEq for PopupSemantics

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

impl StructuralPartialEq for PopupSemantics