River status
zriver_status_manager_v1
A global factory for objects that receive status information specific to river. It could be used to implement, for example, a status bar.
destroy()
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.
get_river_output_status(id: new_id<zriver_output_status_v1>, output: object<wl_output>)
Argument | Type | Description |
|---|---|---|
| id | new_id<zriver_output_status_v1> | |
| output | object<wl_output> |
This creates a new river_output_status object for the given wl_output.
get_river_seat_status(id: new_id<zriver_seat_status_v1>, seat: object<wl_seat>)
Argument | Type | Description |
|---|---|---|
| id | new_id<zriver_seat_status_v1> | |
| seat | object<wl_seat> |
This creates a new river_seat_status object for the given wl_seat.
zriver_output_status_v1
This interface allows clients to receive information about the current windowing state of an output.
destroy()
This request indicates that the client will not use the river_output_status object any more.
focused_tags(tags: uint)
Argument | Type | Description |
|---|---|---|
| tags | uint | 32-bit bitfield |
Sent once binding the interface and again whenever the tag focus of the output changes.
view_tags(tags: array)
Argument | Type | Description |
|---|---|---|
| tags | array | array of 32-bit bitfields |
Sent once on binding the interface and again whenever the tag state of the output changes.
urgent_tags(tags: uint)
Argument | Type | Description |
|---|---|---|
| tags | uint | 32-bit bitfield |
Sent once on binding the interface and again whenever the set of tags with at least one urgent view changes.
layout_name(name: string)
Argument | Type | Description |
|---|---|---|
| name | string | layout name |
Sent once on binding the interface should a layout name exist and again whenever the name changes.
layout_name_clear()
Sent when the current layout name has been removed without a new one being set, for example when the active layout generator disconnects.
zriver_seat_status_v1
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.
destroy()
This request indicates that the client will not use the river_seat_status object any more.
Sent on binding the interface and again whenever an output gains focus.
Sent whenever an output loses focus.
focused_view(title: string)
Argument | Type | Description |
|---|---|---|
| title | string | title of 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.
mode(name: string)
Argument | Type | Description |
|---|---|---|
| name | string | name of the mode |
Sent once on binding the interface and again whenever a new mode is entered (e.g. with riverctl enter-mode foobar).
Compositor Support
Cage  | COSMIC  | GameScope  | Hyprland  | Jay | KWin  | Labwc  | Louvre  | Mir  | Muffin  | Mutter  | niri  | river  | Sway  | Treeland  | Wayfire  | Weston  | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| zriver_status_manager_v1 | x | x | x | x | x | x | x | x | x | x | x | x | 4 | x | x | x | x |
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.