mirrors/wlroots
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wlroots/wlroots.git synced 2025-11-02 09:01:38 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

take newest ext-workspace version

Browse source
This commit is contained in:
Ilia Bozhinov 2021-02-17 07:54:06 +01:00
parent 754fb31f04
commit 284dc3d251
2 changed files with 71 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

104
protocol/wlr-workspace-unstable-v1.xml → protocol/ext-workspace-unstable-v1.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<protocol name="wlr_workspace_unstable_v1"> <protocol name="ext_workspace_unstable_v1">
<copyright> <copyright>
Copyright © 2019 Christopher Billington Copyright © 2019 Christopher Billington
Copyright © 2020 Ilia Bozhinov Copyright © 2020 Ilia Bozhinov
@ -26,7 +26,7 @@
THIS SOFTWARE. THIS SOFTWARE.
</copyright> </copyright>
<interface name="zwlr_workspace_manager_v1" version="1"> <interface name="zext_workspace_manager_v1" version="1">
<description summary="list and control workspaces"> <description summary="list and control workspaces">
Workspaces, also called virtual desktops, are groups of surfaces. A Workspaces, also called virtual desktops, are groups of surfaces. A
compositor with a concept of workspaces may only show some such groups of compositor with a concept of workspaces may only show some such groups of
@ -45,7 +45,7 @@
docks by providing them with a list of workspaces and their properties, docks by providing them with a list of workspaces and their properties,
and allowing them to activate and deactivate workspaces. and allowing them to activate and deactivate workspaces.
After a client binds the zwlr_workspace_manager_v1, each workspace will be After a client binds the zext_workspace_manager_v1, each workspace will be
sent via the workspace event. sent via the workspace event.
</description> </description>
@ -55,9 +55,9 @@
All initial details of the workspace group (workspaces, outputs) will be All initial details of the workspace group (workspaces, outputs) will be
sent immediately after this event via the corresponding events in sent immediately after this event via the corresponding events in
zwlr_workspace_group_handle_v1. zext_workspace_group_handle_v1.
</description> </description>
<arg name="workspace_group" type="new_id" interface="zwlr_workspace_group_handle_v1"/> <arg name="workspace_group" type="new_id" interface="zext_workspace_group_handle_v1"/>
</event> </event>
<request name="commit"> <request name="commit">
@ -68,21 +68,21 @@
This allows changes to the workspace properties to be seen as atomic, This allows changes to the workspace properties to be seen as atomic,
even if they happen via multiple events, and even if they involve even if they happen via multiple events, and even if they involve
multiple zwlr_workspace_handle_v1 objects, for example, deactivating one multiple zext_workspace_handle_v1 objects, for example, deactivating one
workspace and activating another. workspace and activating another.
</description> </description>
</request> </request>
<event name="done"> <event name="done">
<description summary="all information about the workspace groups has been sent"> <description summary="all information about the workspace groups has been sent">
This event is sent after all changes in all workspace groups have been This event is sent after all changes in all workspace groups have been
sent. sent.
This allows changes to one or more zwlr_workspace_group_handle_v1 This allows changes to one or more zext_workspace_group_handle_v1
properties to be seen as atomic, even if they happen via multiple properties to be seen as atomic, even if they happen via multiple
events. In particular, an output moving from one workspace group to events. In particular, an output moving from one workspace group to
another sends an output_enter event and an output_leave event to the two another sends an output_enter event and an output_leave event to the two
zwlr_workspace_group_handle_v1 objects in question. The compositor sends zext_workspace_group_handle_v1 objects in question. The compositor sends
the done event only after updating the output information in both the done event only after updating the output information in both
workspace groups. workspace groups.
</description> </description>
@ -91,7 +91,7 @@
<event name="finished"> <event name="finished">
<description summary="the compositor has finished with the workspace_manager"> <description summary="the compositor has finished with the workspace_manager">
This event indicates that the compositor is done sending events to the This event indicates that the compositor is done sending events to the
zwlr_workspace_manager_v1. The server will destroy the object zext_workspace_manager_v1. The server will destroy the object
immediately after sending this request, so it will become invalid and immediately after sending this request, so it will become invalid and
the client should free any resources associated with it. the client should free any resources associated with it.
</description> </description>
@ -108,14 +108,19 @@
</request> </request>
</interface> </interface>
<interface name="zwlr_workspace_group_handle_v1" version="1"> <interface name="zext_workspace_group_handle_v1" version="1">
<description summary="a workspace group assigned to a set of outputs"> <description summary="a workspace group assigned to a set of outputs">
A zwlr_workspace_group_handle_v1 object represents a a workspace group A zext_workspace_group_handle_v1 object represents a a workspace group
that is assigned a set of outputs and contains a number of workspaces. 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 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 output_enter and output_leave events, and its workspaces are conveyed with
workspace events. 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.
</description> </description>
<event name="output_enter"> <event name="output_enter">
@ -140,26 +145,36 @@
All initial details of the workspace (name, coordinates, state) will All initial details of the workspace (name, coordinates, state) will
be sent immediately after this event via the corresponding events in be sent immediately after this event via the corresponding events in
zwlr_workspace_handle_v1. zext_workspace_handle_v1.
</description> </description>
<arg name="workspace" type="new_id" interface="zwlr_workspace_handle_v1"/> <arg name="workspace" type="new_id" interface="zext_workspace_handle_v1"/>
</event> </event>
<event name="remove"> <event name="remove">
<description summary="this workspace group has been destroyed"> <description summary="this workspace group has been destroyed">
This event means the zwlr_workspace_group_handle_v1 has been destroyed. This event means the zext_workspace_group_handle_v1 has been destroyed.
It is guaranteed there won't be any more events for this It is guaranteed there won't be any more events for this
zwlr_workspace_group_handle_v1. The zwlr_workspace_group_handle_v1 becomes zext_workspace_group_handle_v1. The zext_workspace_group_handle_v1 becomes
inert so any requests will be ignored except the destroy request. inert so any requests will be ignored except the destroy request.
The compositor must remove all workspaces belonging to a workspace group The compositor must remove all workspaces belonging to a workspace group
before removing the workspace group. before removing the workspace group.
</description> </description>
</event> </event>
<request name="create_workspace">
<description summary="create a new workspace">
Request that the compositor create a new workspace with the given name.
There is no guarantee that the compositor will create a new workspace,
or that the created workspace will have the provided name.
</description>
<arg name="workspace" type="string"/>
</request>
<request name="destroy" type="destructor"> <request name="destroy" type="destructor">
<description summary="destroy the zwlr_workspace_handle_v1 object"> <description summary="destroy the zext_workspace_handle_v1 object">
Destroys the zwlr_workspace_handle_v1 object. Destroys the zext_workspace_handle_v1 object.
This request should be called either when the client does not want to This request should be called either when the client does not want to
use the workspace object any more or after the remove event to finalize use the workspace object any more or after the remove event to finalize
@ -168,9 +183,9 @@
</request> </request>
</interface> </interface>
<interface name="zwlr_workspace_handle_v1" version="1"> <interface name="zext_workspace_handle_v1" version="1">
<description summary="a workspace handing a group of surfaces"> <description summary="a workspace handing a group of surfaces">
A zwlr_workspace_handle_v1 object represents a a workspace that handles a A zext_workspace_handle_v1 object represents a a workspace that handles a
group of surfaces. group of surfaces.
Each workspace has a name, conveyed to the client with the name event; a Each workspace has a name, conveyed to the client with the name event; a
@ -178,11 +193,16 @@
optionally a set of coordinates, conveyed to the client with the optionally a set of coordinates, conveyed to the client with the
coordinates event. The client may request that the compositor activate or coordinates event. The client may request that the compositor activate or
deactivate the workspace. deactivate the workspace.
Each workspace can belong to only a single workspace group.
Depepending 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).
</description> </description>
<event name="name"> <event name="name">
<description summary="workspace name changed"> <description summary="workspace name changed">
This event is emitted immediately after the zwlr_workspace_handle_v1 is This event is emitted immediately after the zext_workspace_handle_v1 is
created and whenever the name of the workspace changes. created and whenever the name of the workspace changes.
</description> </description>
<arg name="name" type="string"/> <arg name="name" type="string"/>
@ -192,13 +212,13 @@
<description summary="workspace coordinates changed"> <description summary="workspace coordinates changed">
This event is used to organize workspaces into an N-dimensional grid This event is used to organize workspaces into an N-dimensional grid
within a workspace group, and if supported, is emitted immediately after within a workspace group, and if supported, is emitted immediately after
the zwlr_workspace_handle_v1 is created and whenever the coordinates of the zext_workspace_handle_v1 is created and whenever the coordinates of
the workspace change. Compositors may not send this event if they do not the workspace change. Compositors may not send this event if they do not
conceptually arrange workspaces in this way. If compositors simply conceptually arrange workspaces in this way. If compositors simply
number workspaces, without any geometric interpretation, they may send number workspaces, without any geometric interpretation, they may send
1D coordinates, which clients should not interpret as implying any 1D coordinates, which clients should not interpret as implying any
geometry. Sending an empty array means that the compositor no longer geometry. Sending an empty array means that the compositor no longer
orders the workspace geometrically. orders the workspace geometrically.
Coordinates have an arbitrary number of dimensions N with an uint32 Coordinates have an arbitrary number of dimensions N with an uint32
position along each dimension. By convention if N > 1, the first position along each dimension. By convention if N > 1, the first
@ -214,7 +234,7 @@
<event name="state"> <event name="state">
<description summary="the state of the workspace changed"> <description summary="the state of the workspace changed">
This event is emitted immediately after the zwlr_workspace_handle_v1 is This event is emitted immediately after the zext_workspace_handle_v1 is
created and each time the workspace state changes, either because of a created and each time the workspace state changes, either because of a
compositor action or because of a request in this protocol. compositor action or because of a request in this protocol.
</description> </description>
@ -227,20 +247,28 @@
</description> </description>
<entry name="active" value="0" summary="the workspace is active"/> <entry name="active" value="0" summary="the workspace is active"/>
<entry name="urgent" value="1" summary="the workspace requests attention"/>
<entry name="hidden" value="2">
<description summary="the workspace is not visible">
The workspace is not visible in its workspace group, and clients
attempting to visualize the compositor workspace state should not
display such workspaces.
</description>
</entry>
</enum> </enum>
<event name="remove"> <event name="remove">
<description summary="this workspace has been destroyed"> <description summary="this workspace has been destroyed">
This event means the zwlr_workspace_handle_v1 has been destroyed. It is This event means the zext_workspace_handle_v1 has been destroyed. It is
guaranteed there won't be any more events for this guaranteed there won't be any more events for this
zwlr_workspace_handle_v1. The zwlr_workspace_handle_v1 becomes inert so zext_workspace_handle_v1. The zext_workspace_handle_v1 becomes inert so
any requests will be ignored except the destroy request. any requests will be ignored except the destroy request.
</description> </description>
</event> </event>
<request name="destroy" type="destructor"> <request name="destroy" type="destructor">
<description summary="destroy the zwlr_workspace_handle_v1 object"> <description summary="destroy the zext_workspace_handle_v1 object">
Destroys the zwlr_workspace_handle_v1 object. Destroys the zext_workspace_handle_v1 object.
This request should be called either when the client does not want to This request should be called either when the client does not want to
use the workspace object any more or after the remove event to finalize use the workspace object any more or after the remove event to finalize
@ -266,5 +294,13 @@
There is no guarantee the workspace will be actually deactivated. There is no guarantee the workspace will be actually deactivated.
</description> </description>
</request> </request>
<request name="remove">
<description summary="remove the workspace">
Request that this workspace be removed.
There is no guarantee the workspace will be actually removed.
</description>
</request>
</interface> </interface>
</protocol> </protocol>

2
protocol/meson.build
View file

@ -43,7 +43,7 @@ protocols = {
'wlr-output-power-management-unstable-v1': 'wlr-output-power-management-unstable-v1.xml', 'wlr-output-power-management-unstable-v1': 'wlr-output-power-management-unstable-v1.xml',
'wlr-screencopy-unstable-v1': 'wlr-screencopy-unstable-v1.xml', 'wlr-screencopy-unstable-v1': 'wlr-screencopy-unstable-v1.xml',
'wlr-virtual-pointer-unstable-v1': 'wlr-virtual-pointer-unstable-v1.xml', 'wlr-virtual-pointer-unstable-v1': 'wlr-virtual-pointer-unstable-v1.xml',
'wlr-workspace-unstable-v1': 'wlr-workspace-unstable-v1.xml', 'ext-workspace-unstable-v1': 'ext-workspace-unstable-v1.xml',
} }
protocols_code = {} protocols_code = {}