Struct WindowModal

pub struct WindowModal(/* private fields */);

Available on crate feature gui only.

An user modal window, which can handle events. Can be programmatically created or load a dialog resource from a .res file.

Implementations

impl WindowModal

pub fn new(opts: WindowModalOpts) -> Self

Instantiates a new WindowModal object, to be created internally with HWND::CreateWindowEx.

pub fn new_dlg(dlg_id: u16) -> Self

Instantiates a new WindowModal object, to be loaded from a dialog resource with HINSTANCE::DialogBoxParam.

pub fn show_modal(&self, parent: &impl GuiParent) -> AnyResult<()>

Physically creates the window, then runs the modal loop. This method will block until the window is closed.

Note that, if the user clicks the “X” to close the modal, the default behavior is to call EndDialog(0). To override this behavior, handle the modal’s wm_close yourself.

Panics

Panics if the window is already created.

Panics if the creation process fails.

pub fn close(&self)

Closes the window by posting a WM_CLOSE message. This is the safest way to close any popup window, because you’ll able to process the wm_close event, just like if the user clicked the window “X” button.

Trait Implementations

impl Clone for WindowModal

fn clone(&self) -> WindowModal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl GuiParent for WindowModal

fn on(&self) -> &WindowEvents

Exposes methods to handle the basic window messages, plus timer and native control notifications.

fn spawn_thread<F>(&self, func: F)

where F: FnOnce() -> AnyResult<()> + Send + 'static,

This method calls std::thread::spawn, but it allows the returning of an error value. This error value will be forwarded to the original UI thread, allowing it to be caught at WindowMain::run_main.

fn run_ui_thread<F>(&self, func: F)

where F: FnOnce() -> AnyResult<()> + Send + 'static,

Runs a closure synchronously in the window’s original UI thread, allowing UI updates without the risk of a deadlock.

impl GuiWindow for WindowModal

fn hwnd(&self) -> &HWND

Returns the underlying handle for this window.

fn as_any(&self) -> &dyn Any

Converts a reference to the Any trait. This is useful when storing a collection of polymorphic controls, because Any allows downcasting.

impl Send for WindowModal