ext_workspace_handle_v1¤
A workspace handing a group of surfaces
A ext_workspace_handle_v1 object represents a workspace that handles a group of surfaces.
Each workspace has: - a name, conveyed to the client with the name event - potentially an id conveyed with the id event - a list of states, conveyed to the client with the state event - and optionally a set of coordinates, conveyed to the client with the coordinates event
The client may request that the compositor activate or deactivate the workspace.
Each workspace can belong to only a single workspace group. Depending on the compositor policy, there might be workspaces with the same name in different workspace groups, but these workspaces are still separate (e.g. one of them might be active while the other is not).
Methods:
-
destroy–Destroy the ext_workspace_handle_v1 object
-
activate–Activate the workspace
-
deactivate–Deactivate the workspace
-
assign–Assign workspace to group
-
remove–Remove the workspace
-
on_id–Workspace id.
-
on_name–Workspace name changed.
-
on_coordinates–Workspace coordinates changed.
-
on_state–The state of the workspace changed.
-
on_capabilities–Compositor capabilities.
-
on_removed–This workspace has been removed.
Types of states on the workspace
The different states that a workspace can have.
-
activate–Activate request is available -
deactivate–Deactivate request is available -
remove–Remove request is available -
assign–Assign request is available
id(id: str) -> None
Workspace id
If this event is emitted, it will be send immediately after the ext_workspace_handle_v1 is created or when an id is assigned to a workspace (at most once during it's lifetime).
An id will never change during the lifetime of the ext_workspace_handle_v1 and is guaranteed to be unique during it's lifetime.
Ids are not human-readable and shouldn't be displayed, use name for that purpose.
Compositors are expected to only send ids for workspaces likely stable across multiple sessions and can be used by clients to store preferences for workspaces. Workspaces without ids should be considered temporary and any data associated with them should be deleted once the respective object is lost.
name(name: str) -> None
Workspace name changed
This event is emitted immediately after the ext_workspace_handle_v1 is created and whenever the name of the workspace changes.
A name is meant to be human-readable and can be displayed to a user. Unlike the id it is neither stable nor unique.
coordinates(coordinates: list) -> None
Workspace coordinates changed
This event is used to organize workspaces into an N-dimensional grid within a workspace group, and if supported, is emitted immediately after the ext_workspace_handle_v1 is created and whenever the coordinates of the workspace change. Compositors may not send this event if they do not conceptually arrange workspaces in this way. If compositors simply number workspaces, without any geometric interpretation, they may send 1D coordinates, which clients should not interpret as implying any geometry. Sending an empty array means that the compositor no longer orders the workspace geometrically.
Coordinates have an arbitrary number of dimensions N with an uint32 position along each dimension. By convention if N > 1, the first dimension is X, the second Y, the third Z, and so on. The compositor may chose to utilize these events for a more novel workspace layout convention, however. No guarantee is made about the grid being filled or bounded; there may be a workspace at coordinate 1 and another at coordinate 1000 and none in between. Within a workspace group, however, workspaces must have unique coordinates of equal dimensionality.
state(state: state) -> None
The state of the workspace changed
This event is emitted immediately after the ext_workspace_handle_v1 is created and each time the workspace state changes, either because of a compositor action or because of a request in this protocol.
Missing states convey the opposite meaning, e.g. an unset active bit means the workspace is currently inactive.
capabilities(capabilities: workspace_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 removing workspaces, a button triggering the remove request should not be displayed.
The compositor will ignore requests it doesn't support. For instance, a compositor which doesn't advertise support for remove will ignore remove requests.
Compositors must send this event once after creation of an ext_workspace_handle_v1 . When the capabilities change, compositors must send this event again.
Parameters:
-
(capabilities¤workspace_capabilities) –Capabilities
removed() -> None
This workspace has been removed
This event is send when the workspace associated with the ext_workspace_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_handle_v1.
The compositor must only remove a workspaces not currently belonging to any workspace_group.
destroy() -> None
Destroy the ext_workspace_handle_v1 object
Destroys the ext_workspace_handle_v1 object.
This request should be made either when the client does not want to use the workspace object any more or after the remove event to finalize the destruction of the object.
activate() -> None
Activate the workspace
Request that this workspace be activated.
There is no guarantee the workspace will be actually activated, and behaviour may be compositor-dependent. For example, activating a workspace may or may not deactivate all other workspaces in the same group.
deactivate() -> None
Deactivate the workspace
Request that this workspace be deactivated.
There is no guarantee the workspace will be actually deactivated.
assign(workspace_group: ext_workspace_group_handle_v1) -> None
Assign workspace to group
Requests that this workspace is assigned to the given workspace group.
There is no guarantee the workspace will be assigned.
remove() -> None
Remove the workspace
Request that this workspace be removed.
There is no guarantee the workspace will be actually removed.
on_id(id: str) -> None
Workspace id.
Override to handle wayland.ext_workspace_handle_v1.events.id.
on_name(name: str) -> None
Workspace name changed.
Override to handle wayland.ext_workspace_handle_v1.events.name.
on_coordinates(coordinates: list) -> None
Workspace coordinates changed.
Override to handle wayland.ext_workspace_handle_v1.events.coordinates.
on_state(state: state) -> None
The state of the workspace changed.
Override to handle wayland.ext_workspace_handle_v1.events.state.
on_capabilities(capabilities: workspace_capabilities) -> None
Compositor capabilities.
Override to handle wayland.ext_workspace_handle_v1.events.capabilities.
on_removed() -> None
This workspace has been removed.
Override to handle wayland.ext_workspace_handle_v1.events.removed.