Struct winsafe::gui::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(parent: &impl GuiParent, opts: WindowModalOpts) -> Self

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

pub fn new_dlg(parent: &impl GuiParent, dialog_id: u16) -> Self

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

pub fn show_modal(&self) -> AnyResult<i32>

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

For a modal created with WindowModal::new, the returned i32 is always zero.

For a modal created with WindowModal::new_dlg, the returned i32 is the value passed to HWND::EndDialog. 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.

Trait Implementations

impl Clone for WindowModal

fn clone(&self) -> WindowModal

Returns a copy of the value.

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_new_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 GuiParentPopup for WindowModal

fn close(&self)

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

impl GuiWindow for WindowModal

fn hwnd(&self) -> &HWND

Returns the underlying handle for this control.

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 GuiWindowText for WindowModal

fn set_text(&self, text: &str)

Sets the text by calling HWND::SetWindowText.

fn text(&self) -> String

Retrieves the text by calling HWND::GetWindowText.

impl Send for WindowModal