Struct RunningWindow

pub struct RunningWindow<W> { /* private fields */ }

A currently running Cushy window.

Implementations

impl<W> RunningWindow<W>

where W: PlatformWindowImplementation,

pub const fn kludgine_id(&self) -> KludgineId

Returns the [KludgineId] of this window.

Each window has its own unique KludgineId.

pub const fn focused(&self) -> &Dynamic<bool>

Returns a dynamic that is updated whenever this window’s focus status changes.

pub const fn occluded(&self) -> &Dynamic<bool>

Returns a dynamic that is updated whenever this window’s occlusion status changes.

pub fn request_close(&self)

Request that the window closes.

A window may disallow itself from being closed by customizing WindowBehavior::close_requested.

pub fn handle(&self) -> WindowHandle

Returns a handle to this window.

pub const fn inner_size(&self) -> &Dynamic<Size<UPx>>

Returns a dynamic that is synchronized with this window’s inner size.

Whenever the window is resized, this dynamic will be updated with the new inner size. Setting a new value will request the new size from the operating system, but resize requests may be altered or ignored by the operating system.

pub fn clipboard_guard(&self) -> Option<MutexGuard<'_, Clipboard>>

Returns a locked mutex guard to the OS’s clipboard, if one was able to be initialized when the window opened.

Trait Implementations

impl<W> Deref for RunningWindow<W>

where W: PlatformWindowImplementation + 'static,

type Target = dyn PlatformWindowImplementation

The resulting type after dereferencing.

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

Dereferences the value.

impl<W> DerefMut for RunningWindow<W>

where W: PlatformWindowImplementation + 'static,

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<W> PlatformWindow for RunningWindow<W>

where W: PlatformWindowImplementation,

fn close(&mut self)

Marks the window to close as soon as possible.

fn handle(&self) -> WindowHandle

Returns a handle for the window.

fn kludgine_id(&self) -> KludgineId

Returns the unique id of the [Kludgine] instance used by this window.

fn app(&self) -> Option<&App>

Returns the app managing this window’s event loop.

fn focused(&self) -> &Dynamic<bool>

Returns the dynamic that is synchronized with the window’s focus.

fn occluded(&self) -> &Dynamic<bool>

Returns the dynamic that is synchronized with the window’s occlusion status.

fn inner_size(&self) -> &Dynamic<Size<UPx>>

Returns the current inner size of the window.

fn outer_size(&self) -> Size<UPx>

Returns the current outer size of the window.

fn cushy(&self) -> &Cushy

Returns the shared application resources.

fn set_needs_redraw(&mut self)

Sets the window to redraw as soon as possible.

fn redraw_in(&mut self, duration: Duration)

Sets the window to redraw after a duration.

fn redraw_at(&mut self, moment: Instant)

Sets the window to redraw at a specified instant.

fn modifiers(&self) -> Modifiers

Returns the current keyboard modifiers.

fn elapsed(&self) -> Duration

Returns the amount of time that has elapsed since the last redraw.

fn set_ime_allowed(&self, allowed: bool)

Sets whether [Ime] events should be enabled.

fn set_ime_purpose(&self, purpose: ImePurpose)

Sets the current [Ime] purpose.

fn set_cursor(&mut self, cursor: Cursor)

Sets the current cursor icon to cursor.

fn set_min_inner_size(&self, min_size: Option<Size<UPx>>)

Sets the window’s minimum inner size.

fn set_max_inner_size(&self, max_size: Option<Size<UPx>>)

Sets the window’s maximum inner size.

fn request_inner_size(&mut self, inner_size: Size<UPx>) -> Option<Size<UPx>>

Requests that the window change its inner size.

fn set_ime_location(&self, location: Rect<Px>)

Sets the location of the cursor.

fn winit(&self) -> Option<&Arc<Window>>

Returns a handle to the underlying winit window, if available.