Struct libwmctl::WmCtl

source · [−]

pub struct WmCtl {
    pub atoms: AtomCollection,
    /* private fields */
}

Expand description

Window Manager control implements the EWMH protocol using x11rb to provide a simplified access layer to EWHM compatible window managers.

Fields

atoms: AtomCollection

Implementations

source

impl WmCtl

source

pub fn connect() -> WmCtlResult<Self>

Create the window manager control instance and connect to the X11 server

Examples

use libwmctl::prelude::*;
let wmctl = WmCtl::connect().unwrap();

source

pub fn screen(&self) -> usize

Get the default screen number

Examples

use libwmctl::prelude::*;
let wmctl = WmCtl::connect().unwrap();
wmctl.screen();

source

pub fn root(&self) -> u32

Get the root window

Examples

use libwmctl::prelude::*;
let wmctl = WmCtl::connect().unwrap();
wmctl.root();

source

pub fn width(&self) -> u32

Get the screen full width

Examples

use libwmctl::prelude::*;
let wmctl = WmCtl::connect().unwrap();
wmctl.width();

source

pub fn height(&self) -> u32

Get screen full height

Examples

use libwmctl::prelude::*;
let wmctl = WmCtl::connect().unwrap();
wmctl.height();

source

pub fn work_width(&self) -> u32

Get screen work width which is the full width minus any taskbars

Examples

use libwmctl::prelude::*;
let wmctl = WmCtl::connect().unwrap();
wmctl.work_width();

source

pub fn work_height(&self) -> u32

Get screen work height which is the full width minus any taskbars

Examples

use libwmctl::prelude::*;
let wmctl = WmCtl::connect().unwrap();
wmctl.work_height();

source

pub fn active_win(&self) -> WmCtlResult<u32>

Get the active window id

Examples

use libwmctl::prelude::*;
let wmctl = WmCtl::connect().unwrap();
wmctl.active_win().unwrap();

source

pub fn composite_manager(&self) -> WmCtlResult<bool>

Check if a composit manager is running

Examples

use libwmctl::prelude::*;
let wmctl = WmCtl::connect().unwrap();
wmctl.composite_manager().unwrap();

source

pub fn desktops(&self) -> WmCtlResult<u32>

Get number of desktops

Examples

use libwmctl::prelude::*;
let wmctl = WmCtl::connect().unwrap();
wmctl.desktops().unwrap();

source

pub fn maximize_win(&self, win: Window) -> WmCtlResult<()>

Maximize the window both horizontally and vertiacally

Arguments

win - id of the window to manipulate

Examples

use libwmctl::prelude::*;
let wmctl = WmCtl::connect().unwrap();
wmctl.maximize_win(12345).unwrap();

source

pub fn move_resize_win(
 &self,
 win: Window,
 gravity: Option<u32>,
 x: Option<u32>,
 y: Option<u32>,
 w: Option<u32>,
 h: Option<u32>
) -> WmCtlResult<()>

Move and resize the given window

Arguments

win - id of the window to manipulate
gravity - gravity to use when resizing the window, defaults to NorthWest
x - x coordinate to use for the window during positioning
y - y coordinate to use for the window during positioning
w - width to resize the window to
h - height to resize the window to

Examples

use libwmctl::prelude::*;
let wmctl = WmCtl::connect().unwrap();
wmctl.move_resize_win(12345, None, Some(0), Some(0), Some(500), Some(500)).unwrap();

source

pub fn send_event(&self, msg: ClientMessageEvent) -> WmCtlResult<()>

Send the event ensuring that a flush is called and that the message was precisely executed in the case of a resize/move.

Arguments

msg - the client message event to send

Examples

use libwmctl::prelude::*;
let wmctl = WmCtl::connect().unwrap();
let flags = MOVE_RESIZE_WINDOW_WIDTH | MOVE_RESIZE_WINDOW_HEIGHT;
wmctl.send_event(ClientMessageEvent::new(32, win, wmctl.atoms._NET_MOVERESIZE_WINDOW,
    [flags, 0, 0, 500, 500])).unwrap();

