Struct PopupCoreState

pub struct PopupCoreState {
    pub area: Rect,
    pub area_z: u16,
    pub widget_area: Rect,
    pub h_scroll: ScrollState,
    pub v_scroll: ScrollState,
    pub active: ContainerFlag,
    pub mouse: MouseFlags,
    pub non_exhaustive: NonExhaustive,
}

Fields

area: Rect

Area for the widget. This is the area given to render(), corrected by the given constraints. read only. renewed for each render.

area_z: u16

Z-Index for the popup.

widget_area: Rect

Area where the widget can render it’s content. read only. renewed for each render.

h_scroll: ScrollState

Horizontal scroll state if active. read+write

v_scroll: ScrollState

Vertical scroll state if active. read+write

active: ContainerFlag

Active flag for the popup.

Uses a ContainerFlag that can be combined with the FocusFlags your widget uses for handling its focus to detect the transition ‘Did the popup loose focus and should it be closed now’.

If you don’t rely on Focus this way, this will just be a boolean flag that indicates active/visible.

See See the examples how to use for both cases. read+write

mouse: MouseFlags

Mouse flags. read+write

non_exhaustive: NonExhaustive

non-exhaustive struct.

Implementations

impl PopupCoreState

pub fn new() -> PopupCoreState

New

pub fn named(name: &str) -> PopupCoreState

New with a focus name.

pub fn set_area_z(&mut self, z: u16)

Set the z-index of the popup.

pub fn area_z(&self) -> u16

The z-index of the popup.

pub fn is_active(&self) -> bool

Is the popup active/visible.

pub fn flip_active(&mut self)

Flip visibility of the popup.

pub fn set_active(&mut self, active: bool)

Show the popup. This will set gained/lost flags according to the change. If the popup is hidden this will clear all the areas.

pub fn clear_areas(&mut self)

Clear the areas.

Trait Implementations

impl Clone for PopupCoreState

fn clone(&self) -> PopupCoreState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PopupCoreState

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

Formats the value using the given formatter.

impl Default for PopupCoreState

fn default() -> PopupCoreState

Returns the “default value” for a type.

impl HandleEvent<Event, Popup, PopupOutcome> for PopupCoreState

fn handle(&mut self, event: &Event, _qualifier: Popup) -> PopupOutcome

Handle an event.

impl RelocatableState for PopupCoreState

fn relocate(&mut self, shift: (i16, i16), clip: Rect)

Relocate the areas in this widgets state.