Struct WindowId

pub struct WindowId(/* private fields */);

Identifier of a window. Unique for each window.

Can be obtained with window.id().

Whenever you receive an event specific to a window, this event contains a WindowId which you can then compare to the ids of your windows.

Implementations

impl WindowId

pub const unsafe fn dummy() -> WindowId

Returns a dummy id, useful for unit testing.

Safety

The only guarantee made about the return value of this function is that it will always be equal to itself and to future values returned by this function. No other guarantees are made. This may be equal to a real WindowId.

Passing this into a winit function will result in undefined behavior.

Trait Implementations

impl Clone for WindowId

fn clone(&self) -> WindowId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WindowId

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

Formats the value using the given formatter.

impl From<u64> for WindowId

fn from(raw_id: u64) -> WindowId

Converts to this type from the input type.

impl Hash for WindowId

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for WindowId

fn cmp(&self, other: &WindowId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for WindowId

fn eq(&self, other: &WindowId) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for WindowId

fn partial_cmp(&self, other: &WindowId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl WindowIdExt for WindowId

fn bounds_on_screen_including_frame(&self) -> Option<Rect>

Get the bounds of the content of this window, including titlebar and native window borders.

fn bounds_of_content_on_screen(&self) -> Option<Rect>

Get the bounds of the content of this window, excluding titlebar and native window borders.

fn position_on_screen_including_frame(&self) -> Option<Point>

Get the location of the window including any OS titlebar.

fn position_of_content_on_screen(&self) -> Option<Point>

Get the location of the window’s content on the monitor where it currently resides, excluding any OS titlebar.

fn monitor_bounds(&self) -> Option<Rect>

Get the logical bounds of the monitor this window is on.

fn is_visible(&self) -> bool

Determine if this window is currently visible. Note that if a call to set a window visible which is invisible has happened within the current event loop cycle, the state returned will not reflect that.

fn is_minimized(&self) -> bool

Determine if this window is currently minimized. Note that if a call to minimize or unminimize this window, and it is currently in the opposite state, has happened the current event loop cycle, the state returned will not reflect that.

fn is_maximized(&self) -> bool

Determine if this window is currently maximize. Note that if a call to maximize or unmaximize this window, and it is currently in the opposite state, has happened the current event loop cycle, the state returned will not reflect that.

fn is_document_edited(&self) -> bool

Determine if the window decorations should indicate an edited, unsaved document. Platform-dependent: Will only ever return true on macOS.

fn force_repaint(&self) -> bool

Force a repaint of this window through the native window’s repaint mechanism, bypassing floem’s normal repaint mechanism.

fn root_view(&self) -> Option<ViewId>

Get the root view of this window.

fn screen_layout(&self) -> Option<ScreenLayout>

Get a layout of this window in relation to the monitor on which it currently resides, if any.

fn scale(&self) -> f64

Get the dots-per-inch scaling of this window or 1.0 if the platform does not support it (Android).

fn set_document_edited(&self, edited: bool)

Instruct the window manager to indicate in the window’s decorations that the window contains an unsaved, edited document. Only has an effect on macOS.

fn set_visible(&self, visible: bool)

Set this window’s visible state, hiding or showing it if it has been hidden

fn set_window_inner_bounds(&self, bounds: Rect)

Update the bounds of this window.

fn set_window_outer_bounds(&self, bounds: Rect)

Update the bounds of this window.

fn maximized(&self, maximized: bool)

Change this window’s maximized state.

fn minimized(&self, minimized: bool)

Change this window’s minimized state.

fn set_outer_location(&self, location: Point)

Change this window’s minimized state.

fn set_content_size(&self, size: Size)

Ask the OS’s windowing framework to update the size of the window based on the passed size for its content (excluding titlebar, frame or other decorations).

fn request_attention(&self, urgency: Urgency)

Cause the desktop to perform some attention-drawing behavior that draws the user’s attention specifically to this window - e.g. bouncing in the dock on macOS. On X11, after calling this method with some urgency other than None, it is necessary to clear the attention-seeking state by calling this method again with Urgency::None.

impl Copy for WindowId

impl Eq for WindowId

impl StructuralPartialEq for WindowId