source

pub fn supported(&self, atom: u32) -> bool

Determine if the given function is supported by the window manager

Arguments

atom - atom to lookup to see if its supported

Examples

use libwmctl::prelude::*;
let wmctl = WmCtl::connect().unwrap();
wmctl.supported(wmctl.atoms._NET_MOVERESIZE_WINDOW);

source

pub fn unmaximize_win(&self, win: Window) -> WmCtlResult<()>

Remove the MaxVert and MaxHorz states

Arguments

win - id of the window to manipulate

Examples

use libwmctl::prelude::*;
let wmctl = WmCtl::connect().unwrap();
wmctl.unmaximize_win(12345).unwrap();

source

pub fn windows(&self, all: bool) -> WmCtlResult<Vec<u32>>

Get windows optionally all

Arguments

all - default is to get all windows controlled by the window manager, when all is true get the super set of x11 windows

Examples

use libwmctl::prelude::*;
let wmctl = WmCtl::connect().unwrap();
wmctl.windows(false).unwrap();

source

pub fn winmgr(&self) -> WmCtlResult<(u32, String )>

Get window manager’s window id and name

Examples

use libwmctl::prelude::*;
let wmctl = WmCtl::connect().unwrap();
let (id, name) = wmctl.winmgr().unwrap();

source

pub fn workarea(&self) -> WmCtlResult<(u16, u16 )>

Get desktop work area

Examples

use libwmctl::prelude::*;
let wmctl = WmCtl::connect().unwrap();
let (w, h) = wmctl.workarea().unwrap();

source

pub fn win_attributes(&self, win: Window) -> WmCtlResult<(WinClass, WinMap )>

Get window attribrtes

Arguments

win - id of the window to manipulate

Examples

use libwmctl::prelude::*;
let wmctl = WmCtl::connect().unwrap();
let (class, state) = wmctl.win_attributes(12345).unwrap();

source

pub fn win_class(&self, win: Window) -> WmCtlResult<String>

Get window class which ends up being the applications name

Arguments

win - id of the window to manipulate

Examples

use libwmctl::prelude::*;
let wmctl = WmCtl::connect().unwrap();
let class = wmctl.win_class(12345).unwrap();

source

pub fn win_desktop(&self, win: Window) -> WmCtlResult<i32>

Get window desktop

Arguments

win - id of the window to manipulate

Examples

use libwmctl::prelude::*;
let wmctl = WmCtl::connect().unwrap();
let desktop = wmctl.win_desktop(12345).unwrap();

source

pub fn win_borders(&self, win: Window) -> WmCtlResult<(u32, u32, u32, u32 )>

Get window frame border values added by the window manager

Arguments

win - id of the window to manipulate

Examples

use libwmctl::prelude::*;
let wmctl = WmCtl::connect().unwrap();
let (l, r, t, b) = wmctl.win_borders(12345).unwrap();

source

pub fn win_geometry(&self, win: Window) -> WmCtlResult<(i32, i32, u32, u32 )>

Get window geometry

Arguments

win - id of the window to manipulate

Examples

use libwmctl::prelude::*;
let wmctl = WmCtl::connect().unwrap();
let (x, y, w, h) = wmctl.win_geometry(12345).unwrap();

source

pub fn win_name(&self, win: Window) -> WmCtlResult<String>

Get window name

Arguments

win - id of the window to manipulate

Examples

use libwmctl::prelude::*;
let wmctl = WmCtl::connect().unwrap();
let name = wmctl.win_name(12345).unwrap();

source

pub fn win_parent(&self, win: Window) -> WmCtlResult<u32>

Get window parent

Arguments

win - id of the window to manipulate

Examples

use libwmctl::prelude::*;
let wmctl = WmCtl::connect().unwrap();
let parent = wmctl.win_parent(12345).unwrap();

source

pub fn win_pid(&self, win: Window) -> WmCtlResult<i32>

Get window pid

Arguments

win - id of the window to manipulate

Examples

