Struct imgui::PopupModal

source ·
pub struct PopupModal<'ui, 'p, Label> { /* private fields */ }
Expand description

Create a modal pop-up.

Example

if ui.button("Show modal") {
    ui.open_popup("modal");
}
if let Some(_token) = ui.begin_modal_popup("modal") {
    ui.text("Content of my modal");
    if ui.button("OK") {
        ui.close_current_popup();
    }
};

Implementations§

source§

impl<'ui, 'p, Label: AsRef<str>> PopupModal<'ui, 'p, Label>

source

pub fn new(ui: &'ui Ui, label: Label) -> Self

👎Deprecated since 0.9.0: Use ui.modal_popup_config(...) instead
source

pub fn opened(self, opened: &'p mut bool) -> Self

Pass a mutable boolean which will be updated to refer to the current “open” state of the modal.

source

pub fn flags(self, flags: WindowFlags) -> Self

source

pub fn title_bar(self, value: bool) -> Self

source

pub fn resizable(self, value: bool) -> Self

source

pub fn movable(self, value: bool) -> Self

source

pub fn scroll_bar(self, value: bool) -> Self

source

pub fn scrollable(self, value: bool) -> Self

source

pub fn collapsible(self, value: bool) -> Self

source

pub fn always_auto_resize(self, value: bool) -> Self

source

pub fn save_settings(self, value: bool) -> Self

source

pub fn inputs(self, value: bool) -> Self

source

pub fn menu_bar(self, value: bool) -> Self

source

pub fn horizontal_scrollbar(self, value: bool) -> Self

source

pub fn no_focus_on_appearing(self, value: bool) -> Self

source

pub fn no_bring_to_front_on_focus(self, value: bool) -> Self

source

pub fn always_vertical_scrollbar(self, value: bool) -> Self

source

pub fn always_horizontal_scrollbar(self, value: bool) -> Self

source

pub fn always_use_window_padding(self, value: bool) -> Self

source

pub fn build<T, F: FnOnce() -> T>(self, f: F) -> Option<T>

Consume and draw the PopupModal. Returns the result of the closure, if it is called.

source

pub fn begin_popup(self) -> Option<PopupToken<'ui>>

Consume and draw the PopupModal. Construct a popup that can have any kind of content.

This should be called per frame, whereas Ui::open_popup should be called once when you want to actual create the popup.

Auto Trait Implementations§

§

impl<'ui, 'p, Label> !RefUnwindSafe for PopupModal<'ui, 'p, Label>

§

impl<'ui, 'p, Label> !Send for PopupModal<'ui, 'p, Label>

§

impl<'ui, 'p, Label> !Sync for PopupModal<'ui, 'p, Label>

§

impl<'ui, 'p, Label> Unpin for PopupModal<'ui, 'p, Label>where Label: Unpin,

§

impl<'ui, 'p, Label> !UnwindSafe for PopupModal<'ui, 'p, Label>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

const: unstable · 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> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.