Struct Window 

pub struct Window<WST = ()> { /* private fields */ }

Available on crate feature ui only.

A window based on a WindowClass.

Multithreading

Window is not Send because the window procedure and window destruction calls must only be called from the creating thread.

Implementations

impl<WST: WindowSubtype> Window<WST>

pub fn as_handle(&self) -> WindowHandle

pub fn set_listener<WML>(&mut self, listener: WML) -> Result<()>

where WML: FnMut(&ListenerMessage) -> ListenerAnswer + 'static,

Changes the user window message listener.

pub fn set_menu(&mut self, menu: Option<&MenuBar>) -> Result<()>

Sets or removes the top menu bar.

pub fn add_notification_icon( &mut self, options: NotificationIconOptions, ) -> Result<&mut NotificationIcon>

Adds a new notification icon.

Panics

Will panic if the notification icon ID already exists.

pub fn get_notification_icon(&self, id: NotificationIconId) -> &NotificationIcon

Returns a reference to a previously added notification icon.

Panics

Will panic if the ID doesn’t exist.

pub fn get_notification_icon_mut( &mut self, id: NotificationIconId, ) -> &mut NotificationIcon

Returns a mutable reference to a previously added notification icon.

Panics

Will panic if the ID doesn’t exist.

pub fn remove_notification_icon(&mut self, id: NotificationIconId)

Removes a notification icon.

Panics

Will panic if the ID doesn’t exist.

impl Window<()>

pub fn new<WML, PST>( class: Rc<WindowClass>, listener: Option<WML>, caption_text: &str, appearance: WindowAppearance, parent: Option<Rc<RefCell<Window<PST>>>>, ) -> Result<Self>

where WML: FnMut(&ListenerMessage) -> ListenerAnswer + 'static, PST: WindowSubtype,

Creates a new window.

User interaction with the window will result in messages sent to the window message listener provided here.

Generics

Note that you can use DefaultWmlType for the WML type parameter when not providing a listener.

impl Window<Layered>

pub fn new_layered<WML, PST>( class: Rc<WindowClass>, listener: Option<WML>, caption_text: &str, appearance: WindowAppearance, parent: Option<Rc<RefCell<Window<PST>>>>, ) -> Result<Self>

where WML: FnMut(&ListenerMessage) -> ListenerAnswer + 'static, PST: WindowSubtype,

Creates a new layered window.

This is analogous to Window::new.

pub fn set_layered_opacity_alpha(&self, alpha: u8) -> Result<()>

Sets the opacity value for a layered window.

impl Window<Magnifier>

pub fn new_magnifier( caption_text: &str, appearance: WindowAppearance, parent: Rc<RefCell<Window<Layered>>>, ) -> Result<Self>

pub fn set_magnification_factor(&self, mag_factor: f32) -> Result<()>

pub fn set_magnification_source(&self, source: Rectangle) -> Result<()>

pub fn set_lens_use_bitmap_smoothing(&self, use_smoothing: bool) -> Result<()>

Trait Implementations

impl<WST> Deref for Window<WST>

type Target = WindowHandle

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<WST> Drop for Window<WST>

fn drop(&mut self)

Executes the destructor for this type.