Enum Event 

pub enum Event {
    WorkspacesChanged {
        workspaces: Vec<Workspace>,
    },
    WorkspaceUrgencyChanged {
        id: u64,
        urgent: bool,
    },
    WorkspaceActivated {
        id: u64,
        focused: bool,
    },
    WorkspaceActiveWindowChanged {
        workspace_id: u64,
        active_window_id: Option<u64>,
    },
    WindowsChanged {
        windows: Vec<Window>,
    },
    WindowOpenedOrChanged {
        window: Window,
    },
    WindowClosed {
        id: u64,
    },
    WindowFocusChanged {
        id: Option<u64>,
    },
    WindowUrgencyChanged {
        id: u64,
        urgent: bool,
    },
    WindowLayoutsChanged {
        changes: Vec<(u64, WindowLayout)>,
    },
    KeyboardLayoutsChanged {
        keyboard_layouts: KeyboardLayouts,
    },
    KeyboardLayoutSwitched {
        idx: u8,
    },
    OverviewOpenedOrClosed {
        is_open: bool,
    },
    ConfigLoaded {
        failed: bool,
    },
}

A compositor event.

Variants

WorkspacesChanged

The workspace configuration has changed.

Fields

workspaces: Vec<Workspace>

The new workspace configuration.

This configuration completely replaces the previous configuration. I.e. if any workspaces are missing from here, then they were deleted.

WorkspaceUrgencyChanged

The workspace urgency changed.

Fields

id: u64

Id of the workspace.

urgent: bool

Whether this workspace has an urgent window.

WorkspaceActivated

A workspace was activated on an output.

This doesn’t always mean the workspace became focused, just that it’s now the active workspace on its output. All other workspaces on the same output become inactive.

Fields

id: u64

Id of the newly active workspace.

focused: bool

Whether this workspace also became focused.

If true, this is now the single focused workspace. All other workspaces are no longer focused, but they may remain active on their respective outputs.

WorkspaceActiveWindowChanged

An active window changed on a workspace.

Fields

workspace_id: u64

Id of the workspace on which the active window changed.

active_window_id: Option<u64>

Id of the new active window, if any.

WindowsChanged

The window configuration has changed.

Fields

windows: Vec<Window>

The new window configuration.

This configuration completely replaces the previous configuration. I.e. if any windows are missing from here, then they were closed.

WindowOpenedOrChanged

A new toplevel window was opened, or an existing toplevel window changed.

Fields

window: Window

The new or updated window.

If the window is focused, all other windows are no longer focused.

WindowClosed

A toplevel window was closed.

Fields

id: u64

Id of the removed window.

WindowFocusChanged

Window focus changed.

All other windows are no longer focused.

Fields

id: Option<u64>

Id of the newly focused window, or None if no window is now focused.

WindowUrgencyChanged

Window urgency changed.

Fields

id: u64

Id of the window.

urgent: bool

The new urgency state of the window.

WindowLayoutsChanged

The layout of one or more windows has changed.

Fields

changes: Vec<(u64, WindowLayout)>

Pairs consisting of a window id and new layout information for the window.

KeyboardLayoutsChanged

The configured keyboard layouts have changed.

Fields

keyboard_layouts: KeyboardLayouts

The new keyboard layout configuration.

KeyboardLayoutSwitched

The keyboard layout switched.

Fields

idx: u8

Index of the newly active layout.

OverviewOpenedOrClosed

The overview was opened or closed.

Fields

is_open: bool

The new state of the overview.

ConfigLoaded

The configuration was reloaded.

You will always receive this event when connecting to the event stream, indicating the last config load attempt.

Fields

failed: bool

Whether the loading failed.

For example, the config file couldn’t be parsed.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Event

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Event

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

where __S: Serializer,

Serialize this value into the given Serde serializer.