Skip to main content

Modal

Struct Modal 

Source
pub struct Modal {
Show 17 fields pub rect: Rect, pub panel_width: f32, pub panel_height: f32, pub title: String, pub content: String, pub buttons: Vec<ModalButton>, pub overlay_color: ColorLinPremul, pub panel_bg: ColorLinPremul, pub panel_border_color: ColorLinPremul, pub title_color: ColorLinPremul, pub content_color: ColorLinPremul, pub title_size: f32, pub content_size: f32, pub button_label_size: f32, pub panel_radius: f32, pub visible: bool, pub focus_id: FocusId,
}
Expand description

An overlay dialog centered on the screen with title, content, and action buttons.

Fields§

§rect: Rect

Overall bounding rect (typically the full viewport).

§panel_width: f32

Panel width.

§panel_height: f32

Panel height.

§title: String

Title text.

§content: String

Content/body text (newlines supported).

§buttons: Vec<ModalButton>

Action buttons rendered at the bottom of the panel.

§overlay_color: ColorLinPremul

Semi-transparent overlay color.

§panel_bg: ColorLinPremul

Panel background.

§panel_border_color: ColorLinPremul

Panel border color.

§title_color: ColorLinPremul

Title text color.

§content_color: ColorLinPremul

Content text color.

§title_size: f32

Title font size.

§content_size: f32

Content font size.

§button_label_size: f32

Button label font size.

§panel_radius: f32

Panel corner radius.

§visible: bool

Whether the modal is currently visible.

§focus_id: FocusId

Focus identifier.

Implementations§

Source§

impl Modal

Source

pub fn new( viewport: Rect, title: impl Into<String>, content: impl Into<String>, buttons: Vec<ModalButton>, ) -> Self

Create a modal with default styling.

Source

pub fn panel_rect(&self) -> Rect

Compute the centered panel rectangle.

Source

pub fn close_button_rect(&self) -> Rect

Close button rectangle (top-right of panel).

Source

pub fn button_rects(&self) -> Vec<Rect>

Compute rectangles for all action buttons (centered at bottom).

Source

pub fn handle_click(&self, x: f32, y: f32) -> ModalClickResult

Handle a click and return what was hit.

Trait Implementations§

Source§

impl Element for Modal

Source§

fn rect(&self) -> Rect

The bounding rectangle of this element in logical coordinates.
Source§

fn set_rect(&mut self, rect: Rect)

Update the bounding rectangle (typically called by the layout engine).
Source§

fn render(&self, canvas: &mut Canvas, z: i32)

Paint this element onto canvas at the given z-index.
Source§

fn focus_id(&self) -> Option<FocusId>

The focus identifier for this element, if it is focusable.
Source§

impl EventHandler for Modal

Source§

fn handle_mouse_click(&mut self, event: &MouseClickEvent) -> EventResult

Handle a mouse click event. Returns Handled if the event was consumed.
Source§

fn handle_keyboard(&mut self, event: &KeyboardEvent) -> EventResult

Handle a keyboard event. Returns Handled if the event was consumed.
Source§

fn handle_mouse_move(&mut self, _event: &MouseMoveEvent) -> EventResult

Handle a mouse-move event.
Source§

fn handle_scroll(&mut self, _event: &ScrollEvent) -> EventResult

Handle a scroll event.
Source§

fn is_focused(&self) -> bool

Whether this element currently has focus.
Source§

fn set_focused(&mut self, _focused: bool)

Set focus state for this element.
Source§

fn contains_point(&self, _x: f32, _y: f32) -> bool

Hit-test: does this element contain the given logical point?

Auto Trait Implementations§

§

impl Freeze for Modal

§

impl RefUnwindSafe for Modal

§

impl Send for Modal

§

impl Sync for Modal

§

impl Unpin for Modal

§

impl UnsafeUnpin for Modal

§

impl UnwindSafe for Modal

Blanket Implementations§

Source§

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
where T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, D: AdaptFrom<S, Swp, Dwp, T>,

Source§

fn adapt_into_using<M>(self, method: M) -> D
where M: TransformMatrix<T>,

Convert the source color to the destination color using the specified method.
Source§

fn adapt_into(self) -> D

Convert the source color to the destination color using the bradford method by default.
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, C> ArraysFrom<C> for T
where C: IntoArrays<T>,

Source§

fn arrays_from(colors: C) -> T

Cast a collection of colors into a collection of arrays.
Source§

impl<T, C> ArraysInto<C> for T
where C: FromArrays<T>,

Source§

fn arrays_into(self) -> C

Cast this collection of arrays into a collection of colors.
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<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for U
where T: FromCam16Unclamped<WpParam, U>,

Source§

type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.
Source§

fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.
Source§

impl<T, C> ComponentsFrom<C> for T
where C: IntoComponents<T>,

Source§

fn components_from(colors: C) -> T

Cast a collection of colors into a collection of color components.
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromAngle<T> for T

Source§

fn from_angle(angle: T) -> T

Performs a conversion from angle.
Source§

impl<T, U> FromStimulus<U> for T
where U: IntoStimulus<T>,

Source§

fn from_stimulus(other: U) -> T

Converts other into Self, while performing the appropriate scaling, rounding and clamping.
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, U> IntoAngle<U> for T
where U: FromAngle<T>,

Source§

fn into_angle(self) -> U

Performs a conversion into T.
Source§

impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for U
where T: Cam16FromUnclamped<WpParam, U>,

Source§

type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.
Source§

fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.
Source§

impl<T, U> IntoColor<U> for T
where U: FromColor<T>,

Source§

fn into_color(self) -> U

Convert into T with values clamped to the color defined bounds Read more
Source§

impl<T, U> IntoColorUnclamped<U> for T
where U: FromColorUnclamped<T>,

Source§

fn into_color_unclamped(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more
Source§

impl<T> IntoStimulus<T> for T

Source§

fn into_stimulus(self) -> T

Converts self into T, while performing the appropriate scaling, rounding and clamping.
Source§

impl<T, C> TryComponentsInto<C> for T
where C: TryFromComponents<T>,

Source§

type Error = <C as TryFromComponents<T>>::Error

The error for when try_into_colors fails to cast.
Source§

fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>

Try to cast this collection of color components into a collection of colors. 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, U> TryIntoColor<U> for T
where U: TryFromColor<T>,

Source§

fn try_into_color(self) -> Result<U, OutOfBounds<U>>

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more
Source§

impl<C, U> UintsFrom<C> for U
where C: IntoUints<U>,

Source§

fn uints_from(colors: C) -> U

Cast a collection of colors into a collection of unsigned integers.
Source§

impl<C, U> UintsInto<C> for U
where C: FromUints<U>,

Source§

fn uints_into(self) -> C

Cast this collection of unsigned integers into a collection of colors.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,