Window

Struct Window 

Source
pub struct Window(pub u64);
Expand description

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§

Source§

impl Window

Source

pub fn exists(self) -> bool

Returns whether the window exists.

Source

pub fn does_not_exist(self) -> bool

Returns whether the window does not exist.

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

Source

pub fn client(self) -> Client

Returns the client of the window.

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

Source

pub fn title(self) -> String

Returns the title of the window.

Source

pub fn type_(self) -> WindowType

Returns the type of the window.

Source

pub fn content_type(self) -> ContentType

Returns the content type of the window.

Source

pub fn id(self) -> String

Returns the identifier of the window.

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

Source

pub fn is_visible(self) -> bool

Returns whether this window is visible.

Source

pub fn parent(self) -> Window

Returns the parent of this window.

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

Source

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

Returns the children of this window.

Only containers have children.

Source

pub fn move_(self, direction: Direction)

Moves the window in the specified direction.

Source

pub fn mono(self) -> bool

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

Source

pub fn set_mono(self, mono: bool)

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

Source

pub fn toggle_mono(self)

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

Source

pub fn split(self) -> Axis

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

Source

pub fn set_split(self, axis: Axis)

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

Source

pub fn toggle_split(self)

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

Source

pub fn create_split(self, axis: Axis)

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

Source

pub fn close(self)

Requests the window to be closed.

Source

pub fn floating(self) -> bool

Returns whether the window is floating.

Source

pub fn set_floating(self, floating: bool)

Sets whether the window is floating.

Source

pub fn toggle_floating(self)

Toggles whether the window is floating.

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

Source

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.

Source

pub fn set_workspace(self, workspace: Workspace)

Moves the window to the workspace.

Source

pub fn toggle_fullscreen(self)

Toggles whether the currently focused window is fullscreen.

Source

pub fn fullscreen(self) -> bool

Returns whether the window is fullscreen.

Source

pub fn set_fullscreen(self, fullscreen: bool)

Sets whether the window is fullscreen.

Source

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.

Source

pub fn set_float_pinned(self, pinned: bool)

Sets whether the window is pinned.

Source

pub fn toggle_float_pinned(self)

Toggles whether the window is pinned.

Trait Implementations§

Source§

impl Clone for Window

Source§

fn clone(&self) -> Window

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Window

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Hash for Window

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Window

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for Window

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Copy for Window

Source§

impl Eq for Window

Source§

impl StructuralPartialEq for Window

Auto Trait Implementations§

§

impl Freeze for Window

§

impl RefUnwindSafe for Window

§

impl Send for Window

§

impl Sync for Window

§

impl Unpin for Window

§

impl UnwindSafe for Window

Blanket Implementations§

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> 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<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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,