Struct Window 

pub struct Window(pub u64);

A toplevel window.

A toplevel window is anything that can be stored within a container tile or within a floating window.

There are currently four types of windows:

• Containers
• Placeholders that take the place of a window when it goes fullscreen
• XDG toplevels
• X windows

You can find out the type of a window by using the Window::type_ function.

Tuple Fields

0: u64

Implementations

impl Window

pub fn exists(self) -> bool

Returns whether the window exists.

pub fn does_not_exist(self) -> bool

Returns whether the window does not exist.

This is a shorthand for !self.exists().

pub fn client(self) -> Client

Returns the client of the window.

If the window does not have a client, Client::exists return false.

pub fn title(self) -> String

Returns the title of the window.

pub fn type_(self) -> WindowType

Returns the type of the window.

pub fn content_type(self) -> ContentType

Returns the content type of the window.

pub fn id(self) -> String

Returns the identifier of the window.

This is the identifier used in the ext-foreign-toplevel-list-v1 protocol.

pub fn is_visible(self) -> bool

Returns whether this window is visible.

pub fn parent(self) -> Window

Returns the parent of this window.

If this window has no parent, Window::exists returns false.

pub fn children(self) -> Vec<Window>

Returns the children of this window.

Only containers have children.

pub fn move_(self, direction: Direction)

Moves the window in the specified direction.

pub fn mono(self) -> bool

Returns whether the parent-container of the window is in mono-mode.

pub fn set_mono(self, mono: bool)

Sets whether the parent-container of the window is in mono-mode.

pub fn toggle_mono(self)

Toggles whether the parent-container of the window is in mono-mode.

pub fn split(self) -> Axis

Returns the split axis of the parent-container of the window.

pub fn set_split(self, axis: Axis)

Sets the split axis of the parent-container of the window.

pub fn toggle_split(self)

Toggles the split axis of the parent-container of the window.

pub fn container_mono(self, target: ContainerTarget) -> bool

Returns whether the target container of the window is in mono-mode.

pub fn set_container_mono(self, target: ContainerTarget, mono: bool)

Sets whether the target container of the window is in mono-mode.

pub fn toggle_container_mono(self, target: ContainerTarget)

Toggles whether the target container of the window is in mono-mode.

pub fn container_split(self, target: ContainerTarget) -> Axis

Returns the split axis of the target container of the window.

pub fn set_container_split(self, target: ContainerTarget, axis: Axis)

Sets the split axis of the target container of the window.

pub fn toggle_container_split(self, target: ContainerTarget)

Toggles the split axis of the target container of the window.

pub fn set_container_split_relative( self, target: ContainerTarget, axis: RelativeAxis, )

Sets the split axis of the target container of the window relative to the dimensions of that container.

pub fn create_split(self, axis: Axis)

Creates a new container with the specified split in place of the window.

If the window is the only child of its container and set_split_reuses_container is enabled, the split axis of that container is changed instead.

pub fn create_split_relative(self, axis: RelativeAxis)

Creates a new container in place of the window with a split relative to the dimensions of that window.

If the window is the only child of its container and set_split_reuses_container is enabled, the split axis of that container is changed instead.

pub fn close(self)

Requests the window to be closed.

pub fn floating(self) -> bool

Returns whether the window is floating.

pub fn set_floating(self, floating: bool)

Sets whether the window is floating.

pub fn toggle_floating(self)

Toggles whether the window is floating.

You can do the same by double-clicking on the header.

pub fn workspace(self) -> Workspace

Returns the workspace that this window belongs to.

If no such workspace exists, exists returns false for the returned workspace.

pub fn set_workspace(self, workspace: Workspace)

Moves the window to the workspace.

pub fn toggle_fullscreen(self)

Toggles whether the currently focused window is fullscreen.

pub fn fullscreen(self) -> bool

Returns whether the window is fullscreen.

pub fn set_fullscreen(self, fullscreen: bool)

Sets whether the window is fullscreen.

pub fn float_pinned(self) -> bool

Gets whether the window is pinned.

If a floating window is pinned, it will stay visible even when switching to a different workspace.

pub fn set_float_pinned(self, pinned: bool)

Sets whether the window is pinned.

pub fn toggle_float_pinned(self)

Toggles whether the window is pinned.

pub fn resize(self, dx1: i32, dy1: i32, dx2: i32, dy2: i32)

Resizes the window.

pub fn position(self) -> (i32, i32)

Returns the position of the window in the global compositor space.

This value is only accurate for visible windows.

pub fn size(self) -> (i32, i32)

Returns the size of the window.

This value is only accurate for visible windows.

pub fn theme(self) -> WindowTheme

Returns the theme overrides of this window.

See WindowTheme for details.

pub fn container_theme(self) -> ContainerTheme

Returns the theme overrides of how this container decorates its children.

This is only supported for containers.

See ContainerTheme for details.

Trait Implementations

impl Clone for Window

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Window

impl Debug for Window

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Window

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Window

impl Hash for Window

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 Window

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Window

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Window