Struct PopupPlacementSpec

pub struct PopupPlacementSpec { /* private fields */ }

Provider-neutral placement requested before a host viewport is known.

The active host combines this semantic geometry with its viewport and backend capabilities through resolve_popup_placement. Keeping viewport data out of this value prevents widgets from substituting their own bounds for the complete presentation area. All geometry is in logical pixels and is stored without validation; portal publication or placement resolution performs validation.

Examples

use ailloli_ui_core::{Rect, Size};
use ailloli_ui_runtime::popup::PopupPlacementSpec;
let spec = PopupPlacementSpec::new(Rect::new(1.0, 2.0, 3.0, 4.0), Size::new(20.0, 10.0));
assert_eq!(spec.gap(), 0.0);
assert!(spec.allows_flip());

Implementations

impl PopupPlacementSpec

Builder and accessor operations for semantic placement input.

pub const fn new(anchor: Rect, desired_size: Size) -> Self

Creates bottom-centered placement with zero gap and flipping enabled.

Values are stored verbatim and validated only when published/resolved.

Examples

use ailloli_ui_core::{Rect, Size};
use ailloli_ui_runtime::popup::{PopupAlignment, PopupPlacement, PopupPlacementSpec};
let spec = PopupPlacementSpec::new(Rect::new(0.0, 0.0, 10.0, 5.0), Size::new(30.0, 20.0));
assert_eq!((spec.placement(), spec.alignment(), spec.gap(), spec.allows_flip()), (PopupPlacement::Bottom, PopupAlignment::Center, 0.0, true));

pub const fn anchor(self) -> Rect

Returns the stored global logical-pixel anchor rectangle.

Examples

use ailloli_ui_core::{Rect, Size};
use ailloli_ui_runtime::popup::PopupPlacementSpec;
let anchor = Rect::new(1.0, 2.0, 3.0, 4.0);
assert_eq!(PopupPlacementSpec::new(anchor, Size::new(5.0, 6.0)).anchor(), anchor);

pub const fn desired_size(self) -> Size

Returns the requested logical-pixel popup size.

Examples

use ailloli_ui_core::{Rect, Size};
use ailloli_ui_runtime::popup::PopupPlacementSpec;
let size = Size::new(20.0, 10.0);
assert_eq!(PopupPlacementSpec::new(Rect::new(0.0, 0.0, 0.0, 0.0), size).desired_size(), size);

pub const fn placement(self) -> PopupPlacement

Returns the preferred vertical side.

Examples

use ailloli_ui_core::{Rect, Size};
use ailloli_ui_runtime::popup::{PopupPlacement, PopupPlacementSpec};
assert_eq!(PopupPlacementSpec::new(Rect::new(0.0, 0.0, 0.0, 0.0), Size::default()).placement(), PopupPlacement::Bottom);

pub const fn alignment(self) -> PopupAlignment

Returns the requested cross-axis alignment.

Examples

use ailloli_ui_core::{Rect, Size};
use ailloli_ui_runtime::popup::{PopupAlignment, PopupPlacementSpec};
assert_eq!(PopupPlacementSpec::new(Rect::new(0.0, 0.0, 0.0, 0.0), Size::default()).alignment(), PopupAlignment::Center);

pub const fn gap(self) -> f32

Returns the requested anchor gap in logical pixels.

Examples

use ailloli_ui_core::{Rect, Size};
use ailloli_ui_runtime::popup::PopupPlacementSpec;
assert_eq!(PopupPlacementSpec::new(Rect::new(0.0, 0.0, 0.0, 0.0), Size::default()).with_gap(4.0).gap(), 4.0);

pub const fn allows_flip(self) -> bool

Returns whether the host may select the opposite vertical side.

Examples

use ailloli_ui_core::{Rect, Size};
use ailloli_ui_runtime::popup::PopupPlacementSpec;
assert!(!PopupPlacementSpec::new(Rect::new(0.0, 0.0, 0.0, 0.0), Size::default()).with_flip(false).allows_flip());

pub const fn with_placement(self, placement: PopupPlacement) -> Self

Replaces the preferred vertical side.

Examples

use ailloli_ui_core::{Rect, Size};
use ailloli_ui_runtime::popup::{PopupPlacement, PopupPlacementSpec};
let spec = PopupPlacementSpec::new(Rect::new(0.0, 0.0, 0.0, 0.0), Size::default()).with_placement(PopupPlacement::Top);
assert_eq!(spec.placement(), PopupPlacement::Top);

pub const fn with_alignment(self, alignment: PopupAlignment) -> Self

Replaces cross-axis alignment.

Examples

use ailloli_ui_core::{Rect, Size};
use ailloli_ui_runtime::popup::{PopupAlignment, PopupPlacementSpec};
let spec = PopupPlacementSpec::new(Rect::new(0.0, 0.0, 0.0, 0.0), Size::default()).with_alignment(PopupAlignment::End);
assert_eq!(spec.alignment(), PopupAlignment::End);

pub const fn with_gap(self, gap: f32) -> Self

Replaces the logical-pixel gap without validating it.

Negative and non-finite values are rejected when the spec is published.

Examples

use ailloli_ui_core::{Rect, Size};
use ailloli_ui_runtime::popup::PopupPlacementSpec;
assert_eq!(PopupPlacementSpec::new(Rect::new(0.0, 0.0, 0.0, 0.0), Size::default()).with_gap(2.5).gap(), 2.5);

pub const fn with_flip(self, allow_flip: bool) -> Self

Enables or disables automatic vertical-side flipping.

Examples

use ailloli_ui_core::{Rect, Size};
use ailloli_ui_runtime::popup::PopupPlacementSpec;
assert!(!PopupPlacementSpec::new(Rect::new(0.0, 0.0, 0.0, 0.0), Size::default()).with_flip(false).allows_flip());

Trait Implementations

impl Clone for PopupPlacementSpec

fn clone(&self) -> PopupPlacementSpec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PopupPlacementSpec

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

Formats the value using the given formatter.

impl PartialEq for PopupPlacementSpec

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

impl StructuralPartialEq for PopupPlacementSpec