xdotool 0.0.2

A wrapper for the command line tool xdotool written in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

//! Convenience functions for the desktop functionality in xdotool.

use std::process::Output;

use crate::command::options::{SetDesktopOption, SyncOption};
use crate::command::{sub_commands, Command};
use crate::optionvec::OptionVec;
use crate::run;

/// Activate the window. This command is different from [`focus_window`](../window/fn.focus_window.html): if the window is on another desktop, we will switch to that desktop.
/// 
/// # Options
/// 
/// `SyncOption::Sync` Wait until the window is actually activated.
/// 
/// # Examples
/// 
/// Switch to the desktop and activate a window:
///  
/// ```
/// # use xdotool::{OptionVec, desktop};
/// let output = desktop::activate_window("window-id", OptionVec::new());
/// ```
pub fn activate_window(window: &str, options: OptionVec<SyncOption>) -> Output {
    let c = Command::Desktop(sub_commands::Desktop::WindowActivate(options));
    run(c, window)
}

/// Output the current active window. This command is often more reliable than [`get_window_focus`](../window/fn.get_window_focus.html).
/// 
/// # Examples
/// 
/// Get the current active window and print it to the console:
/// 
/// ```
/// # use xdotool::desktop;
/// let output = desktop::get_active_window();
/// println!("{}", String::from_utf8(output.stdout)?);
/// # Ok::<(), std::string::FromUtf8Error>(())
/// ```
pub fn get_active_window() -> Output {
    let c = Command::Desktop(sub_commands::Desktop::GetActiveWindow);
    run(c, "")
}

/// Changes the number of desktops or workspaces.
pub fn set_num_desktops(num: u8) -> Output {
    let c = Command::Desktop(sub_commands::Desktop::SetNumDesktops);
    run(c, &num.to_string())
}

/// Output the current number of desktops.
/// 
/// # Examples
/// 
/// ```
/// # use xdotool::desktop;
/// let output = desktop::get_num_desktops();
/// println!("{}", String::from_utf8(output.stdout)?);
/// # Ok::<(), std::string::FromUtf8Error>(())
/// ```
pub fn get_num_desktops() -> Output {
    let c = Command::Desktop(sub_commands::Desktop::GetNumDesktops);
    run(c, "")
}

/// Move the viewport to the given position. Not all requests will be obeyed. 
pub fn set_desktop_viewport(x: u16, y: u16) -> Output {
    let c = Command::Desktop(sub_commands::Desktop::SetDesktopViewport);
    let args = format!("{} {}", x, y);
    run(c, &args)
}

/// Report the current viewport's position.
/// 
/// Viewports are sometimes used instead of 'virtual desktops' on the some window managers.
/// A viewport is simply a view on a very large desktop area.
pub fn get_desktop_viewport() -> Output {
    let c = Command::Desktop(sub_commands::Desktop::GetDesktopViewport);
    run(c, "")
}

/// Switch to the specified desktop.
/// 
/// # Options 
/// 
/// - `SetDesktopOption::Relative` Use relative movement instead of absolute. This lets you move relative to the current desktop.
pub fn set_desktop(desktop_number: u8, options: OptionVec<SetDesktopOption>) -> Output {
    let c = Command::Desktop(sub_commands::Desktop::SetDesktop(options));
    run(c, &desktop_number.to_string())
}

/// Output the current desktop in view.
pub fn get_desktop() -> Output {
    let c = Command::Desktop(sub_commands::Desktop::GetDesktop);
    run(c, "")
}

/// Move a window to a different desktop.
pub fn set_desktop_for_window(window: &str, desktop_number: u8) -> Output {
    let c = Command::Desktop(sub_commands::Desktop::SetDesktopForWindow);
    let args = format!("{} {}", window, desktop_number);
    run(c, &args)
}

/// Output the desktop currently containing the given window.
pub fn get_desktop_for_window(window: &str) -> Output {
    let c = Command::Desktop(sub_commands::Desktop::GetDesktopForWindow);
    run(c, window)
}