aboutsummaryrefslogtreecommitdiff
path: root/protocol/river-status-unstable-v1.xml
blob: fb597ced16463d5d6b1f44fb62b8d043019dd8e4 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
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>