This commit is contained in:
2025-05-19 09:32:17 +02:00
parent 5d08a48b6c
commit 8ecec8768d
27 changed files with 2752 additions and 28 deletions

View File

View File

@@ -0,0 +1,18 @@
# This file has been autogenerated by the pywayland scanner
# Copyright 2020 The River Developers
#
# 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.
from .zriver_command_callback_v1 import ZriverCommandCallbackV1 # noqa: F401
from .zriver_control_v1 import ZriverControlV1 # noqa: F401

View File

@@ -0,0 +1,84 @@
# This file has been autogenerated by the pywayland scanner
# Copyright 2020 The River Developers
#
# 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.
from __future__ import annotations
from pywayland.protocol_core import (Argument, ArgumentType, Global, Interface,
Proxy, Resource)
class ZriverCommandCallbackV1(Interface):
"""Callback object
This object is created by the run_command request. Exactly one of the
success or failure events will be sent. This object will be destroyed by
the compositor after one of the events is sent.
"""
name = "zriver_command_callback_v1"
version = 1
class ZriverCommandCallbackV1Proxy(Proxy[ZriverCommandCallbackV1]):
interface = ZriverCommandCallbackV1
class ZriverCommandCallbackV1Resource(Resource):
interface = ZriverCommandCallbackV1
@ZriverCommandCallbackV1.event(
Argument(ArgumentType.String),
)
def success(self, output: str) -> None:
"""Command successful
Sent when the command has been successfully received and executed by
the compositor. Some commands may produce output, in which case the
output argument will be a non-empty string.
:param output:
the output of the command
:type output:
`ArgumentType.String`
"""
self._post_event(0, output)
@ZriverCommandCallbackV1.event(
Argument(ArgumentType.String),
)
def failure(self, failure_message: str) -> None:
"""Command failed
Sent when the command could not be carried out. This could be due to
sending a non-existent command, no command, not enough arguments, too
many arguments, invalid arguments, etc.
:param failure_message:
a message explaining why failure occurred
:type failure_message:
`ArgumentType.String`
"""
self._post_event(1, failure_message)
class ZriverCommandCallbackV1Global(Global):
interface = ZriverCommandCallbackV1
ZriverCommandCallbackV1._gen_c()
ZriverCommandCallbackV1.proxy_class = ZriverCommandCallbackV1Proxy
ZriverCommandCallbackV1.resource_class = ZriverCommandCallbackV1Resource
ZriverCommandCallbackV1.global_class = ZriverCommandCallbackV1Global

View File

@@ -0,0 +1,111 @@
# This file has been autogenerated by the pywayland scanner
# Copyright 2020 The River Developers
#
# 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.
from __future__ import annotations
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
from pywayland.protocol.wayland import WlSeat
from .zriver_command_callback_v1 import ZriverCommandCallbackV1
class ZriverControlV1(Interface):
"""Run compositor commands
This interface allows clients to run compositor commands and receive a
success/failure response with output or a failure message respectively.
Each command is built up in a series of add_argument requests and executed
with a run_command request. The first argument is the command to be run.
A complete list of commands should be made available in the man page of the
compositor.
"""
name = "zriver_control_v1"
version = 1
class ZriverControlV1Proxy(Proxy[ZriverControlV1]):
interface = ZriverControlV1
@ZriverControlV1.request()
def destroy(self) -> None:
"""Destroy the river_control object
This request indicates that the client will not use the river_control
object any more. Objects that have been created through this instance
are not affected.
"""
self._marshal(0)
self._destroy()
@ZriverControlV1.request(
Argument(ArgumentType.String),
)
def add_argument(self, argument: str) -> None:
"""Add an argument to the current command
Arguments are stored by the server in the order they were sent until
the run_command request is made.
:param argument:
the argument to add
:type argument:
`ArgumentType.String`
"""
self._marshal(1, argument)
@ZriverControlV1.request(
Argument(ArgumentType.Object, interface=WlSeat),
Argument(ArgumentType.NewId, interface=ZriverCommandCallbackV1),
)
def run_command(self, seat: WlSeat) -> Proxy[ZriverCommandCallbackV1]:
"""Run the current command
Execute the command built up using the add_argument request for the
given seat.
:param seat:
:type seat:
:class:`~pywayland.protocol.wayland.WlSeat`
:returns:
:class:`~pywayland.protocol.river_control_unstable_v1.ZriverCommandCallbackV1`
-- callback object
"""
callback = self._marshal_constructor(2, ZriverCommandCallbackV1, seat)
return callback
class ZriverControlV1Resource(Resource):
interface = ZriverControlV1
class ZriverControlV1Global(Global):
interface = ZriverControlV1
ZriverControlV1._gen_c()
ZriverControlV1.proxy_class = ZriverControlV1Proxy
ZriverControlV1.resource_class = ZriverControlV1Resource
ZriverControlV1.global_class = ZriverControlV1Global

