ext_workspace_group_handle_v1¤
A workspace group assigned to a set of outputs
A ext_workspace_group_handle_v1 object represents a workspace group that is assigned a set of outputs and contains a number of workspaces.
The set of outputs assigned to the workspace group is conveyed to the client via output_enter and output_leave events, and its workspaces are conveyed with workspace events.
For example, a compositor which has a set of workspaces for each output may advertise a workspace group (and its workspaces) per output, whereas a compositor where a workspace spans all outputs may advertise a single workspace group for all outputs.
Methods:
-
create_workspace–Create a new workspace
-
destroy–Destroy the ext_workspace_group_handle_v1 object
-
on_capabilities–Compositor capabilities.
-
on_output_enter–Output assigned to workspace group.
-
on_output_leave–Output removed from workspace group.
-
on_workspace_enter–Workspace added to workspace group.
-
on_workspace_leave–Workspace removed from workspace group.
-
on_removed–This workspace group has been removed.
-
create_workspace–`create_workspace` request is available
capabilities(capabilities: group_capabilities) -> None
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 ext_workspace_group_handle_v1. When the capabilities change, compositors must send this event again.
Parameters:
-
(capabilities¤group_capabilities) –Capabilities
output_enter(output: wl_output) -> None
Output assigned to workspace group
This event is emitted whenever an output is assigned to the workspace group or a new wl_output object is bound by the client, which was already assigned to this workspace_group.
output_leave(output: wl_output) -> None
Output removed from workspace group
This event is emitted whenever an output is removed from the workspace group.
workspace_enter(workspace: ext_workspace_handle_v1) -> None
Workspace added to workspace group
This event is emitted whenever a workspace is assigned to this group. A workspace may only ever be assigned to a single group at a single point in time, but can be re-assigned during it's lifetime.
workspace_leave(workspace: ext_workspace_handle_v1) -> None
Workspace removed from workspace group
This event is emitted whenever a workspace is removed from this group.
removed() -> None
This workspace group has been removed
This event is send when the group associated with the ext_workspace_group_handle_v1 has been removed. After sending this request the compositor will immediately consider the object inert. Any requests will be ignored except the destroy request. It is guaranteed there won't be any more events referencing this ext_workspace_group_handle_v1.
The compositor must remove all workspaces belonging to a workspace group via a workspace_leave event before removing the workspace group.
create_workspace(workspace: str) -> None
Create a new workspace
Request that the compositor create a new workspace with the given name and assign it to this group.
There is no guarantee that the compositor will create a new workspace, or that the created workspace will have the provided name.
destroy() -> None
Destroy the ext_workspace_group_handle_v1 object
Destroys the ext_workspace_group_handle_v1 object.
This request should be send either when the client does not want to use the workspace group object any more or after the removed event to finalize the destruction of the object.
on_capabilities(capabilities: group_capabilities) -> None
Compositor capabilities.
Override to handle wayland.ext_workspace_group_handle_v1.events.capabilities.
on_output_enter(output: wl_output) -> None
Output assigned to workspace group.
Override to handle wayland.ext_workspace_group_handle_v1.events.output_enter.
on_output_leave(output: wl_output) -> None
Output removed from workspace group.
Override to handle wayland.ext_workspace_group_handle_v1.events.output_leave.
on_workspace_enter(workspace: ext_workspace_handle_v1) -> None
Workspace added to workspace group.
Override to handle wayland.ext_workspace_group_handle_v1.events.workspace_enter.
on_workspace_leave(workspace: ext_workspace_handle_v1) -> None
Workspace removed from workspace group.
Override to handle wayland.ext_workspace_group_handle_v1.events.workspace_leave.
on_removed() -> None
This workspace group has been removed.
Override to handle wayland.ext_workspace_group_handle_v1.events.removed.