Skip to main content

WindowHandle

Struct WindowHandle 

Source
pub struct WindowHandle { /* private fields */ }
Expand description

Sendable handle that queues commands and wakes the native UI loop.

Implementations§

Source§

impl WindowHandle

Source

pub fn set_wakeup<F>(&self, wakeup: F)
where F: Fn() + Send + Sync + 'static,

Install the backend wakeup callback.

Installing a callback while commands are queued schedules one wakeup. The callback is always invoked after releasing the queue lock.

Source

pub fn drain_commands(&self) -> Vec<WindowCommand>

Drain queued commands on the UI thread.

Source

pub fn send(&self, command: WindowCommand) -> Result<(), WindowCommandError>

Queue a native command.

Success means the command was accepted into the bounded queue, not that the native UI thread has already applied it.

Source

pub fn set_title( &self, title: impl Into<String>, ) -> Result<(), WindowCommandError>

Queue title update.

Source

pub fn set_background(&self, color: Rgba) -> Result<(), WindowCommandError>

Queue a native and document background update without changing the bundle manifest.

Source

pub fn set_size( &self, width: u32, height: u32, ) -> Result<(), WindowCommandError>

Queue size update.

Source

pub fn minimize(&self) -> Result<(), WindowCommandError>

Queue minimization.

Source

pub fn maximize(&self) -> Result<(), WindowCommandError>

Queue maximization.

Source

pub fn unmaximize(&self) -> Result<(), WindowCommandError>

Queue unmaximization.

Source

pub fn fullscreen(&self, value: bool) -> Result<(), WindowCommandError>

Queue fullscreen change.

Source

pub fn center(&self) -> Result<(), WindowCommandError>

Queue centering.

Source

pub fn focus(&self) -> Result<(), WindowCommandError>

Queue focus.

Source

pub fn request_close(&self) -> Result<(), WindowCommandError>

Queue a native close request.

Source

pub fn start_drag(&self) -> Result<(), WindowCommandError>

Queue native drag.

Source

pub fn set_always_on_top(&self, value: bool) -> Result<(), WindowCommandError>

Queue always-on-top change.

Trait Implementations§

Source§

impl Clone for WindowHandle

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Default for WindowHandle

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.