View File

@@ -0,0 +1,19 @@
# This file has been autogenerated by the pywayland scanner
# Copyright 2020 The River Developers
#
# 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.
from .zriver_output_status_v1 import ZriverOutputStatusV1 # noqa: F401
from .zriver_seat_status_v1 import ZriverSeatStatusV1 # noqa: F401
from .zriver_status_manager_v1 import ZriverStatusManagerV1 # noqa: F401

View File

@@ -0,0 +1,134 @@
# This file has been autogenerated by the pywayland scanner
# Copyright 2020 The River Developers
#
# 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.
from __future__ import annotations
from pywayland.protocol_core import (Argument, ArgumentType, Global, Interface,
Proxy, Resource)
class ZriverOutputStatusV1(Interface):
"""Track output tags and focus
This interface allows clients to receive information about the current
windowing state of an output.
"""
name = "zriver_output_status_v1"
version = 4
class ZriverOutputStatusV1Proxy(Proxy[ZriverOutputStatusV1]):
interface = ZriverOutputStatusV1
@ZriverOutputStatusV1.request()
def destroy(self) -> None:
"""Destroy the river_output_status object
This request indicates that the client will not use the
river_output_status object any more.
"""
self._marshal(0)
self._destroy()
class ZriverOutputStatusV1Resource(Resource):
interface = ZriverOutputStatusV1
@ZriverOutputStatusV1.event(
Argument(ArgumentType.Uint),
)
def focused_tags(self, tags: int) -> None:
"""Focused tags of the output
Sent once binding the interface and again whenever the tag focus of the
output changes.
:param tags:
32-bit bitfield
:type tags:
`ArgumentType.Uint`
"""
self._post_event(0, tags)
@ZriverOutputStatusV1.event(
Argument(ArgumentType.Array),
)
def view_tags(self, tags: list) -> None:
"""Tag state of an output's views
Sent once on binding the interface and again whenever the tag state of
the output changes.
:param tags:
array of 32-bit bitfields
:type tags:
`ArgumentType.Array`
"""
self._post_event(1, tags)
@ZriverOutputStatusV1.event(
Argument(ArgumentType.Uint),
version=2,
)
def urgent_tags(self, tags: int) -> None:
"""Tags of the output with an urgent view
Sent once on binding the interface and again whenever the set of tags
with at least one urgent view changes.
:param tags:
32-bit bitfield
:type tags:
`ArgumentType.Uint`
"""
self._post_event(2, tags)
@ZriverOutputStatusV1.event(
Argument(ArgumentType.String),
version=4,
)
def layout_name(self, name: str) -> None:
"""Name of the layout
Sent once on binding the interface should a layout name exist and again
whenever the name changes.
:param name:
layout name
:type name:
`ArgumentType.String`
"""
self._post_event(3, name)
@ZriverOutputStatusV1.event(version=4)
def layout_name_clear(self) -> None:
"""Name of the layout
Sent when the current layout name has been removed without a new one
being set, for example when the active layout generator disconnects.
"""
self._post_event(4)
class ZriverOutputStatusV1Global(Global):
interface = ZriverOutputStatusV1
ZriverOutputStatusV1._gen_c()
ZriverOutputStatusV1.proxy_class = ZriverOutputStatusV1Proxy
ZriverOutputStatusV1.resource_class = ZriverOutputStatusV1Resource
ZriverOutputStatusV1.global_class = ZriverOutputStatusV1Global

