Struct Window

pub struct Window<TS: ThreadSafety> { /* private fields */ }

A window.

Implementations

impl<TS: ThreadSafety> Window<TS>

pub async fn new() -> Result<Window<TS>, OsError>

Create a new window.

pub fn window(&self) -> &Window

Get a reference to the underlying window.

pub fn id(&self) -> WindowId

Get the ID of the window.

pub fn scale_factor(&self) -> f64

Get the scale factor of the window.

pub fn request_redraw(&self)

Request a redraw.

impl<TS: ThreadSafety> Window<TS>

pub async fn inner_position( &self, ) -> Result<PhysicalPosition<i32>, NotSupportedError>

Get the inner position of the window.

pub async fn outer_position( &self, ) -> Result<PhysicalPosition<i32>, NotSupportedError>

Get the outer position of the window.

pub async fn set_outer_position(&self, position: impl Into<Position>)

Set the outer position of the window.

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

Get the inner size of the window.

pub async fn outer_size(&self) -> PhysicalSize<u32>

Get the outer size of the window.

pub async fn set_inner_size(&self, size: impl Into<Size>)

Set the inner size of the window.

pub async fn set_min_inner_size(&self, size: impl Into<Option<Size>>)

Set the minimum inner size of the window.

pub async fn set_max_inner_size(&self, size: impl Into<Option<Size>>)

Set the maximum inner size of the window.

pub async fn resize_increments(&self) -> Option<PhysicalSize<u32>>

Get the resize increments of the window.

pub async fn set_resize_increments(&self, size: impl Into<Option<Size>>)

Set the resize increments of the window.

pub async fn set_title(&self, title: impl Into<String>)

Set the title of the window.

pub async fn set_visible(&self, visible: bool)

Set whether the window is visible.

pub async fn is_visible(&self) -> Option<bool>

Get the window’s visibility.

pub async fn set_transparent(&self, transparent: bool)

Set the window’s transparency.

pub async fn set_resizable(&self, resizable: bool)

Set the window’s resizable property.

pub async fn is_resizable(&self) -> bool

Get the window’s resizable property.

pub async fn set_minimized(&self, minimized: bool)

Set the window’s minimization.

pub async fn is_minimized(&self) -> Option<bool>

Get the window’s minimization.

pub async fn set_maximized(&self, maximized: bool)

Set the window’s maximization.

pub async fn is_maximized(&self) -> bool

Get the window’s maximization.

pub async fn set_fullscreen(&self, fullscreen: Option<Fullscreen>)

Set the window’s fullscreen state.

pub async fn fullscreen(&self) -> Option<Fullscreen>

Get the fullscreen state of the window.

pub async fn set_decorations(&self, decorations: bool)

Set the window’s decorations.

pub async fn is_decorated(&self) -> bool

Get the window’s decorations.

pub async fn set_window_level(&self, level: WindowLevel)

Set the window level.

pub async fn set_window_icon(&self, icon: Option<Icon>)

Set the window icon.

pub async fn set_ime_position(&self, posn: impl Into<Position>)

Set the IME position.

pub async fn set_ime_allowed(&self, allowed: bool)

Set whether IME is allowed.

pub async fn set_ime_purpose(&self, purpose: ImePurpose)

Set the IME purpose.

pub async fn focus_window(&self)

Focus the window.

pub async fn is_focused(&self) -> bool

Tell whether the window is focused.

pub async fn request_user_attention( &self, request_type: Option<UserAttentionType>, )

Request the user’s attention.

pub async fn set_theme(&self, theme: Option<Theme>)

Set the window’s theme.

pub async fn theme(&self) -> Option<Theme>

Get the window’s theme.

pub async fn set_content_protected(&self, protected: bool)

Set the window’s protected content.

pub async fn title(&self) -> String

Get the title of the window.

pub async fn set_cursor_icon(&self, icon: CursorIcon)

Set the cursor icon.

pub async fn set_cursor_position( &self, posn: impl Into<Position>, ) -> Result<(), ExternalError>

Set the cursor position.

pub async fn set_cursor_grab( &self, mode: CursorGrabMode, ) -> Result<(), ExternalError>

Set the cursor’s grab mode.

pub async fn set_cursor_visible(&self, visible: bool)

Set the cursor’s visibility.

pub async fn drag_window(&self) -> Result<(), ExternalError>

Drag the window.

pub async fn drag_resize_window( &self, direction: ResizeDirection, ) -> Result<(), ExternalError>

Drag-resize the window.

pub async fn set_cursor_hittest( &self, hit_test: bool, ) -> Result<(), ExternalError>