use libwmctl::prelude::*;
let wmctl = WmCtl::connect().unwrap();
let pid = wmctl.win_pid(12345).unwrap();

source

pub fn win_state(&self, win: Window) -> WmCtlResult<Vec<WinState>>

Get window state

Arguments

win - id of the window to manipulate

Examples

use libwmctl::prelude::*;
let wmctl = WmCtl::connect().unwrap();
let state = wmctl.win_state(12345).unwrap();

source

pub fn win_type(&self, win: Window) -> WmCtlResult<WinType>

Get window type

Arguments

win - id of the window to manipulate

Examples

use libwmctl::prelude::*;
let wmctl = WmCtl::connect().unwrap();
let type_ = wmctl.win_type(12345).unwrap();

Auto Trait Implementations

impl !RefUnwindSafe for WmCtl

impl Send for WmCtl

impl Sync for WmCtl

impl Unpin for WmCtl

impl !UnwindSafe for WmCtl

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct libwmctl::WmCtl

Fields

Implementations

impl WmCtl

pub fn connect() -> WmCtlResult<Self>

pub fn screen(&self) -> usize

pub fn root(&self) -> u32

pub fn width(&self) -> u32

pub fn height(&self) -> u32

pub fn work_width(&self) -> u32

pub fn work_height(&self) -> u32

pub fn active_win(&self) -> WmCtlResult<u32>

pub fn composite_manager(&self) -> WmCtlResult<bool>

pub fn desktops(&self) -> WmCtlResult<u32>

pub fn maximize_win(&self, win: Window) -> WmCtlResult<()>

pub fn move_resize_win( &self, win: Window, gravity: Option<u32>, x: Option<u32>, y: Option<u32>, w: Option<u32>, h: Option<u32>) -> WmCtlResult<()>

pub fn send_event(&self, msg: ClientMessageEvent) -> WmCtlResult<()>

pub fn supported(&self, atom: u32) -> bool

pub fn unmaximize_win(&self, win: Window) -> WmCtlResult<()>

pub fn windows(&self, all: bool) -> WmCtlResult<Vec<u32>>

pub fn winmgr(&self) -> WmCtlResult<(u32, String)>

pub fn workarea(&self) -> WmCtlResult<(u16, u16)>

pub fn win_attributes(&self, win: Window) -> WmCtlResult<(WinClass, WinMap)>

pub fn win_class(&self, win: Window) -> WmCtlResult<String>

pub fn win_desktop(&self, win: Window) -> WmCtlResult<i32>

pub fn win_borders(&self, win: Window) -> WmCtlResult<(u32, u32, u32, u32)>

pub fn win_geometry(&self, win: Window) -> WmCtlResult<(i32, i32, u32, u32)>

pub fn win_name(&self, win: Window) -> WmCtlResult<String>

pub fn win_parent(&self, win: Window) -> WmCtlResult<u32>

pub fn win_pid(&self, win: Window) -> WmCtlResult<i32>

pub fn win_state(&self, win: Window) -> WmCtlResult<Vec<WinState>>

pub fn win_type(&self, win: Window) -> WmCtlResult<WinType>

Auto Trait Implementations

impl !RefUnwindSafe for WmCtl

impl Send for WmCtl

impl Sync for WmCtl

impl Unpin for WmCtl

impl !UnwindSafe for WmCtl

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

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

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub fn move_resize_win(
&self,
win: Window,
gravity: Option<u32>,
x: Option<u32>,
y: Option<u32>,
w: Option<u32>,
h: Option<u32>
) -> WmCtlResult<()>

pub fn winmgr(&self) -> WmCtlResult<(u32, String )>

pub fn workarea(&self) -> WmCtlResult<(u16, u16 )>

pub fn win_attributes(&self, win: Window) -> WmCtlResult<(WinClass, WinMap )>

pub fn win_borders(&self, win: Window) -> WmCtlResult<(u32, u32, u32, u32 )>

pub fn win_geometry(&self, win: Window) -> WmCtlResult<(i32, i32, u32, u32 )>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,