View File

@@ -0,0 +1,124 @@
# This file has been autogenerated by the pywayland scanner
# Copyright 2020 The River Developers
#
# 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.
from __future__ import annotations
from pywayland.protocol.wayland import WlOutput
from pywayland.protocol_core import (Argument, ArgumentType, Global, Interface,
Proxy, Resource)
class ZriverSeatStatusV1(Interface):
"""Track seat focus
This interface allows clients to receive information about the current
focus of a seat. Note that (un)focused_output events will only be sent if
the client has bound the relevant
:class:`~pywayland.protocol.wayland.WlOutput` globals.
"""
name = "zriver_seat_status_v1"
version = 3
class ZriverSeatStatusV1Proxy(Proxy[ZriverSeatStatusV1]):
interface = ZriverSeatStatusV1
@ZriverSeatStatusV1.request()
def destroy(self) -> None:
"""Destroy the river_seat_status object
This request indicates that the client will not use the
river_seat_status object any more.
"""
self._marshal(0)
self._destroy()
class ZriverSeatStatusV1Resource(Resource):
interface = ZriverSeatStatusV1
@ZriverSeatStatusV1.event(
Argument(ArgumentType.Object, interface=WlOutput),
)
def focused_output(self, output: WlOutput) -> None:
"""The seat focused an output
Sent on binding the interface and again whenever an output gains focus.
:param output:
:type output:
:class:`~pywayland.protocol.wayland.WlOutput`
"""
self._post_event(0, output)
@ZriverSeatStatusV1.event(
Argument(ArgumentType.Object, interface=WlOutput),
)
def unfocused_output(self, output: WlOutput) -> None:
"""The seat unfocused an output
Sent whenever an output loses focus.
:param output:
:type output:
:class:`~pywayland.protocol.wayland.WlOutput`
"""
self._post_event(1, output)
@ZriverSeatStatusV1.event(
Argument(ArgumentType.String),
)
def focused_view(self, title: str) -> None:
"""Information on the focused view
Sent once on binding the interface and again whenever the focused view
or a property thereof changes. The title may be an empty string if no
view is focused or the focused view did not set a title.
:param title:
title of the focused view
:type title:
`ArgumentType.String`
"""
self._post_event(2, title)
@ZriverSeatStatusV1.event(
Argument(ArgumentType.String),
version=3,
)
def mode(self, name: str) -> None:
"""The active mode changed
Sent once on binding the interface and again whenever a new mode is
entered (e.g. with riverctl enter-mode foobar).
:param name:
name of the mode
:type name:
`ArgumentType.String`
"""
self._post_event(3, name)
class ZriverSeatStatusV1Global(Global):
interface = ZriverSeatStatusV1
ZriverSeatStatusV1._gen_c()
ZriverSeatStatusV1.proxy_class = ZriverSeatStatusV1Proxy
ZriverSeatStatusV1.resource_class = ZriverSeatStatusV1Resource
ZriverSeatStatusV1.global_class = ZriverSeatStatusV1Global

View File

