Trait PlatformWindowImplementation

pub trait PlatformWindowImplementation {
    // Required methods
    fn close(&mut self);
    fn winit(&self) -> Option<&Arc<Window>>;
    fn set_needs_redraw(&mut self);
    fn redraw_in(&mut self, duration: Duration);
    fn redraw_at(&mut self, moment: Instant);
    fn modifiers(&self) -> Modifiers;
    fn elapsed(&self) -> Duration;
    fn set_cursor(&mut self, cursor: Cursor);
    fn handle(&self, redraw_status: InvalidationStatus) -> WindowHandle;
    fn inner_size(&self) -> Size<UPx>;

    // Provided methods
    fn outer_position(&self) -> Point<Px> { ... }
    fn inner_position(&self) -> Point<Px> { ... }
    fn outer_size(&self) -> Size<UPx> { ... }
    fn is_resizable(&self) -> bool { ... }
    fn theme(&self) -> Theme { ... }
    fn request_inner_size(&mut self, inner_size: Size<UPx>) -> Option<Size<UPx>> { ... }
    fn set_ime_allowed(&self, allowed: bool) { ... }
    fn set_ime_location(&self, location: Rect<Px>) { ... }
    fn set_ime_purpose(&self, purpose: ImePurpose) { ... }
    fn set_min_inner_size(&self, min_size: Option<Size<UPx>>) { ... }
    fn set_max_inner_size(&self, max_size: Option<Size<UPx>>) { ... }
    fn redraw_when_changed(
        &self,
        value: &impl Trackable,
        invalidation_status: &InvalidationStatus,
    )
       where Self: Sized { ... }
}

A platform-dependent window implementation.

Required Methods

fn close(&mut self)

Marks the window to close as soon as possible.

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

Returns the underlying winit window, if one exists.

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_cursor(&mut self, cursor: Cursor)

Sets the current cursor icon to cursor.

fn handle(&self, redraw_status: InvalidationStatus) -> WindowHandle

Returns a handle for the window.

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

Returns the current inner size of the window.

Provided Methods

fn outer_position(&self) -> Point<Px>

Returns the current outer position of the window.

fn inner_position(&self) -> Point<Px>

Returns the current inner position of the window.

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

Returns the current outer size of the window.

fn is_resizable(&self) -> bool

Returns true if the window can have its size changed.

The provided implementation returns [winit::window::Window::is_resizable], or true if this window has no winit window.

fn theme(&self) -> Theme

Returns the underlying window theme.

The provided implementation returns [winit::window::Window::theme], or dark if this window has no winit window.

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

Requests that the window change its inner size.

The provided implementation forwards the request onto the winit window, if present.

The result is the same [winit::window::Window::request_inner_size] – if a size is returned, the change was made before the call returns, and no resized event will be emitted.

fn set_ime_allowed(&self, allowed: bool)

Sets whether [Ime] events should be enabled.

The provided implementation forwards the request onto the winit window, if present.

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

Sets the location of the cursor.

fn set_ime_purpose(&self, purpose: ImePurpose)

Sets the current [Ime] purpose.

The provided implementation forwards the request onto the winit window, if present.

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 redraw_when_changed( &self, value: &impl Trackable, invalidation_status: &InvalidationStatus, )

where Self: Sized,

Ensures that this window will be redrawn when value has been updated.

Implementations on Foreign Types

impl PlatformWindowImplementation for Window<'_, WindowCommand>

fn set_cursor(&mut self, cursor: Cursor)

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

fn close(&mut self)

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

fn set_needs_redraw(&mut self)

fn redraw_in(&mut self, duration: Duration)

fn redraw_at(&mut self, moment: Instant)

fn modifiers(&self) -> Modifiers

fn elapsed(&self) -> Duration

fn handle(&self, redraw_status: InvalidationStatus) -> WindowHandle

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

Implementors

impl PlatformWindowImplementation for &mut VirtualState