Define the river status protocol
This is a refinement of the now obsolete river-window-management protocol which has been deleted.
This commit is contained in:
Isaac Freund
parent
03fc51d8d6
commit
b69196aafa
54
protocol/river-status-unstable-v1.xml
Normal file
54
protocol/river-status-unstable-v1.xml
Normal file
@ -0,0 +1,54 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<protocol name="river_status_unstable_v1">
|
||||||
|
<copyright>
|
||||||
|
Copyright 2020 Isaac Freund
|
||||||
|
|
||||||
|
Permission to use, copy, modify, and/or distribute this software for any
|
||||||
|
purpose with or without fee is hereby granted, provided that the above
|
||||||
|
copyright notice and this permission notice appear in all copies.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||||
|
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||||
|
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||||
|
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||||
|
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||||
|
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||||
|
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||||
|
</copyright>
|
||||||
|
|
||||||
|
<interface name="zriver_status_v1" version="1">
|
||||||
|
<description summary="track tags and focus">
|
||||||
|
This protocol allows clients to receive information about the current
|
||||||
|
windowing state. It can be used to implement, for example, a status bar
|
||||||
|
displaying information specific to river.
|
||||||
|
</description>
|
||||||
|
|
||||||
|
<event name="focused_tags">
|
||||||
|
<description summary="focused tags of an output">
|
||||||
|
Sent once for each output on binding the interface and again whenever
|
||||||
|
the tag focus of an output changes.
|
||||||
|
</description>
|
||||||
|
<arg name="output" type="object" interface="wl_output"/>
|
||||||
|
<arg name="tags" type="uint" summary="32-bit bitfield"/>
|
||||||
|
</event>
|
||||||
|
|
||||||
|
<event name="view_tags">
|
||||||
|
<description summary="tag state of an output's views">
|
||||||
|
Sent once for each output on binding the interface and again whenever
|
||||||
|
the state changes.
|
||||||
|
</description>
|
||||||
|
<arg name="output" type="object" interface="wl_output"/>
|
||||||
|
<arg name="tags" type="array" summary="array of 32-bit bitfields"/>
|
||||||
|
</event>
|
||||||
|
|
||||||
|
<event name="focused_title">
|
||||||
|
<description summary="focused view title">
|
||||||
|
This event is sent for each output on binding the interface and when
|
||||||
|
the focused view or title thereof changes. The title may be an empty
|
||||||
|
string if no view is focused or the focused view did not set a title.
|
||||||
|
</description>
|
||||||
|
<arg name="output" type="object" interface="wl_output"/>
|
||||||
|
<arg name="title" type="string" summary="title of the focused view"/>
|
||||||
|
</event>
|
||||||
|
</interface>
|
||||||
|
</protocol>
|
||||||
@ -1,47 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
<protocol name="river_window_management_unstable_v1">
|
|
||||||
<copyright>
|
|
||||||
Copyright 2020 Isaac Freund
|
|
||||||
|
|
||||||
Permission to use, copy, modify, and/or distribute this software for any
|
|
||||||
purpose with or without fee is hereby granted, provided that the above
|
|
||||||
copyright notice and this permission notice appear in all copies.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
||||||
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
||||||
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
||||||
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
||||||
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
||||||
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
||||||
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
||||||
</copyright>
|
|
||||||
|
|
||||||
<interface name="zriver_window_manager_v1" version="1">
|
|
||||||
<description summary="track windowing state">
|
|
||||||
This protocol allows clients to recieve information about the current
|
|
||||||
windowing state. It is useful to implement, for example, a status bar
|
|
||||||
displaying information specific to the river compositor.
|
|
||||||
</description>
|
|
||||||
|
|
||||||
<event name="focus">
|
|
||||||
<description summary="sent when a view gains focus">
|
|
||||||
</description>
|
|
||||||
<arg name="app_id" type="string" summary="the app_id of the view"/>
|
|
||||||
<arg name="title" type="string" summary="the title of the view"/>
|
|
||||||
</event>
|
|
||||||
|
|
||||||
<event name="output_windowing_state">
|
|
||||||
<description summary="signal output windowing state change">
|
|
||||||
Sent whenever the windowing state of an output changes. The output_name
|
|
||||||
argument is the same as the name returned by the xdg-output protocol.
|
|
||||||
Tags are sent as a bitfield, if a view has one of the focused tags set,
|
|
||||||
then it is displayed on the output.
|
|
||||||
</description>
|
|
||||||
<arg name="output_name" type="string" summary="the name of the output"/>
|
|
||||||
<arg name="output_tags" type="uint"
|
|
||||||
summary="the currently focused tags of the output"/>
|
|
||||||
<arg name="view_tags" type="array"
|
|
||||||
summary="the current tags of each view on the output"/>
|
|
||||||
</event>
|
|
||||||
</interface>
|
|
||||||
</protocol>
|
|
||||||
Loading…
Reference in New Issue
Block a user