@@ -0,0 +1,102 @@
# This file has been autogenerated by the pywayland scanner
# Copyright 2020 The River Developers
#
# 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.
from __future__ import annotations
from pywayland.protocol.wayland import WlOutput, WlSeat
from pywayland.protocol_core import (Argument, ArgumentType, Global, Interface,
Proxy, Resource)
from .zriver_output_status_v1 import ZriverOutputStatusV1
from .zriver_seat_status_v1 import ZriverSeatStatusV1
class ZriverStatusManagerV1(Interface):
"""Manage river status objects
A global factory for objects that receive status information specific to
river. It could be used to implement, for example, a status bar.
"""
name = "zriver_status_manager_v1"
version = 4
class ZriverStatusManagerV1Proxy(Proxy[ZriverStatusManagerV1]):
interface = ZriverStatusManagerV1
@ZriverStatusManagerV1.request()
def destroy(self) -> None:
"""Destroy the river_status_manager object
This request indicates that the client will not use the
river_status_manager object any more. Objects that have been created
through this instance are not affected.
"""
self._marshal(0)
self._destroy()
@ZriverStatusManagerV1.request(
Argument(ArgumentType.NewId, interface=ZriverOutputStatusV1),
Argument(ArgumentType.Object, interface=WlOutput),
)
def get_river_output_status(self, output: WlOutput) -> Proxy[ZriverOutputStatusV1]:
"""Create an output status object
This creates a new river_output_status object for the given
:class:`~pywayland.protocol.wayland.WlOutput`.
:param output:
:type output:
:class:`~pywayland.protocol.wayland.WlOutput`
:returns:
:class:`~pywayland.protocol.river_status_unstable_v1.ZriverOutputStatusV1`
"""
id = self._marshal_constructor(1, ZriverOutputStatusV1, output)
return id
@ZriverStatusManagerV1.request(
Argument(ArgumentType.NewId, interface=ZriverSeatStatusV1),
Argument(ArgumentType.Object, interface=WlSeat),
)
def get_river_seat_status(self, seat: WlSeat) -> Proxy[ZriverSeatStatusV1]:
"""Create a seat status object
This creates a new river_seat_status object for the given
:class:`~pywayland.protocol.wayland.WlSeat`.
:param seat:
:type seat:
:class:`~pywayland.protocol.wayland.WlSeat`
:returns:
:class:`~pywayland.protocol.river_status_unstable_v1.ZriverSeatStatusV1`
"""
id = self._marshal_constructor(2, ZriverSeatStatusV1, seat)
return id
class ZriverStatusManagerV1Resource(Resource):
interface = ZriverStatusManagerV1
class ZriverStatusManagerV1Global(Global):
interface = ZriverStatusManagerV1
ZriverStatusManagerV1._gen_c()
ZriverStatusManagerV1.proxy_class = ZriverStatusManagerV1Proxy
ZriverStatusManagerV1.resource_class = ZriverStatusManagerV1Resource
ZriverStatusManagerV1.global_class = ZriverStatusManagerV1Global

View File

@@ -0,0 +1,85 @@
<?xml version="1.0" encoding="UTF-8"?>
<protocol name="river_control_unstable_v1">
<copyright>
Copyright 2020 The River Developers
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_control_v1" version="1">
<description summary="run compositor commands">
This interface allows clients to run compositor commands and receive a
success/failure response with output or a failure message respectively.
Each command is built up in a series of add_argument requests and
executed with a run_command request. The first argument is the command
to be run.
A complete list of commands should be made available in the man page of
the compositor.
</description>
<request name="destroy" type="destructor">
<description summary="destroy the river_control object">
This request indicates that the client will not use the
river_control object any more. Objects that have been created
through this instance are not affected.
</description>
</request>
<request name="add_argument">
<description summary="add an argument to the current command">
Arguments are stored by the server in the order they were sent until
the run_command request is made.
</description>
<arg name="argument" type="string" summary="the argument to add"/>
</request>
<request name="run_command">
<description summary="run the current command">
Execute the command built up using the add_argument request for the
given seat.
</description>
<arg name="seat" type="object" interface="wl_seat"/>
<arg name="callback" type="new_id" interface="zriver_command_callback_v1"
summary="callback object"/>
</request>
</interface>
<interface name="zriver_command_callback_v1" version="1">
<description summary="callback object">
This object is created by the run_command request. Exactly one of the
success or failure events will be sent. This object will be destroyed
by the compositor after one of the events is sent.
</description>
<event name="success" type="destructor">
<description summary="command successful">
Sent when the command has been successfully received and executed by
the compositor. Some commands may produce output, in which case the
output argument will be a non-empty string.
</description>
<arg name="output" type="string" summary="the output of the command"/>
</event>
<event name="failure" type="destructor">
<description summary="command failed">
Sent when the command could not be carried out. This could be due to
sending a non-existent command, no command, not enough arguments, too
many arguments, invalid arguments, etc.
</description>
<arg name="failure_message" type="string"
summary="a message explaining why failure occurred"/>
</event>
</interface>
</protocol>