Set the cursor hit test.

pub async fn current_monitor(&self) -> Option<MonitorHandle>

Get the current monitor of this window.

impl<TS: ThreadSafety> Window<TS>

Waiting for events.

pub fn redraw_requested(&self) -> &Handler<(), TS>

Get the handler for the RedrawRequested event.

pub fn close_requested(&self) -> &Handler<(), TS>

Get the handler for the CloseRequested event.

pub fn resized(&self) -> &Handler<PhysicalSize<u32>, TS>

Get the handler for the Resized event.

pub fn moved(&self) -> &Handler<PhysicalPosition<i32>, TS>

Get the handler for the Moved event.

pub fn destroyed(&self) -> &Handler<(), TS>

Get handler for the Destroyed event.

pub fn focused(&self) -> &Handler<bool, TS>

Get the handler for the Focused event.

pub fn keyboard_input(&self) -> &Handler<KeyboardInput, TS>

Get the handler for the KeyboardInput event.

pub fn modifiers_changed(&self) -> &Handler<ModifiersState, TS>

Get the handler for the ModifiersChanged event.

pub fn received_character(&self) -> &Handler<char, TS>

Get the handler for the ReceivedCharacter event.

pub fn ime(&self) -> &Handler<Ime, TS>

Get the handler for the Ime event.

pub fn cursor_moved(&self) -> &Handler<CursorMoved, TS>

Get the handler for the CursorMoved event.

pub fn cursor_entered(&self) -> &Handler<DeviceId, TS>

Get the handler for the CursorEntered event.

pub fn cursor_left(&self) -> &Handler<DeviceId, TS>

Get the handler for the CursorLeft event.

pub fn mouse_wheel(&self) -> &Handler<MouseWheel, TS>

Get the handle for the MouseWheel event.

pub fn mouse_input(&self) -> &Handler<MouseInput, TS>

Get the handle for the MouseInput event.

pub fn touchpad_magnify(&self) -> &Handler<TouchpadMagnify, TS>

Get the handle for the TouchpadMagnify event.

pub fn touchpad_pressure(&self) -> &Handler<TouchpadPressure, TS>

Get the handle for the TouchpadPressure event.

pub fn touch(&self) -> &Handler<Touch, TS>

Get the handle for the Touch event.

pub fn scale_factor_changed(&self) -> &Handler<ScaleFactor, TS>

Get the handle for the ScaleFactorChanged event.

pub fn touchpad_rotate(&self) -> &Handler<TouchpadRotate, TS>

Get the handle for the TouchpadRotate event.

pub fn smart_magnify(&self) -> &Handler<DeviceId, TS>

Get the handle for the SmartMagnify event.

pub fn axis_motion(&self) -> &Handler<AxisMotion, TS>

Get the handle for the AxisMotion event.

pub fn theme_changed(&self) -> &Handler<Theme, TS>

Get the handle for the ThemeChanged event.

pub fn occluded(&self) -> &Handler<bool, TS>

Get the handle for the Occulded event.

Trait Implementations

impl<TS: Clone + ThreadSafety> Clone for Window<TS>

where TS::Rc<Window>: Clone, TS::Rc<Registration<TS>>: Clone, TS::Rc<Reactor<TS>>: Clone,

fn clone(&self) -> Window<TS>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<TS: ThreadSafety> Drop for Window<TS>

fn drop(&mut self)

Executes the destructor for this type.

impl<TS: ThreadSafety> HasRawDisplayHandle for Window<TS>

fn raw_display_handle(&self) -> RawDisplayHandle

impl<TS: ThreadSafety> HasRawWindowHandle for Window<TS>

fn raw_window_handle(&self) -> RawWindowHandle

impl<TS: ThreadSafety> WindowExtWayland for Window<TS>

fn wayland_surface(&self) -> Option<*mut c_void>

Returns a pointer to the wl_surface object of wayland that is used by this window.

fn wayland_display(&self) -> Option<*mut c_void>

Returns a pointer to the wl_display object of wayland that is used by this window.

impl<TS: ThreadSafety> WindowExtX11 for Window<TS>

fn xcb_connection(&self) -> Option<*mut c_void>

This function returns the underlying xcb_connection_t of an xlib Display.

fn xlib_display(&self) -> Option<*mut c_void>

Returns a pointer to the Display object of xlib that is used by this window.

fn xlib_screen_id(&self) -> Option<c_int>

fn xlib_window(&self) -> Option<c_ulong>

Returns the ID of the Window xlib object that is used by this window.