somebar/protocols/net-tapesoftware-dwl-wm-unstable-v1.xml

130 lines
5.1 KiB
XML
Raw Normal View History

2021-10-22 16:32:58 +00:00
<?xml version="1.0" encoding="UTF-8"?>
<protocol name="net_tapesoftware_dwl_wm_unstable_v1">
<copyright>
Copyright © 2021 Raphael Robatsch
Permission to use, copy, modify, distribute, and sell this
software and its documentation for any purpose is hereby granted
without fee, provided that the above copyright notice appear in
all copies and that both that copyright notice and this permission
notice appear in supporting documentation, and that the name of
the copyright holders not be used in advertising or publicity
pertaining to distribution of the software without specific,
written prior permission. The copyright holders make no
representations about the suitability of this software for any
purpose. It is provided "as is" without express or implied
warranty.
THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
SPECIAL, 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="znet_tapesoftware_dwl_wm_v1" version="1">
<description summary="control the dwl state">
Clients can use this protcol to receive updates of the window manager
state (active tags, active layout, and focused window).
Clients can also control this state.
</description>
<request name="release" type="destructor">
<description summary="release dwl_wm">
</description>
</request>
2021-10-25 13:49:01 +00:00
<request name="get_monitor">
<description summary="gets a dwl monitor from an output">
</description>
<arg name="id" type="new_id" interface="znet_tapesoftware_dwl_wm_monitor_v1" />
<arg name="output" type="object" interface="wl_output" />
</request>
2021-10-22 16:32:58 +00:00
<event name="tag">
<description summary="announces the presence of a tag">
</description>
<arg name="name" type="string"/>
</event>
2021-10-25 19:54:14 +00:00
<event name="layout">
<description summary="announces the presence of a layout">
</description>
<arg name="name" type="string"/>
</event>
2021-10-22 16:32:58 +00:00
</interface>
2021-10-25 13:49:01 +00:00
<interface name="znet_tapesoftware_dwl_wm_monitor_v1" version="1">
<description summary="control one monitor">
</description>
2021-10-25 18:52:21 +00:00
<enum name="tag_state">
<entry name="none" value="0" summary="no state"/>
<entry name="active" value="1" summary="tag is active"/>
<entry name="urgent" value="2" summary="tag has at least one urgent client"/>
</enum>
2021-10-25 13:49:01 +00:00
<request name="release" type="destructor">
<description summary="release dwl_monitor">
</description>
</request>
2021-10-25 19:54:14 +00:00
<event name="selected">
<description summary="updates the selected state of the monitor">
</description>
2021-10-26 09:40:46 +00:00
<arg name="selected" type="uint"/>
2021-10-25 19:54:14 +00:00
</event>
2021-10-25 13:49:01 +00:00
<event name="tag">
2021-10-25 19:54:14 +00:00
<description summary="updates the state of one tag">
2021-10-25 13:49:01 +00:00
</description>
2021-10-26 09:40:46 +00:00
<arg name="tag" type="uint"/>
2021-10-25 18:52:21 +00:00
<arg name="state" type="uint" enum="tag_state"/>
2021-10-26 09:40:46 +00:00
<arg name="num_clients" type="uint"/>
2021-10-25 18:52:21 +00:00
<arg name="focused_client" type="int" summary="-1 if there is no focused client"/>
2021-10-25 17:02:35 +00:00
</event>
2021-10-25 19:54:14 +00:00
<event name="layout">
<description summary="updates the selected layout">
</description>
2021-10-26 09:40:46 +00:00
<arg name="layout" type="uint"/>
2021-10-25 19:54:14 +00:00
</event>
<event name="title">
<description summary="updates the focused client">
</description>
<arg name="title" type="string"/>
</event>
2021-10-25 17:02:35 +00:00
<event name="frame">
<description summary="sent after all other events have been sent. allows for atomic updates.">
</description>
2021-10-25 13:49:01 +00:00
</event>
2021-10-26 09:40:46 +00:00
<request name="set_tags">
<description summary="sets the active tags on this monitor. changes are applied immediately.">
</description>
<arg name="tagmask" type="uint"/>
<arg name="toggle_tagset" type="uint"/>
</request>
2021-10-26 14:17:07 +00:00
<request name="set_client_tags">
<description summary="updates the tags of the focused client. changes are applied immediately.">
tags are updated as follows:
new_tags = (current_tags AND and_tags) XOR xor_tags
</description>
<arg name="and_tags" type="uint"/>
<arg name="xor_tags" type="uint"/>
</request>
2021-10-26 09:40:46 +00:00
<request name="set_layout">
<description summary="sets the active layout on this monitor. changes are applied immediately.">
</description>
<arg name="layout" type="uint"/>
</request>
2021-10-25 13:49:01 +00:00
</interface>
2021-10-22 16:32:58 +00:00
</protocol>