Struct WindowHandle

pub struct WindowHandle { /* private fields */ }

A handle to a window.

This allows you to manipulate the window and get its properties.

Implementations

impl WindowHandle

pub fn close(&self)

Sends a close request to this window.

If the window is unresponsive, it may not close.

pub fn set_geometry( &self, x: impl Into<Option<i32>>, y: impl Into<Option<i32>>, w: impl Into<Option<u32>>, h: impl Into<Option<u32>>, )

Sets this window’s location and/or size.

Only affects the floating geometry of windows. Tiled geometries are calculated using the current layout.

pub fn set_fullscreen(&self, set: bool)

Sets this window to fullscreen or not.

pub fn toggle_fullscreen(&self)

Toggles this window between fullscreen and not.

pub fn set_maximized(&self, set: bool)

Sets this window to maximized or not.

pub fn toggle_maximized(&self)

Toggles this window between maximized and not.

pub fn set_floating(&self, set: bool)

Sets this window to floating or not.

Floating windows will not be tiled and can be moved around and resized freely.

pub fn toggle_floating(&self)

Toggles this window to and from floating.

Floating windows will not be tiled and can be moved around and resized freely.

pub fn set_focused(&self, set: bool)

Focuses or unfocuses this window.

pub fn toggle_focused(&self)

Toggles this window between focused and unfocused.

pub fn set_decoration_mode(&self, mode: DecorationMode)

Sets this window’s decoration mode.

pub fn move_to_tag(&self, tag: &TagHandle)

Moves this window to the given tag.

This will remove all tags from this window then tag it with tag, essentially moving the window to that tag.

Examples

// Move the focused window to tag "Code" on the focused output
window::get_focused()?.move_to_tag(&tag::get("Code")?);

pub fn set_tag(&self, tag: &TagHandle, set: bool)

Sets or unsets a tag on this window.

Examples

let focused = window::get_focused()?;
let tag = tag::get("Potato")?;

focused.set_tag(&tag, true); // `focused` now has tag "Potato"
focused.set_tag(&tag, false); // `focused` no longer has tag "Potato"

pub fn toggle_tag(&self, tag: &TagHandle)

Toggles a tag on this window.

Examples

let focused = window::get_focused()?;
let tag = tag::get("Potato")?;

focused.toggle_tag(&tag); // `focused` now has tag "Potato"
focused.toggle_tag(&tag); // `focused` no longer has tag "Potato"

pub fn raise(&self)

Raises this window to the front.

pub fn loc(&self) -> Option<Point>

Gets this window’s current location in the global space.

pub async fn loc_async(&self) -> Option<Point>

Async impl for Self::loc.

pub fn size(&self) -> Option<Size>

Gets this window’s current size.

pub async fn size_async(&self) -> Option<Size>

Async impl for Self::size.

pub fn app_id(&self) -> String

Gets this window’s app id (class if it’s an xwayland window).

If it doesn’t have one, this returns an empty string.

pub async fn app_id_async(&self) -> String

Async impl for Self::app_id.

pub fn title(&self) -> String

Gets this window’s title.

If it doesn’t have one, this returns an empty string.

pub async fn title_async(&self) -> String

Async impl for Self::title.

pub fn focused(&self) -> bool

Gets whether or not this window has keyboard focus.

pub async fn focused_async(&self) -> bool

Async impl for Self::focused.

pub fn layout_mode(&self) -> LayoutMode

Gets this window’s current LayoutMode.

pub async fn layout_mode_async(&self) -> LayoutMode

Async impl for Self::layout_mode.

pub fn floating(&self) -> bool

Gets whether or not this window is floating.

pub async fn floating_async(&self) -> bool

Async impl for Self::floating.

pub fn fullscreen(&self) -> bool

Gets whether or not this window is fullscreen.

pub async fn fullscreen_async(&self) -> bool

Async impl for Self::fullscreen.

pub fn maximized(&self) -> bool

Gets whether or not this window is maximized.

pub async fn maximized_async(&self) -> bool

Async impl for Self::maximized.

pub fn tags(&self) -> impl Iterator<Item = TagHandle>

Gets handles to all tags on this window.

pub async fn tags_async(&self) -> impl Iterator<Item = TagHandle>

Async impl for Self::tags.

pub fn is_on_active_tag(&self) -> bool

Gets whether or not this window has an active tag.

pub async fn is_on_active_tag_async(&self) -> bool

Async impl for Self::is_on_active_tag.

pub fn id(&self) -> u32

Gets this window’s raw compositor id.

pub fn from_id(id: u32) -> Self

Creates a window handle from an ID.

Note: This is mostly for testing and if you want to serialize and deserialize window handles.

Trait Implementations

impl Clone for WindowHandle

fn clone(&self) -> WindowHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WindowHandle

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

Formats the value using the given formatter.

impl Hash for WindowHandle

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

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 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 Eq for WindowHandle

impl StructuralPartialEq for WindowHandle