Struct native_windows_gui::Window

pub struct Window {
    pub handle: ControlHandle,
}

A basic top level window. At least one top level window is required to make a NWG application.

Windows can be heavily customized using the window flags. If your application don’t need a visible window (ex: a system tray app), use MessageWindow instead.

Builder parameters:

• flags: The window flags. See WindowFlags
• ex_flags: A combination of win32 window extended flags. Unlike flags, ex_flags must be used straight from winapi
• title: The text in the window title bar
• size: The default size of the window
• position: The default position of the window in the desktop
• icon: The window icon
• accept_file: If the window should accept files by drag & drop
• maximized: If the window should be maximized at creation
• minimized: If the window should be minimized at creation
• center: Center the window in the current monitor based on its size. If true, this overrides position
• topmost: If the window should always be on top of other system window
• parent: Logical parent of the window, unlike children controls, this is NOT required.

Control events:

• OnInit: The window was created
• MousePress(_): Generic mouse press events on the button
• OnMouseMove: Generic mouse mouse event
• OnMouseWheel: Generic mouse wheel event
• OnPaint: Generic on paint event
• OnKeyPress: Generic key press
• OnKeyRelease: Generic ket release
• OnResize: When the window is resized
• OnResizeBegin: Just before the window begins being resized by the user
• OnResizeEnd: Just after the user stops resizing the window
• OnWindowMaximize: When the window is maximized
• OnWindowMinimize: When the window is minimized
• OnMove: When the window is moved by the user
• OnFileDrop: When a file is dropped in the window (only raised if accept_file is set)
• OnMinMaxInfo: When the size or position of the window is about to change and the size of the windows must be restricted

Fields

handle: ControlHandle

Implementations

impl Window

pub fn builder<'a>() -> WindowBuilder<'a>

pub fn maximize(&self)

Maximize the window

pub fn minimize(&self)

Minimize the window

pub fn restore(&self)

Restore a minimized/maximized window

pub fn invalidate(&self)

Force the window to refraw iteself and all its children

pub fn close(&self)

Close the window as if the user clicked the X button.

pub fn icon(&self) -> Option<Icon>

Return the icon of the window

pub fn set_icon(&self, icon: Option<&Icon>)

Set the icon in the window

• icon: The new icon. If None, the icon is removed

pub fn focus(&self) -> bool

Return true if the control currently has the keyboard focus

pub fn set_focus(&self)

Set the keyboard focus on the button

pub fn enabled(&self) -> bool

Return true if the control user can interact with the control, return false otherwise

pub fn set_enabled(&self, v: bool)

Enable or disable the control

pub fn visible(&self) -> bool

Return true if the control is visible to the user. Will return true even if the control is outside of the parent client view (ex: at the position (10000, 10000))

pub fn set_visible(&self, v: bool)

Show or hide the control to the user

pub fn size(&self) -> (u32, u32)

Return the size of the button in the parent window

pub fn set_size(&self, x: u32, y: u32)

Set the size of the button in the parent window

pub fn position(&self) -> (i32, i32)

Return the position of the button in the parent window

pub fn set_position(&self, x: i32, y: i32)

Set the position of the button in the parent window

pub fn text(&self) -> String

Return window title

pub fn set_text<'a>(&self, v: &'a str)

Set the window title

pub fn class_name(&self) -> &'static str

Winapi class name used during control creation

pub fn flags(&self) -> u32

pub fn forced_flags(&self) -> u32

Winapi flags required by the control

Trait Implementations

impl Default for Window

fn default() -> Window

Returns the “default value” for a type.

impl Drop for Window

fn drop(&mut self)

Executes the destructor for this type.

impl From<&Window> for ControlHandle

fn from(control: &Window) -> Self

Converts to this type from the input type.

impl From<&mut Window> for ControlHandle

fn from(control: &mut Window) -> Self

Converts to this type from the input type.

impl PartialEq<ControlHandle> for Window

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Window> for ControlHandle

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Window> for Window

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Window

impl StructuralEq for Window

impl StructuralPartialEq for Window