wayle-wallpaper 0.1.3

Wallpaper management with cycling and color extraction
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

#![allow(missing_docs)]

use zbus::{Result, proxy};

/// D-Bus client proxy for controlling the wallpaper service.
///
/// Connects to a running wallpaper daemon and allows external control
/// of wallpaper settings, cycling, and color extraction.
#[proxy(
    interface = "com.wayle.Wallpaper1",
    default_service = "com.wayle.Wallpaper1",
    default_path = "/com/wayle/Wallpaper"
)]
pub trait Wallpaper {
    /// Sets the wallpaper for a specific monitor or all monitors.
    ///
    /// An empty string for `monitor` applies to all monitors.
    async fn set_wallpaper(&self, path: String, monitor: String) -> Result<()>;

    /// Sets the fit mode for a monitor or all monitors.
    ///
    /// An empty string for `monitor` targets all monitors.
    async fn set_fit_mode(&self, mode: String, monitor: String) -> Result<()>;

    /// Starts cycling through wallpapers in a directory.
    async fn start_cycling(
        &self,
        directory: String,
        interval_secs: u32,
        mode: String,
    ) -> Result<()>;

    /// Stops wallpaper cycling.
    async fn stop_cycling(&self) -> Result<()>;

    /// Advances all monitors to the next wallpaper in the cycle.
    async fn next(&self) -> Result<()>;

    /// Rewinds all monitors to the previous wallpaper in the cycle.
    async fn previous(&self) -> Result<()>;

    /// Extracts colors from the current wallpaper.
    async fn extract_colors(&self) -> Result<()>;

    /// Gets the wallpaper path for a specific monitor.
    async fn wallpaper_for_monitor(&self, monitor: String) -> Result<String>;

    /// Gets the fit mode for a monitor.
    async fn get_fit_mode(&self, monitor: String) -> Result<String>;

    /// Checks if cycling is active.
    async fn get_is_cycling(&self) -> Result<bool>;

    /// Sets which monitor to use for color extraction theming.
    async fn set_theming_monitor(&self, monitor: String) -> Result<()>;

    /// Registers a monitor for wallpaper management.
    async fn register_monitor(&self, monitor: String) -> Result<()>;

    /// Unregisters a monitor.
    async fn unregister_monitor(&self, monitor: String) -> Result<()>;

    /// Lists all registered monitors.
    async fn list_monitors(&self) -> Result<Vec<String>>;

    /// Whether cycling is active.
    #[zbus(property)]
    fn is_cycling(&self) -> Result<bool>;

    /// The monitor used for color extraction theming (empty = default).
    #[zbus(property)]
    fn theming_monitor(&self) -> Result<String>;

    /// Fired when color extraction finishes.Useful if you need
    /// read the new color palette from the cached files for
    /// matugen/pywal/wallust.
    #[zbus(signal)]
    fn colors_extracted(&self) -> Result<()>;
}