Struct Window 

pub struct Window { /* private fields */ }

Available on crate feature winio only.

A simple window.

Platform specific

• Qt: The desctruct order of Qt requires the window to be dropped last, and you should better put it at the end of the struct.

Implementations

impl Window

pub fn client_size(&self) -> Result<Size2D<f64, LogicalSpace>, Error>

The inner client size.

pub fn set_icon_by_id(&mut self, id: u16) -> Result<(), Error>

Available on Windows only.

Set window icon by resource ID.

pub fn style(&self) -> Result<u32, Error>

Available on win32 only.

Get window style.

pub fn set_style(&mut self, s: u32) -> Result<(), Error>

Available on win32 only.

Set window style.

pub fn ex_style(&self) -> Result<u32, Error>

Available on win32 only.

Get window extended style.

pub fn set_ex_style(&mut self, s: u32) -> Result<(), Error>

Available on win32 only.

Set window extended style.

pub fn backdrop(&self) -> Result<Backdrop, Error>

Available on Windows only.

Get the backdrop effect of the window.

Returns an error if the platform does not support it.

Platform specific

• Win32: Supported on Windows 11 22H2 and later; some controls might look weird.
• WinUI: Supported on 1.3 and later; the color of the title bar might be different from the client area.

pub fn set_backdrop(&mut self, backdrop: Backdrop) -> Result<(), Error>

Available on Windows only.

Set the backdrop effect of the window.

Trait Implementations

impl AsContainer for Window

fn as_container(&self) -> BorrowedContainer<'_>

Get the container handle.

impl AsWindow for Window

fn as_window(&self) -> BorrowedWindow<'_>

Get the window handle.

impl Component for Window

type Error = Error

The error type.

type Event = WindowEvent

The output event type to the parent.

type Init<'a> = ()

Initial parameter type.

type Message = WindowMessage

The input message type to update.

async fn init( _init: <Window as Component>::Init<'_>, _sender: &ComponentSender<Window>, ) -> Result<Window, Error>

Create the initial component.

async fn start(&mut self, sender: &ComponentSender<Window>) -> !

Start the event listening.

async fn update( &mut self, message: Self::Message, sender: &ComponentSender<Self>, ) -> Result<bool, Self::Error>

Respond to the message. Return true if need render.

fn render(&mut self, sender: &ComponentSender<Self>) -> Result<(), Self::Error>

Render the widgets.

async fn update_children(&mut self) -> Result<bool, Self::Error>

Update the children components. Return true if any child needs render.

fn render_children(&mut self) -> Result<(), Self::Error>

Render the children components. It will be called if any child or self needs render.

impl Debug for Window

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

Formats the value using the given formatter.

impl Failable for Window

type Error = Error

The error type associated.

impl Layoutable for Window

fn loc(&self) -> Result<Point2D<f64, LogicalSpace>, Error>

The left top location.

fn set_loc(&mut self, p: Point2D<f64, LogicalSpace>) -> Result<(), Error>

Move the location.

fn size(&self) -> Result<Size2D<f64, LogicalSpace>, Error>

The size.

fn set_size(&mut self, v: Size2D<f64, LogicalSpace>) -> Result<(), Error>

Resize.

fn rect(&self) -> Result<Rect<f64, LogicalSpace>, Self::Error>

The bounding rectangle.

fn set_rect(&mut self, r: Rect<f64, LogicalSpace>) -> Result<(), Self::Error>

Set the location and size.

fn preferred_size(&self) -> Result<Size2D<f64, LogicalSpace>, Self::Error>

The preferred size.

fn min_size(&self) -> Result<Size2D<f64, LogicalSpace>, Self::Error>

Min acceptable size.

impl TextWidget for Window

fn text(&self) -> Result<String, Error>

Get the text of the widget.

fn set_text(&mut self, s: impl AsRef<str>) -> Result<(), Error>

Set the text of the widget.

impl Visible for Window

fn is_visible(&self) -> Result<bool, Error>

If the widget is visible.

fn set_visible(&mut self, v: bool) -> Result<(), Error>

Set the visibility.

fn show(&mut self) -> Result<(), Self::Error>

Show the widget.

fn hide(&mut self) -> Result<(), Self::Error>

Hide the widget.