Struct WindowHandle 

pub struct WindowHandle<V> { /* private fields */ }

A handle to a window with a specific root view type. Note that this does not keep the window alive on its own.

Implementations

impl<V> WindowHandle<V>

where V: 'static + Render,

pub fn new(id: WindowId) -> WindowHandle<V>

Creates a new handle from a window ID. This does not check if the root type of the window is V.

pub fn update<C, R>( &self, cx: &mut C, update: impl FnOnce(&mut V, &mut Window, &mut Context<'_, V>) -> R, ) -> Result<R, Error>

where C: AppContext,

Updates the root view of this window.

This will fail if the window has been closed or if the root view’s type does not match

pub fn read<'a>(&self, cx: &'a App) -> Result<&'a V, Error>

Read the root view out of this window.

This will fail if the window is closed or if the root view’s type does not match V.

pub fn read_with<C, R>( &self, cx: &C, read_with: impl FnOnce(&V, &App) -> R, ) -> Result<R, Error>

where C: AppContext,

Read the root view out of this window, with a callback

This will fail if the window is closed or if the root view’s type does not match V.

pub fn entity<C>(&self, cx: &C) -> Result<Entity<V>, Error>

where C: AppContext,

Read the root view pointer off of this window.

This will fail if the window is closed or if the root view’s type does not match V.

pub fn is_active(&self, cx: &mut App) -> Option<bool>

Check if this window is ‘active’.

Will return None if the window is closed or currently borrowed.

Methods from Deref<Target = AnyWindowHandle>

pub fn window_id(&self) -> WindowId

Get the ID of this window.

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

Returns the name of the window’s declared root entity type.

pub fn downcast<T>(&self) -> Option<WindowHandle<T>>

where T: 'static,

Attempt to convert this handle to a window handle with a specific root view type. If the types do not match, this will return None.

Trait Implementations

impl<V> Clone for WindowHandle<V>

fn clone(&self) -> WindowHandle<V>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<V> Copy for WindowHandle<V>

impl<V> Debug for WindowHandle<V>

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

Formats the value using the given formatter.

impl<V> Deref for WindowHandle<V>

type Target = AnyWindowHandle

The resulting type after dereferencing.

fn deref(&self) -> &<WindowHandle<V> as Deref>::Target

Dereferences the value.

impl<V> DerefMut for WindowHandle<V>

fn deref_mut(&mut self) -> &mut <WindowHandle<V> as Deref>::Target

Mutably dereferences the value.

impl<V> Eq for WindowHandle<V>

impl<V> From<WindowHandle<V>> for AnyWindowHandle

where V: 'static,

fn from(val: WindowHandle<V>) -> AnyWindowHandle

Converts to this type from the input type.

impl<V> Hash for WindowHandle<V>

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<V> PartialEq for WindowHandle<V>

fn eq(&self, other: &WindowHandle<V>) -> bool

Equality operator ==.

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

Inequality operator !=.