Struct Window 

pub struct Window {
    pub id: u32,
    /* private fields */
}

Window provides a higer level interfacefor manipulating windows.

Fields

id: u32

Implementations

impl Window

pub fn pid(&self) -> WmCtlResult<i32>

Get window pid

Examples

use libwmctl::prelude::*;
let win = window(12345);
let pid = win.pid().unwrap();

pub fn name(&self) -> WmCtlResult<String>

Get window name

Examples

use libwmctl::prelude::*;
let win = window(12345);
let name = win.name().unwrap();

pub fn class(&self) -> WmCtlResult<String>

Get window class which is typically the the application’s name

Examples

use libwmctl::prelude::*;
let win = window(12345);
let class = win.class().unwrap();

pub fn kind(&self) -> WmCtlResult<Kind>

Get window kind

Arguments

• win - id of the window to manipulate

Examples

use libwmctl::prelude::*;
let win = window(12345);
let kind = win.kind().unwrap();

pub fn state(&self) -> WmCtlResult<Vec<State>>

Get window state

Examples

use libwmctl::prelude::*;
let win = window(12345);
let state = win.state().unwrap();

pub fn parent(&self) -> WmCtlResult<Window>

Get window parent

Examples

use libwmctl::prelude::*;
let win = window(12345);
let parent = win.parent().unwrap();

pub fn desktop(&self) -> WmCtlResult<i32>

Get window desktop

Examples

use libwmctl::prelude::*;
let win = window(12345);
let desktop = win.desktop().unwrap();

pub fn geometry(&self) -> WmCtlResult<(i32, i32, u32, u32)>

Get window geometry

Examples

use libwmctl::prelude::*;
let win = window(12345);
let (x, y, w, h) = win.geometry().unwrap();

pub fn visual_geometry(&self) -> WmCtlResult<(i32, i32, u32, u32)>

Get visual window geometry

Examples

use libwmctl::prelude::*;
let win = window(12345);
let (x, y, w, h) = win.visual_geometry().unwrap();

pub fn borders(&self) -> Border

Get window frame border values added by the window manager

Examples

use libwmctl::prelude::*;
let win = window(12345);
let (l, r, t, b) = win.borders();

pub fn is_gtk(&self) -> bool

Determine if this window is a GTK application

Examples

use libwmctl::prelude::*;
let win = window(12345);
let result = win.is_gtk();

pub fn gtk_borders(&self) -> Border

Get window GNOME border values added by GTK

Examples

use libwmctl::prelude::*;
let win = window(12345);
let (l, r, t, b) = win.gtk_borders();

pub fn mapped(&self) -> WmCtlResult<MapState>

Get window mapped state

• doesn’t return a valid state if all windows are included rather than just the managed ones

Examples

use libwmctl::prelude::*;
let win = window(12345);
let state = win.mapped().unwrap();

pub fn properties(&self) -> WmCtlResult<Vec<Property>>

Get all window properties generically

Examples

use libwmctl::prelude::*;
let win = window(12345);
win.properties().unwrap();

pub fn map(&self) -> WmCtlResult<()>

Map the window to the screen

• Windows are created in the unmapped state and must be mapped to be visible
• Unmapping the window will have the opposite effect of hidding the window
• Useful for new windows or dialogs that need to conditionally be visible
• It is much faster to hide and show and window rather than recreate it

Examples

use libwmctl::prelude::*;
let win = window(12345);
win.map().unwrap();

pub fn maximize(&self) -> WmCtlResult<()>

Maximize the window both horizontally and vertically

Examples

use libwmctl::prelude::*;
let win = window(12345);
win.maximize().unwrap();

pub fn maximized(&self) -> bool

Check if the window has a horizontally or vertically maximized

Examples

use libwmctl::prelude::*;
let win = window(12345);
win.maximized()

pub fn unmaximize(&self) -> WmCtlResult<()>

Remove the MaxVert and MaxHorz states

Examples

use libwmctl::prelude::*;
let win = window(12345);
win.unmaximize().unwrap();

pub fn shape(self, shape: Shape) -> Self

Queue the shape the window should be. This will not take effect until the place() method is called.

Arguments

• shape - pre-defined shape to manipulate the window into

Examples

use libwmctl::prelude::*;
window(12345).shape(WinShape::Large).place().unwrap();

pub fn pos(self, pos: Position) -> Self

Queue the position the window should be. This will not take effect until the place() method is called.

Arguments

• pos - pre-defined position to move the window to

Examples

use libwmctl::prelude::*;
window(12345).pos(WinPosition::Right).place().unwrap();

pub fn place(&self) -> WmCtlResult<()>

Move and resize the window according to the queued directives configured with the shape() and pos() methods.

Examples

use libwmctl::prelude::*;
let win = window(12345);
win.shape(Shape::Large).pos(Position::Right).place();

Trait Implementations

impl Clone for Window

fn clone(&self) -> Window

Returns a duplicate of the value.

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

Performs copy-assignment from source.