Enum Event

#[non_exhaustive]
pub enum Event<'a> {
    Capabilities {
        capabilities: Vec<u8>,
    },
    OutputEnter {
        output: WlOutput,
    },
    OutputLeave {
        output: WlOutput,
    },
    Workspace {
        workspace: ZcosmicWorkspaceHandleV1,
    },
    Remove,
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Capabilities

compositor capabilities

This event advertises the capabilities supported by the compositor. If a capability isn’t supported, clients should hide or disable the UI elements that expose this functionality. For instance, if the compositor doesn’t advertise support for creating workspaces, a button triggering the create_workspace request should not be displayed.

The compositor will ignore requests it doesn’t support. For instance, a compositor which doesn’t advertise support for creating workspaces will ignore create_workspace requests.

Compositors must send this event once after creation of an zcosmic_workspace_group_handle_v1 . When the capabilities change, compositors must send this event again.

The capabilities are sent as an array of 32-bit unsigned integers in native endianness.

Fields

capabilities: Vec<u8>

array of 32-bit capabilities

OutputEnter

output assigned to workspace group

This event is emitted whenever an output is assigned to the workspace group.

Fields

output: WlOutput

OutputLeave

output removed from workspace group

This event is emitted whenever an output is removed from the workspace group.

Fields

output: WlOutput

Workspace

workspace added to workspace group

This event is emitted whenever a new workspace has been created. A workspace can only be a member of a single workspace group and cannot be re-assigned.

All initial details of the workspace (name, coordinates, state) will be sent immediately after this event via the corresponding events in zcosmic_workspace_handle_v1.

Fields

workspace: ZcosmicWorkspaceHandleV1

Remove

this workspace group has been destroyed

This event means the zcosmic_workspace_group_handle_v1 has been destroyed. It is guaranteed there won’t be any more events for this zcosmic_workspace_group_handle_v1. The zext_workspace_group_handle_v1 becomes inert so any requests will be ignored except the destroy request.

The compositor must remove all workspaces belonging to a workspace group before removing the workspace group.

Implementations

impl<'a> Event<'a>

pub fn opcode(&self) -> u16

Get the opcode number of this message

Trait Implementations

impl<'a> Debug for Event<'a>

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

Formats the value using the given formatter.