Struct appit::RunningWindow

source ·
pub struct RunningWindow<AppMessage>
where AppMessage: Message,
{ /* private fields */ }
Expand description

A window that is running in its own thread.

Implementations§

source§

impl<AppMessage> RunningWindow<AppMessage>
where AppMessage: Message,

source

pub fn winit(&self) -> &Window

Returns a reference to the underlying window.

source

pub fn handle(&self) -> Window<AppMessage::Window>

Returns a handle to this window.

source

pub const fn next_redraw_target(&self) -> Option<RedrawTarget>

Returns the target for when the window will be redrawn.

source

pub fn set_needs_redraw(&mut self)

Sets the window to redraw as soon as it can.

source

pub fn redraw_at(&mut self, instant: Instant)

Sets the window to redraw at the provided time.

If the window is already set to redraw sooner, this function does nothing.

source

pub fn redraw_in(&mut self, duration: Duration)

Sets the window to redraw after a duration.

If the window is already set to redraw sooner, this function does nothing.

source

pub fn title(&self) -> String

Returns the current title of the window.

source

pub fn set_title(&self, new_title: &str)

Sets the window’s title to new_title.

source

pub fn set_min_inner_size(&self, min_size: Option<PhysicalSize<u32>>)

Sets the window’s minimum inner size.

source

pub fn set_max_inner_size(&self, max_size: Option<PhysicalSize<u32>>)

Sets the window’s maximum inner size.

source

pub const fn inner_size(&self) -> PhysicalSize<u32>

Returns the current size of the interior of the window, in pixels.

source

pub fn set_inner_size(&self, new_size: PhysicalSize<u32>)

Sets the inner size of the window, in pixels.

source

pub const fn position(&self) -> PhysicalPosition<i32>

Returns the current locpositionation of the window, in pixels.

source

pub fn set_position(&self, new_position: PhysicalPosition<i32>)

Sets the current position of the window, in pixels.

source

pub const fn cursor_position(&self) -> Option<PhysicalPosition<f64>>

Returns the position of the cursor relative to the window’s upper-left corner, in pixels.

source

pub const fn scale(&self) -> f64

Returns the current scale factor for the window.

source

pub const fn occluded(&self) -> bool

Returns true if the window is currently invisible, hidden behind other windows, minimized, or otherwise hidden from the user’s view.

source

pub const fn focused(&self) -> bool

Returns true if the window is currently focused for keyboard input.

source

pub const fn theme(&self) -> Theme

Returns the current theme of the window.

source

pub const fn modifiers(&self) -> Modifiers

Returns the current state of the keyboard modifier keys.

source

pub fn close(&mut self)

Sets this window to close as soon as possible.

source

pub fn pressed_keys(&self) -> impl Iterator<Item = PhysicalKey> + '_

Returns an iterator of the currently pressed keys.

This iterator does not guarantee any specific order.

source

pub fn key_pressed(&self, key: &PhysicalKey) -> bool

Returns true if the given key code is currently pressed.

source

pub fn pressed_mouse_buttons(&self) -> impl Iterator<Item = MouseButton> + '_

Returns an iterator of the currently pressed mouse buttons.

This iterator does not guarantee any specific order.

source

pub fn mouse_button_pressed(&self, button: &MouseButton) -> bool

Returns true if the button is currently pressed.

Trait Implementations§

source§

impl<AppMessage> Application<AppMessage> for RunningWindow<AppMessage>
where AppMessage: Message,

source§

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

Returns a handle to the running application.
source§

fn send( &mut self, message: AppMessage ) -> Option<<AppMessage as Message>::Response>

Sends an app message to the main event loop to be handled by the callback provided when the app was created. Read more

Auto Trait Implementations§

§

impl<AppMessage> Freeze for RunningWindow<AppMessage>

§

impl<AppMessage> !RefUnwindSafe for RunningWindow<AppMessage>

§

impl<AppMessage> Send for RunningWindow<AppMessage>

§

impl<AppMessage> !Sync for RunningWindow<AppMessage>

§

impl<AppMessage> Unpin for RunningWindow<AppMessage>

§

impl<AppMessage> !UnwindSafe for RunningWindow<AppMessage>

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, AppMessage> AsApplication<AppMessage> for T
where T: Application<AppMessage>, AppMessage: Message,

source§

fn as_application(&self) -> &dyn Application<AppMessage>
where AppMessage: Message,

Returns this type’s application.
source§

fn as_application_mut(&mut self) -> &mut dyn Application<AppMessage>
where AppMessage: Message,

Returns this type’s application.
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> Downcast for T
where T: Any,

source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

§

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.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more