Struct Modal 

#[repr(C)]
pub struct Modal {
    pub modal_state: ModalStateWrapper,
    pub title: AzString,
    pub content: Dom,
    pub show_close_button: bool,
    pub backdrop_style: CssPropertyWithConditionsVec,
}

An in-app overlay dialog holding arbitrary content, with an optional title and close button.

Fields

modal_state: ModalStateWrapper

Runtime state (open) plus the optional close callback.

title: AzString

The dialog title (empty = no title bar).

content: Dom

The arbitrary content shown inside the panel.

show_close_button: bool

Whether to render the “x” close button.

backdrop_style: CssPropertyWithConditionsVec

Style of the full-area backdrop (includes its current display).

Implementations

impl Modal

pub fn create(content: Dom) -> Self

Creates a new (closed) modal holding content, with a “x” close button and no title.

pub fn set_title(&mut self, title: AzString)

Sets the dialog title (empty = no title).

pub fn with_title(self, title: AzString) -> Self

Builder-style setter for the title.

pub fn set_content(&mut self, content: Dom)

Replaces the content shown inside the panel.

pub fn with_content(self, content: Dom) -> Self

Builder-style setter for the content.

pub fn set_open(&mut self, open: bool)

Sets whether the dialog is currently open, recomputing the backdrop style.

pub fn with_open(self, open: bool) -> Self

Builder-style setter for the initial open state.

pub const fn set_close_button(&mut self, show: bool)

Sets whether the “x” close button is shown.

pub const fn with_close_button(self, show: bool) -> Self

Builder-style setter for the close-button flag.

pub fn set_on_close<C: Into<ModalOnCloseCallback>>( &mut self, data: RefAny, on_close: C, )

Sets the close callback (invoked with the new state when “x” is clicked).

pub fn with_on_close<C: Into<ModalOnCloseCallback>>( self, data: RefAny, on_close: C, ) -> Self

Builder-style setter for the close callback.

pub fn swap_with_default(&mut self) -> Self

Replaces self with a default (empty, closed) modal and returns the original.

pub fn dom(self) -> Dom

Renders the modal into a Dom subtree with the __azul-native-modal class (the backdrop).

Trait Implementations

impl Clone for Modal

fn clone(&self) -> Modal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Modal

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

Formats the value using the given formatter.

impl Default for Modal

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Modal

impl From<Modal> for Dom

fn from(m: Modal) -> Self

Converts to this type from the input type.

impl PartialEq for Modal

fn eq(&self, other: &Modal) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Modal