Struct DialogState 

pub struct DialogState { /* private fields */ }

State for a Dialog component.

Contains all the state needed to render and manage a dialog, including title, message, buttons, and focus state.

Implementations

impl DialogState

pub fn new( title: impl Into<String>, message: impl Into<String>, buttons: Vec<DialogButton>, ) -> Self

Creates a new dialog with the given title, message, and buttons.

The first button is set as the primary button by default.

Example

use envision::component::{DialogButton, DialogState};

let buttons = vec![
    DialogButton::new("ok", "OK"),
    DialogButton::new("cancel", "Cancel"),
];
let state = DialogState::new("Title", "Message", buttons);
assert_eq!(state.title(), "Title");
assert_eq!(state.primary_button(), 0);

pub fn with_primary( title: impl Into<String>, message: impl Into<String>, buttons: Vec<DialogButton>, primary: usize, ) -> Self

Creates a dialog with a primary button specified.

The primary button index is clamped to the valid range.

Example

use envision::component::{DialogButton, DialogState};

let buttons = vec![
    DialogButton::new("cancel", "Cancel"),
    DialogButton::new("ok", "OK"),
];
let state = DialogState::with_primary("Title", "Message", buttons, 1);
assert_eq!(state.primary_button(), 1);

pub fn alert(title: impl Into<String>, message: impl Into<String>) -> Self

Creates a simple alert dialog with an “OK” button.

Example

use envision::component::DialogState;

let state = DialogState::alert("Error", "Something went wrong.");
assert_eq!(state.buttons().len(), 1);
assert_eq!(state.buttons()[0].id(), "ok");

pub fn confirm(title: impl Into<String>, message: impl Into<String>) -> Self

Creates a confirmation dialog with “Cancel” and “OK” buttons.

The “OK” button is set as the primary button.

Example

use envision::component::DialogState;

let state = DialogState::confirm("Delete?", "This cannot be undone.");
assert_eq!(state.buttons().len(), 2);
assert_eq!(state.buttons()[0].id(), "cancel");
assert_eq!(state.buttons()[1].id(), "ok");
assert_eq!(state.primary_button(), 1);

pub fn title(&self) -> &str

Returns the dialog title.

Examples

use envision::prelude::*;

let state = DialogState::alert("Error", "Something went wrong.");
assert_eq!(state.title(), "Error");

pub fn message(&self) -> &str

Returns the dialog message.

Examples

use envision::prelude::*;

let state = DialogState::alert("Error", "File not found.");
assert_eq!(state.message(), "File not found.");

pub fn buttons(&self) -> &[DialogButton]

Returns the dialog buttons.

Examples

use envision::prelude::*;

let state = DialogState::confirm("Delete?", "Are you sure?");
assert_eq!(state.buttons().len(), 2);
assert_eq!(state.buttons()[0].id(), "cancel");
assert_eq!(state.buttons()[1].id(), "ok");

pub fn primary_button(&self) -> usize

Returns the index of the primary button.

pub fn focused_button(&self) -> usize

Returns the index of the currently focused button.

pub fn set_title(&mut self, title: impl Into<String>)

Sets the dialog title.

pub fn set_message(&mut self, message: impl Into<String>)

Sets the dialog message.

pub fn set_buttons(&mut self, buttons: Vec<DialogButton>)

Sets the dialog buttons.

Resets focus to the first button or primary button index.

pub fn set_primary_button(&mut self, index: usize)

Sets the primary button index.

The index is clamped to the valid range.

pub fn with_title(self, title: impl Into<String>) -> Self

Sets the dialog title (builder method).

Example

use envision::component::DialogState;

let state = DialogState::default().with_title("My Title");
assert_eq!(state.title(), "My Title");

pub fn with_message(self, message: impl Into<String>) -> Self

Sets the dialog message (builder method).

Example

use envision::component::DialogState;

let state = DialogState::default().with_message("Important message");
assert_eq!(state.message(), "Important message");

pub fn with_buttons(self, buttons: Vec<DialogButton>) -> Self

Sets the dialog buttons (builder method).

Resets focus to the first button or primary button index.

Example

use envision::component::{DialogButton, DialogState};

let state = DialogState::default().with_buttons(vec![
    DialogButton::new("ok", "OK"),
    DialogButton::new("cancel", "Cancel"),
]);
assert_eq!(state.buttons().len(), 2);

pub fn with_primary_button(self, index: usize) -> Self

Sets the primary button index (builder method).

The index is clamped to the valid range.

Example

use envision::component::{DialogButton, DialogState};

let state = DialogState::new("T", "M", vec![
    DialogButton::new("a", "A"),
    DialogButton::new("b", "B"),
]).with_primary_button(1);
assert_eq!(state.primary_button(), 1);

pub fn is_focused(&self) -> bool

Returns true if the dialog is focused.

Examples

use envision::prelude::*;

let state = DialogState::alert("Info", "Done.");
assert!(!state.is_focused());

pub fn set_focused(&mut self, focused: bool)

Sets the focus state.

Examples

use envision::prelude::*;

let mut state = DialogState::alert("Info", "Done.");
state.set_focused(true);
assert!(state.is_focused());

pub fn is_disabled(&self) -> bool

Returns true if the dialog is disabled.

pub fn set_disabled(&mut self, disabled: bool)

Sets the disabled state.

pub fn with_disabled(self, disabled: bool) -> Self

Sets the disabled state using builder pattern.

pub fn is_visible(&self) -> bool

Returns true if the dialog is visible.

Examples

use envision::prelude::*;

let state = DialogState::alert("Info", "Done.");
assert!(!state.is_visible());

pub fn set_visible(&mut self, visible: bool)

Sets the visibility state.

Examples

use envision::prelude::*;

let mut state = DialogState::alert("Info", "Done.");
state.set_visible(true);
assert!(state.is_visible());

pub fn handle_event(&self, event: &Event) -> Option<DialogMessage>

Maps an input event to a dialog message.

pub fn dispatch_event(&mut self, event: &Event) -> Option<DialogOutput>

Dispatches an event, updating state and returning any output.

pub fn update(&mut self, msg: DialogMessage) -> Option<DialogOutput>

Updates the dialog state with a message, returning any output.

Trait Implementations

impl Clone for DialogState

fn clone(&self) -> DialogState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DialogState

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

Formats the value using the given formatter.

impl Default for DialogState

fn default() -> DialogState

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DialogState

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DialogState

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DialogState