Struct OverlayState 

pub struct OverlayState { /* private fields */ }

Manages overlay visibility with mutual exclusion.

Only one overlay can be visible at a time - showing a new overlay automatically closes others.

Example

use crate::tui::viewmodel::OverlayState;

let mut overlay = OverlayState::new();

overlay.toggle(OverlayKind::Help);
assert!(overlay.is_showing(OverlayKind::Help));

overlay.toggle(OverlayKind::Export);
assert!(overlay.is_showing(OverlayKind::Export));
assert!(!overlay.is_showing(OverlayKind::Help)); // Auto-closed

Implementations

impl OverlayState

pub const fn new() -> Self

Create a new overlay state with no overlay visible.

pub const fn has_overlay(&self) -> bool

Check if any overlay is currently visible.

pub fn is_showing(&self, kind: OverlayKind) -> bool

Check if a specific overlay is visible.

pub const fn current(&self) -> Option<OverlayKind>

Get the currently visible overlay.

pub const fn show(&mut self, kind: OverlayKind)

Show a specific overlay, closing any other.

pub const fn close(&mut self)

Close the current overlay.

pub const fn close_all(&mut self)

Close all overlays.

pub fn toggle(&mut self, kind: OverlayKind)

Toggle a specific overlay.

If the overlay is showing, close it. Otherwise, show it.

pub fn toggle_help(&mut self)

Toggle help overlay.

pub fn toggle_export(&mut self)

Toggle export overlay.

pub fn toggle_legend(&mut self)

Toggle legend overlay.

pub fn show_help(&self) -> bool

Check if help overlay is visible.

pub fn show_export(&self) -> bool

Check if export overlay is visible.

pub fn show_legend(&self) -> bool

Check if legend overlay is visible.

Trait Implementations

impl Clone for OverlayState

fn clone(&self) -> OverlayState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OverlayState

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

Formats the value using the given formatter.

impl Default for OverlayState

fn default() -> OverlayState

Returns the “default value” for a type.