[go: up one dir, main page]

Modal

egui::containers::modal

Struct Modal 

Source 
pub struct Modal {
    pub area: Area,
    pub backdrop_color: Color32,
    pub frame: Option<Frame>,
}
Expand description

A modal dialog.

Similar to a crate::Window but centered and with a backdrop that blocks input to the rest of the UI.

You can show multiple modals on top of each other. The topmost modal will always be the most recently shown one. If multiple modals are newly shown in the same frame, the order of the modals is undefined (either first or second could be top).

Fields§

§area: Area§backdrop_color: Color32§frame: Option<Frame>

Implementations§

Source§

impl Modal

Source

pub fn new(id: Id) -> Self

Create a new Modal.

The id is passed to the area.

Source

pub fn default_area(id: Id) -> Area

Returns an area customized for a modal.

Makes these changes to the default area:

  • sense: hover
  • anchor: center
  • order: foreground
Source

pub fn frame(self, frame: Frame) -> Self

Set the frame of the modal.

Default is Frame::popup.

Source

pub fn backdrop_color(self, color: Color32) -> Self

Set the backdrop color of the modal.

Default is Color32::from_black_alpha(100).

Source

pub fn area(self, area: Area) -> Self

Set the area of the modal.

Default is Modal::default_area.

Source

pub fn show<T>( self, ctx: &Context, content: impl FnOnce(&mut Ui) -> T, ) -> ModalResponse<T>

Show the modal.

Auto Trait Implementations§

§

impl Freeze for Modal

§

impl !RefUnwindSafe for Modal

§

impl Send for Modal

§

impl Sync for Modal

§

impl Unpin for Modal

§

impl !UnwindSafe for Modal

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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.