Dialog

Struct Dialog 

Source
pub struct Dialog {
    id: Id,
    rect: Rectangle,
    children: Vec<Box<dyn View>>,
    view_id: ViewId,
    button_count: usize,
    button_width: i32,
}
Expand description

A modal dialog view that displays a message and allows users to select from custom buttons.

The dialog is centered on the display and renders a bordered rectangle containing:

  • A title message (can be multi-line)
  • Buttons evenly distributed horizontally

§Closing a Dialog

The dialog sends an Event::Close when the user taps outside the dialog area. To close the dialog from a button tap, configure the button with a Event::Close event. Other button events are propagated without closing the dialog. Which means you must handle the closing of the dialog.

§Lifecycle

Create a dialog using the builder pattern via Dialog::builder, which handles automatic layout calculation based on the display dimensions and text content.

§Example

use cadmus_core::view::dialog::Dialog;
use cadmus_core::view::{Event, ViewId, View};

let mut view_children: Vec<Box<dyn View>> = Vec::new();

// Note: In actual use, `context` is provided by the application.
// Dialog::builder requires a properly initialized Context with
// Display and Fonts, so we show the API pattern here.
let dialog = Dialog::builder(ViewId::BookMenu, "Delete this file?".to_string())
    .add_button("No", Event::Close(ViewId::BookMenu))
    .add_button("Yes", Event::Close(ViewId::BookMenu))
    .build(&mut context);

view_children.push(Box::new(dialog) as Box<dyn View>);

Fields§

§id: Id§rect: Rectangle§children: Vec<Box<dyn View>>§view_id: ViewId§button_count: usize§button_width: i32

Content-based button width computed once during DialogBuilder::build from the widest button text. Reused by layout_children on every resize so buttons keep their text-proportional sizing.

Implementations§

Source§

impl Dialog

Source

pub fn builder(view_id: ViewId, title: String) -> DialogBuilder

Create a builder for a new dialog.

§Arguments
  • view_id - Unique identifier for the dialog
  • title - The message text to display (supports multi-line text)
§Returns

A DialogBuilder that can be configured with buttons via add_button.

§Example
use cadmus_core::view::dialog::Dialog;
use cadmus_core::view::{Event, ViewId};

let _dialog = Dialog::builder(ViewId::BookMenu, "Are you sure?".to_string())
    .add_button("Cancel", Event::Close(ViewId::BookMenu))
    .add_button("OK", Event::Validate)
    .build(&mut context);
Source

fn layout_children(&mut self, fonts: &mut Fonts)

Position all child views within the current dialog rect.

Labels are stacked vertically with one padding inset from each edge. Buttons use a content-based width (button_width) and are centered horizontally with even spacing.

Both DialogBuilder::build and Dialog::resize delegate to this method so the layout algorithm is defined in a single place.

Trait Implementations§

Source§

impl View for Dialog

Source§

fn handle_event( &mut self, evt: &Event, hub: &Hub, _bus: &mut Bus, _rq: &mut RenderQueue, _context: &mut Context, ) -> bool

Source§

fn render(&self, fb: &mut dyn Framebuffer, _rect: Rectangle, _fonts: &mut Fonts)

Source§

fn resize( &mut self, _rect: Rectangle, hub: &Hub, rq: &mut RenderQueue, context: &mut Context, )

Source§

fn is_background(&self) -> bool

Source§

fn rect(&self) -> &Rectangle

Source§

fn rect_mut(&mut self) -> &mut Rectangle

Source§

fn children(&self) -> &Vec<Box<dyn View>>

Source§

fn children_mut(&mut self) -> &mut Vec<Box<dyn View>>

Source§

fn id(&self) -> Id

Source§

fn view_id(&self) -> Option<ViewId>

Source§

fn render_rect(&self, _rect: &Rectangle) -> Rectangle

Source§

fn child(&self, index: usize) -> &dyn View

Source§

fn child_mut(&mut self, index: usize) -> &mut dyn View

Source§

fn len(&self) -> usize

Source§

fn might_skip(&self, _evt: &Event) -> bool

Source§

fn might_rotate(&self) -> bool

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
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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.

§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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