Struct winmsg_executor::util::Window

pub struct Window<S> { /* private fields */ }

Owned window handle. Dropping the handle destroys the window.

Implementations

impl<S> Window<S>

pub fn new<F>( message_only: bool, shared_state: S, wndproc: F, ) -> Result<Self, WindowCreationError>

where F: FnMut(&S, WindowMessage) -> Option<LRESULT> + 'static,

Creates a new window with a wndproc closure.

The shared_state parameter will be allocated alongside closure with a 'static lifetime. Allows for convenient access to variables from both inside and outside of the closure without an extra Rc<State>. Use the Window::shared_state() method to access the state from the outside.

Message-Only Windows are useful for windows that do not need to be visible nor need access to broadcast messages from the desktop.

Internally uses a RefCell for the closure to prevent it from being re-entered by nested message loops (e.g. from modal dialogs). Forwards nested messages to the default wndproc procudere. If you required more control for those scenarios use Window::new_reentrant().

pub fn new_reentrant<F>( message_only: bool, shared_state: S, wndproc: F, ) -> Result<Self, WindowCreationError>

where F: Fn(&S, WindowMessage) -> Option<LRESULT> + 'static,

Same as Window::new() but allows the closure to be re-entered.

pub fn hwnd(&self) -> HWND

Returns this windows raw window handle.

pub fn shared_state(&self) -> &S

Returns a reference to the state shared with the wndproc closure.

Trait Implementations

impl<S: Debug> Debug for Window<S>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<S> Drop for Window<S>

fn drop(&mut self)

Executes the destructor for this type.