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

<?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>

        <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>

        <event name="tag">
            <description summary="announces the presence of a tag">
            </description>
            <arg name="name" type="string"/>
        </event>

        <event name="layout">
            <description summary="announces the presence of a layout">
            </description>
            <arg name="name" type="string"/>
        </event>
    </interface>

    <interface name="znet_tapesoftware_dwl_wm_monitor_v1" version="1">
        <description summary="control one monitor">
        </description>

        <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>

        <request name="release" type="destructor">
            <description summary="release dwl_monitor">
            </description>
        </request>

        <event name="selected">
            <description summary="updates the selected state of the monitor">
            </description>
            <arg name="selected" type="uint"/>
        </event>

        <event name="tag">
            <description summary="updates the state of one tag">
            </description>
            <arg name="tag" type="uint"/>
            <arg name="state" type="uint" enum="tag_state"/>
            <arg name="num_clients" type="uint"/>
            <arg name="focused_client" type="int" summary="-1 if there is no focused client"/>
        </event>

        <event name="layout">
            <description summary="updates the selected layout">
            </description>
            <arg name="layout" type="uint"/>
        </event>

        <event name="title">
            <description summary="updates the focused client">
            </description>
            <arg name="title" type="string"/>
        </event>

        <event name="frame">
            <description summary="sent after all other events have been sent. allows for atomic updates.">
            </description>
        </event>

        <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>

        <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>

        <request name="set_layout">
            <description summary="sets the active layout on this monitor. changes are applied immediately.">
            </description>
            <arg name="layout" type="uint"/>
        </request>
    </interface>
</protocol>