Struct WindowHandle

pub struct WindowHandle { /* private fields */ }

Available on crate feature ui only.

A (non-null) handle to a window.

Multithreading

This handle is not Send and Sync because if the window was not created by this thread, then it is not guaranteed that the handle continues pointing to the same window because the underlying handles can get invalid or even recycled.

Mutability

Even though various functions on this type are mutating, they all take non-mut references since it would be too hard to guarantee exclusive references when window messages are involved. The problem in that case is that the windows API will call back into Rust code and that code would then need exclusive references, which would at least make the API rather cumbersome. If an elegant solution to this problem is found, this API may change.

Implementations

impl WindowHandle

pub fn get_console_window() -> Option<Self>

Returns the console window associated with the current process, if there is one.

pub fn get_foreground_window() -> Option<Self>

Returns the current foreground window, if any.

pub fn get_desktop_window() -> Result<Self>

Returns the ‘desktop’ window.

pub fn get_toplevel_windows() -> Result<Vec<Self>>

Returns all top-level windows of desktop apps.

pub fn is_window(&self) -> bool

Checks if the handle points to an existing window.

pub fn is_visible(&self) -> bool

pub fn get_caption_text(&self) -> String

Returns the window caption text, converted to UTF-8 in a potentially lossy way.

pub fn set_caption_text(&self, text: &str) -> Result<()>

Sets the window caption text.

pub fn set_as_foreground(&self) -> Result<()>

Brings the window to the foreground.

pub fn set_as_active(&self) -> Result<()>

Sets the window as the currently active (selected) window.

pub fn set_show_state(&self, state: WindowShowState) -> Result<()>

Changes the window show state.

pub fn get_placement(&self) -> Result<WindowPlacement>

Returns the window’s show state and positions.

pub fn set_placement(&self, placement: &WindowPlacement) -> Result<()>

Sets the window’s show state and positions.

pub fn get_class_name(&self) -> Result<String>

Returns the class name of the window’s associated WindowClass.

pub fn send_command(&self, action: WindowCommand) -> Result<()>

Sends a command to the window, same as if one of the symbols in its top right were clicked.

pub fn flash(&self)

Flashes the window using default flash settings.

Same as Self::flash_custom using Default::default for all parameters.

pub fn flash_custom( &self, element: FlashElement, duration: FlashDuration, frequency: FlashInterval, )

Flashes the window, allowing various customization parameters.

pub fn flash_stop(&self)

Stops the window from flashing.

pub fn get_creator_thread_id(&self) -> ThreadId

Available on crate feature process only.

Returns the thread ID that created this window.

pub fn get_creator_process_id(&self) -> ProcessId

Available on crate feature process only.

Returns the process ID that created this window.

pub fn get_nonchild_windows(thread_id: ThreadId) -> Vec<Self>

Available on crate feature process only.

Returns all top-level (non-child) windows created by the thread.

pub fn set_monitor_power(&self, level: MonitorPower) -> Result<()>

Turns the monitor on or off.

Windows requires this command to be sent through a window, e.g. using WindowHandle::get_foreground_window.

Trait Implementations

impl<WML> AsMut<WindowHandle> for Window<'_, '_, WML>

fn as_mut(&mut self) -> &mut WindowHandle

Converts this type into a mutable reference of the (usually inferred) input type.

impl<WML> AsRef<WindowHandle> for Window<'_, '_, WML>

fn as_ref(&self) -> &WindowHandle

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for WindowHandle

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

Formats the value using the given formatter.

impl From<&WindowHandle> for HWND

fn from(value: &WindowHandle) -> Self

Returns the underlying raw window handle used by [windows].

impl From<WindowHandle> for HWND

fn from(value: WindowHandle) -> Self

Returns the underlying raw window handle used by [windows].

impl PartialEq for WindowHandle

fn eq(&self, other: &WindowHandle) -> 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 TryFrom<HWND> for WindowHandle

fn try_from(value: HWND) -> Result<Self, Self::Error>

Returns a new window handle from a raw handle if it is non-null.

type Error = TryFromHWNDError

The type returned in the event of a conversion error.

impl Eq for WindowHandle

impl StructuralPartialEq for WindowHandle