Skip to main content

Dialog

Struct Dialog 

Source
pub struct Dialog { /* private fields */ }
Expand description

A dialog widget built on Modal.

Invariants:

  • At least one button is always present.
  • Button focus wraps around (modular arithmetic).
  • For Prompt dialogs, Tab cycles: input -> buttons -> input.

Failure modes:

  • If area is too small, content may be truncated but dialog never panics.
  • Empty title/message is allowed (renders nothing for that row).

Implementations§

Source§

impl Dialog

Source

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

Create an alert dialog (message + OK).

Source

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

Create a confirm dialog (message + OK/Cancel).

Source

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

Create a prompt dialog (message + input + OK/Cancel).

Source

pub fn custom( title: impl Into<String>, message: impl Into<String>, ) -> DialogBuilder

Create a custom dialog with a builder.

Source

pub fn hit_id(self, id: HitId) -> Self

Set the hit ID for mouse interaction.

Source

pub fn modal_config(self, config: ModalConfig) -> Self

Set the modal configuration.

Source

pub fn button_style(self, style: Style) -> Self

Set button style.

Source

pub fn primary_button_style(self, style: Style) -> Self

Set primary button style.

Source

pub fn focused_button_style(self, style: Style) -> Self

Set focused button style.

Source

pub fn handle_event( &self, event: &Event, state: &mut DialogState, hit: Option<(HitId, HitRegion, HitData)>, ) -> Option<DialogResult>

Handle an event and potentially update state.

Trait Implementations§

Source§

impl Clone for Dialog

Source§

fn clone(&self) -> Dialog

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Dialog

Source§

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

Formats the value using the given formatter. Read more
Source§

impl StatefulWidget for Dialog

Source§

type State = DialogState

The state type associated with this widget.
Source§

fn render(&self, area: Rect, frame: &mut Frame<'_>, state: &mut Self::State)

Render the widget into the frame, potentially modifying state. Read more

Auto Trait Implementations§

§

impl Freeze for Dialog

§

impl RefUnwindSafe for Dialog

§

impl Send for Dialog

§

impl Sync for Dialog

§

impl Unpin for Dialog

§

impl UnwindSafe for Dialog

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more