Struct MockWindow 

pub struct MockWindow { /* private fields */ }

A mock window implementation for headless testing.

This struct implements the winit::window::Window trait with stub implementations that are suitable for testing without a real window system.

Implementations

impl MockWindow

pub fn new() -> Self

Create a new mock window with default settings.

pub fn with_size(width: u32, height: u32) -> Self

Create a new mock window with the given size.

pub fn set_scale_factor(&mut self, scale: f64)

Set the scale factor for this mock window.

Trait Implementations

impl Debug for MockWindow

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

Formats the value using the given formatter.

impl Default for MockWindow

fn default() -> Self

Returns the “default value” for a type.

impl Window for MockWindow

fn id(&self) -> WindowId

Returns an identifier unique to the window.

fn scale_factor(&self) -> f64

Returns the scale factor that can be used to map logical pixels to physical pixels, and vice versa.

fn request_redraw(&self)

Queues a WindowEvent::RedrawRequested event to be emitted that aligns with the windowing system drawing loop.

fn pre_present_notify(&self)

Notify the windowing system before presenting to the window.

fn reset_dead_keys(&self)

Reset the dead key state of the keyboard.

fn surface_position(&self) -> PhysicalPosition<i32>

The position of the top-left hand corner of the surface relative to the top-left hand corner of the window.

fn outer_position(&self) -> Result<PhysicalPosition<i32>, RequestError>

The position of the top-left hand corner of the window relative to the top-left hand corner of the desktop.

fn set_outer_position(&self, _position: Position)

Sets the position of the window on the desktop.

fn surface_size(&self) -> PhysicalSize<u32>

Returns the size of the window’s render-able surface.

fn request_surface_size(&self, _size: Size) -> Option<PhysicalSize<u32>>

Request the new size for the surface.

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

Returns the size of the entire window.

fn safe_area(&self) -> PhysicalInsets<u32>

The inset area of the surface that is unobstructed.

fn set_min_surface_size(&self, _min_size: Option<Size>)

Sets a minimum dimensions of the window’s surface.

fn set_max_surface_size(&self, _max_size: Option<Size>)

Sets a maximum dimensions of the window’s surface.

fn surface_resize_increments(&self) -> Option<PhysicalSize<u32>>

Returns surface resize increments if any were set.

fn set_surface_resize_increments(&self, _increments: Option<Size>)

Sets resize increments of the surface.

fn set_title(&self, _title: &str)

Modifies the title of the window.

fn set_transparent(&self, _transparent: bool)

Change the window transparency state.

fn set_blur(&self, _blur: bool)

Change the window blur state.

fn set_visible(&self, _visible: bool)

Modifies the window’s visibility.

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

Gets the window’s current visibility state.

fn set_resizable(&self, _resizable: bool)

Sets whether the window is resizable or not.

fn is_resizable(&self) -> bool

Gets the window’s current resizable state.

fn set_enabled_buttons(&self, _buttons: WindowButtons)

Sets the enabled window buttons.

fn enabled_buttons(&self) -> WindowButtons

Gets the enabled window buttons.

fn set_minimized(&self, _minimized: bool)

Minimize the window, or put it back from the minimized state.

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

Gets the window’s current minimized state.

fn set_maximized(&self, _maximized: bool)

Sets the window to maximized or back.

fn is_maximized(&self) -> bool

Gets the window’s current maximized state.

fn set_fullscreen(&self, _fullscreen: Option<Fullscreen>)

Set the window’s fullscreen state.

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

Gets the window’s current fullscreen state.

fn set_decorations(&self, _decorations: bool)

Turn window decorations on or off.

fn is_decorated(&self) -> bool

Gets the window’s current decorations state.

fn set_window_level(&self, _level: WindowLevel)

Change the window level.

fn set_window_icon(&self, _window_icon: Option<Icon>)

Sets the window icon.

fn request_ime_update( &self, _request: ImeRequest, ) -> Result<(), ImeRequestError>

Atomically apply request to IME.

fn ime_capabilities(&self) -> Option<ImeCapabilities>

Return enabled by the client ImeCapabilities for this window.

fn focus_window(&self)

Brings the window to the front and sets input focus. Has no effect if the window is already in focus, minimized, or not visible.

fn has_focus(&self) -> bool

Gets whether the window has keyboard focus.

fn request_user_attention(&self, _request_type: Option<UserAttentionType>)

Requests user attention to the window, this has no effect if the application is already focused. How requesting for user attention manifests is platform dependent, see UserAttentionType for details.

fn set_theme(&self, _theme: Option<Theme>)

Set or override the window theme.

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

Returns the current window theme.

fn set_content_protected(&self, _protected: bool)

Prevents the window contents from being captured by other apps.

fn title(&self) -> String

Gets the current title of the window.

fn set_cursor(&self, _cursor: Cursor)

Modifies the cursor icon of the window.

fn set_cursor_position(&self, _position: Position) -> Result<(), RequestError>

Changes the position of the cursor in window coordinates.

fn set_cursor_grab(&self, _mode: CursorGrabMode) -> Result<(), RequestError>

Set grabbing mode on the cursor preventing it from leaving the window.

fn set_cursor_visible(&self, _visible: bool)

Modifies the cursor’s visibility.

fn drag_window(&self) -> Result<(), RequestError>

Moves the window with the left mouse button until the button is released.

fn drag_resize_window( &self, _direction: ResizeDirection, ) -> Result<(), RequestError>

Resizes the window with the left mouse button until the button is released.

fn show_window_menu(&self, _position: Position)

Show window menu at a specified position in surface coordinates.

fn set_cursor_hittest(&self, _hittest: bool) -> Result<(), RequestError>

Modifies whether the window catches cursor events.

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

Returns the monitor on which the window currently resides.

fn available_monitors(&self) -> Box<dyn Iterator<Item = MonitorHandle>>

Returns the list of all the monitors available on the system.

fn primary_monitor(&self) -> Option<MonitorHandle>

Returns the primary monitor of the system.

fn rwh_06_display_handle(&self) -> &dyn HasDisplayHandle

Get the raw-window-handle v0.6 display handle.

fn rwh_06_window_handle(&self) -> &dyn HasWindowHandle

Get the raw-window-handle v0.6 window handle.

fn set_ime_cursor_area(&self, position: Position, size: Size)

👎Deprecated: use Window::request_ime_update instead

Set the IME cursor editing area, where the position is the top left corner of that area in surface coordinates and size is the size of this area starting from the position. An example of such area could be a input field in the UI or line in the editor.

fn set_ime_allowed(&self, allowed: bool)

👎Deprecated: use Window::request_ime_update instead

Sets whether the window should get IME events

fn set_ime_purpose(&self, purpose: ImePurpose)

👎Deprecated: use Window::request_ime_update instead

Sets the IME purpose for the window using ImePurpose.