Skip to main content

WindowHandle

Struct WindowHandle 

Source
pub struct WindowHandle { /* private fields */ }
Expand description

A thread-safe reference to a generational Incular window. Methods only enqueue data for the UI/event-loop turn; they never touch native state.

Implementations§

Source§

impl WindowHandle

Source

pub const fn id(&self) -> WindowId

Source

pub fn capabilities(&self) -> PlatformCapabilities

Source

pub fn file_dialogs(&self) -> FileDialogService

Native file/folder dialog service associated with this window. The service retains only the Incular window identity; native parent handles remain inside the desktop adapter.

Source

pub fn observed_state(&self) -> WindowObservedState

Source

pub fn transient_presentations(&self) -> Vec<TransientPresentationResolution>

Resolved native-vs-overlay presentation for visible retained transients in this window. The native adapter updates this after host negotiation; an empty list means no visible semantic transient is currently present.

Source

pub fn displays(&self) -> Vec<DisplaySnapshot>

Immutable snapshots for displays currently published by the native backend. Removed displays disappear immediately; a later display using the same registry slot carries a different generation.

Source

pub fn display(&self, id: DisplayId) -> Option<DisplaySnapshot>

Source

pub fn primary_display(&self) -> Option<DisplaySnapshot>

Source

pub fn current_display(&self) -> Option<DisplaySnapshot>

Source

pub fn set_title( &self, title: impl Into<String>, ) -> Result<(), WindowCommandEnqueueError>

Source

pub fn set_visible( &self, visible: bool, ) -> Result<(), WindowCommandEnqueueError>

Source

pub fn request_logical_size( &self, size: Size, ) -> Result<(), WindowCommandEnqueueError>

Source

pub fn set_outer_position( &self, position: PhysicalScreenPosition, ) -> Result<(), WindowCommandEnqueueError>

Source

pub fn center_on_display( &self, display: &DisplaySnapshot, area: DisplayPlacementArea, ) -> Result<PhysicalScreenPosition, WindowPlacementError>

Centers this window using already-observed native outer size and one immutable display snapshot. Work-area centering never falls back to full monitor bounds: callers must choose that policy explicitly.

Source

pub fn move_relative_to_display( &self, display: &DisplaySnapshot, position: PhysicalDisplayPosition, ) -> Result<PhysicalScreenPosition, WindowPlacementError>

Moves the window to a physical point relative to one known display. This is intentionally unavailable when the display snapshot has no desktop-global origin (for example a Wayland top-level display).

Source

pub fn begin_move_drag( &self, ) -> Result<NativeOperationRequest, WindowCommandEnqueueError>

Begins a compositor/window-manager-owned interactive move. The native backend may require this call to follow a real primary-button press.

Source

pub fn begin_resize_drag( &self, direction: WindowResizeDirection, ) -> Result<NativeOperationRequest, WindowCommandEnqueueError>

Begins a compositor/window-manager-owned interactive resize from one edge/corner. Incular never emulates this by changing global coordinates.

Source

pub fn set_minimized( &self, minimized: bool, ) -> Result<(), WindowCommandEnqueueError>

Source

pub fn set_maximized( &self, maximized: bool, ) -> Result<(), WindowCommandEnqueueError>

Source

pub fn set_fullscreen( &self, fullscreen: Option<Fullscreen>, ) -> Result<(), WindowCommandEnqueueError>

Source

pub fn set_resizable( &self, resizable: bool, ) -> Result<(), WindowCommandEnqueueError>

Source

pub fn set_decorations( &self, decorations: bool, ) -> Result<(), WindowCommandEnqueueError>

Source

pub fn set_logical_size_limits( &self, limits: LogicalSizeLimits, ) -> Result<(), WindowCommandEnqueueError>

Source

pub fn set_window_level( &self, level: WindowLevel, ) -> Result<(), WindowCommandEnqueueError>

Source

pub fn set_window_icon( &self, icon: Option<WindowIcon>, ) -> Result<(), WindowCommandEnqueueError>

Source

pub fn request_user_attention( &self, attention: UserAttentionType, ) -> Result<(), WindowCommandEnqueueError>

Source

pub fn cancel_user_attention(&self) -> Result<(), WindowCommandEnqueueError>

Source

pub fn set_cursor_grab( &self, mode: CursorGrabMode, ) -> Result<NativeOperationRequest, WindowCommandEnqueueError>

Requests native cursor confinement/locking. The returned request completes with a typed platform result; the runtime does not claim a grab succeeded merely because the command was enqueued.

Source

pub fn set_cursor_visible( &self, visible: bool, ) -> Result<NativeOperationRequest, WindowCommandEnqueueError>

Shows or hides the native cursor for this window.

Source