View File

@@ -0,0 +1,148 @@
<?xml version="1.0" encoding="UTF-8"?>
<protocol name="river_status_unstable_v1">
<copyright>
Copyright 2020 The River Developers
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_manager_v1" version="4">
<description summary="manage river status objects">
A global factory for objects that receive status information specific
to river. It could be used to implement, for example, a status bar.
</description>
<request name="destroy" type="destructor">
<description summary="destroy the river_status_manager object">
This request indicates that the client will not use the
river_status_manager object any more. Objects that have been created
through this instance are not affected.
</description>
</request>
<request name="get_river_output_status">
<description summary="create an output status object">
This creates a new river_output_status object for the given wl_output.
</description>
<arg name="id" type="new_id" interface="zriver_output_status_v1"/>
<arg name="output" type="object" interface="wl_output"/>
</request>
<request name="get_river_seat_status">
<description summary="create a seat status object">
This creates a new river_seat_status object for the given wl_seat.
</description>
<arg name="id" type="new_id" interface="zriver_seat_status_v1"/>
<arg name="seat" type="object" interface="wl_seat"/>
</request>
</interface>
<interface name="zriver_output_status_v1" version="4">
<description summary="track output tags and focus">
This interface allows clients to receive information about the current
windowing state of an output.
</description>
<request name="destroy" type="destructor">
<description summary="destroy the river_output_status object">
This request indicates that the client will not use the
river_output_status object any more.
</description>
</request>
<event name="focused_tags">
<description summary="focused tags of the output">
Sent once binding the interface and again whenever the tag focus of
the output changes.
</description>
<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 on binding the interface and again whenever the tag state
of the output changes.
</description>
<arg name="tags" type="array" summary="array of 32-bit bitfields"/>
</event>
<event name="urgent_tags" since="2">
<description summary="tags of the output with an urgent view">
Sent once on binding the interface and again whenever the set of
tags with at least one urgent view changes.
</description>
<arg name="tags" type="uint" summary="32-bit bitfield"/>
</event>
<event name="layout_name" since="4">
<description summary="name of the layout">
Sent once on binding the interface should a layout name exist and again
whenever the name changes.
</description>
<arg name="name" type="string" summary="layout name"/>
</event>
<event name="layout_name_clear" since="4">
<description summary="name of the layout">
Sent when the current layout name has been removed without a new one
being set, for example when the active layout generator disconnects.
</description>
</event>
</interface>
<interface name="zriver_seat_status_v1" version="3">
<description summary="track seat focus">
This interface allows clients to receive information about the current
focus of a seat. Note that (un)focused_output events will only be sent
if the client has bound the relevant wl_output globals.
</description>
<request name="destroy" type="destructor">
<description summary="destroy the river_seat_status object">
This request indicates that the client will not use the
river_seat_status object any more.
</description>
</request>
<event name="focused_output">
<description summary="the seat focused an output">
Sent on binding the interface and again whenever an output gains focus.
</description>
<arg name="output" type="object" interface="wl_output"/>
</event>
<event name="unfocused_output">
<description summary="the seat unfocused an output">
Sent whenever an output loses focus.
</description>
<arg name="output" type="object" interface="wl_output"/>
</event>
<event name="focused_view">
<description summary="information on the focused view">
Sent once on binding the interface and again whenever the focused
view or a property 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="title" type="string" summary="title of the focused view"/>
</event>
<event name="mode" since="3">
<description summary="the active mode changed">
Sent once on binding the interface and again whenever a new mode
is entered (e.g. with riverctl enter-mode foobar).
</description>
<arg name="name" type="string" summary="name of the mode"/>
</event>
</interface>
</protocol>