Struct native_windows_gui::Notice

pub struct Notice {
    pub handle: ControlHandle,
}

An invisible component that can be triggered by other thread.

A notice object does not send data between threads. Rust has already plenty of way to do this. The notice object only serve to "wake up" the GUI thread.

A notice must have a parent window. If the parent is destroyed before the notice, the notice becomes invalid.

Requires the notice feature.

Example

use native_windows_gui as nwg;
fn build_notice(notice: &mut nwg::Notice, window: &nwg::Window) {
    nwg::Notice::builder()
        .parent(window)
        .build(notice);
}

use native_windows_gui as nwg;
use std::thread;
use std::time;

fn notice(noticer: &nwg::Notice) {
    let sender = noticer.sender();
    
    thread::spawn(move || {
        thread::sleep(time::Duration::new(5, 0));
        sender.notice();
    });
}

Fields

handle: ControlHandle

Implementations

impl Notice

pub fn builder() -> NoticeBuilder

pub fn create<C: Into<ControlHandle>>(parent: C) -> Result<Notice, NwgError>

A shortcut over the builder API for the notice object

pub fn valid(&self) -> bool

Checks if the notice is still usable. A notice becomes unusable when the parent window is destroyed. This will also return false if the notice is not initialized.

pub fn window_handle(&self) -> Option<ControlHandle>

Return an handle to the notice window or None if the window was destroyed.

pub fn set_window_handle<C: Into<ControlHandle>>(&mut self, window: C)

Change the parent window of the notice. This won't update the NoticeSender already created. Panics if the control is not a window-like control or if the notice was not initialized

pub fn sender(&self) -> NoticeSender

Create a new NoticeSender bound to this Notice

Trait Implementations

impl Default for Notice

pub fn default() -> Notice

Returns the "default value" for a type.

impl Drop for Notice

pub fn drop(&mut self)

Executes the destructor for this type.

impl Eq for Notice

impl From<&'_ Notice> for ControlHandle

pub fn from(control: &Notice) -> Self

Performs the conversion.

impl PartialEq<ControlHandle> for Notice

pub fn eq(&self, other: &ControlHandle) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Notice> for Notice

pub fn eq(&self, other: &Notice) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &Notice) -> bool

This method tests for !=.

impl PartialEq<Notice> for ControlHandle

pub fn eq(&self, other: &Notice) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl StructuralEq for Notice

impl StructuralPartialEq for Notice