pub fn set_cursor_position( &self, position: LogicalWindowPosition, ) -> Result<NativeOperationRequest, WindowCommandEnqueueError>

Warps the native cursor to a validated logical client-area position.

Source

pub fn set_content_sensitivity( &self, sensitivity: ContentSensitivity, ) -> Result<NativeOperationRequest, WindowCommandEnqueueError>

Requests the window’s normalized content-capture policy. The command is applied by the native adapter on its event-loop thread. Unsupported adapters resolve the returned request with a typed platform error.

Source

pub fn request_focus(&self) -> Result<(), WindowCommandEnqueueError>

Source

pub fn request_redraw(&self) -> Result<(), WindowCommandEnqueueError>

Source

pub fn close(&self) -> Result<(), WindowCommandEnqueueError>

Trait Implementations§

Source§

impl Clone for WindowHandle

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for WindowHandle

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
where T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, D: AdaptFrom<S, Swp, Dwp, T>,

Source§

fn adapt_into_using<M>(self, method: M) -> D
where M: TransformMatrix<T>,

👎Deprecated since 0.7.7:

replaced by palette::chromatic_adaptation::AdaptIntoUnclamped

Convert the source color to the destination color using the specified method.
Source§

fn adapt_into(self) -> D

👎Deprecated since 0.7.7:

replaced by palette::chromatic_adaptation::AdaptIntoUnclamped

Convert the source color to the destination color using the bradford method by default.
Source§

impl<T, C> AdaptIntoUnclamped<T> for C
where T: AdaptFromUnclamped<C>,

Source§

type Scalar = <T as AdaptFromUnclamped<C>>::Scalar

The number type that’s used as the color’s components.
Source§

fn adapt_into_unclamped_with<M>(self) -> T

Adapt a color of type Self into a color of type T, using the custom matrix M. Read more
Source§

fn adapt_into_unclamped(self) -> T
where Bradford: LmsToXyz<Self::Scalar> + XyzToLms<Self::Scalar>,

Adapt a color of type Self into a color of type T, using the Bradford matrix. Read more
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, C> ArraysFrom<C> for T
where C: IntoArrays<T>,

Source§

fn arrays_from(colors: C) -> T

Cast a collection of colors into a collection of arrays.
Source§

impl<T, C> ArraysInto<C> for T
where C: FromArrays<T>,

Source§

fn arrays_into(self) -> C

Cast this collection of arrays into a collection of colors.
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<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for U
where T: FromCam16Unclamped<WpParam, U>,

Source§

type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.
Source§

fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T, C> ComponentsFrom<C> for T
where C: IntoComponents<T>,

Source§

fn components_from(colors: C) -> T

Cast a collection of colors into a collection of color components.
Source§

impl<T, C> ComponentsInto<C> for T

Source§

fn components_into(self) -> C

Cast this collection of color components into a collection of colors. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromAngle<T> for T

Source§

fn from_angle(angle: T) -> T

Performs a conversion from angle.
Source§

impl<T, U> FromStimulus<U> for T
where U: IntoStimulus<T>,

Source§

fn from_stimulus(other: U) -> T

Converts other into Self, while performing the appropriate scaling, rounding and clamping.
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> IntoAngle<U> for T
where U: FromAngle<T>,

Source§

fn into_angle(self) -> U

Performs a conversion into T.
Source§

impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for U
where T: Cam16FromUnclamped<WpParam, U>,

Source§

type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.
Source§

fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.
Source§

impl<T, U> IntoColor<U> for T
where U: FromColor<T>,

Source§

fn into_color(self) -> U

Convert into T with values clamped to the color defined bounds Read more
Source§

impl<T, U> IntoColorUnclamped<U> for T
where U: FromColorUnclamped<T>,

Source§

fn into_color_unclamped(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more
Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoStimulus<T> for T

Source§

fn into_stimulus(self) -> T

Converts self into T, while performing the appropriate scaling, rounding and clamping.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, C> TryComponentsInto<C> for T
where C: TryFromComponents<T>,

Source§

type Error = <C as TryFromComponents<T>>::Error

The error for when try_into_colors fails to cast.
Source§

fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>

Try to cast this collection of color components into a collection of colors. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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, U> TryIntoColor<U> for T
where U: TryFromColor<T>,

Source§

fn try_into_color(self) -> Result<U, OutOfBounds<U>>

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more
Source§

impl<C, U> UintsFrom<C> for U
where C: IntoUints<U>,

Source§

fn uints_from(colors: C) -> U

Cast a collection of colors into a collection of unsigned integers.
Source§

impl<C, U> UintsInto<C> for U
where C: FromUints<U>,

Source§

fn uints_into(self) -> C

Cast this collection of unsigned integers into a collection of colors.
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