1//! Miscellaneous protocols
2
3#![cfg_attr(rustfmt, rustfmt_skip)]
4
5#[cfg(feature = "staging")]
6pub mod idle_notify {
7 //! This protocol allows clients to monitor user idle status.
8
9 #[allow(missing_docs)]
10 pub mod v1 {
11 wayland_protocol!(
12 "./protocols/staging/ext-idle-notify/ext-idle-notify-v1.xml",
13 []
14 );
15 }
16}
17
18#[cfg(feature = "staging")]
19pub mod session_lock {
20 //! This protocol allows for a privileged Wayland client to lock the session
21 //! and display arbitrary graphics while the session is locked.
22 //!
23 //! The compositor may choose to restrict this protocol to a special client
24 //! launched by the compositor itself or expose it to all privileged clients,
25 //! this is compositor policy.
26 //!
27 //! The client is responsible for performing authentication and informing the
28 //! compositor when the session should be unlocked. If the client dies while
29 //! the session is locked the session remains locked, possibly permanently
30 //! depending on compositor policy.
31
32 #[allow(missing_docs)]
33 pub mod v1 {
34 wayland_protocol!(
35 "./protocols/staging/ext-session-lock/ext-session-lock-v1.xml",
36 []
37 );
38 }
39}
40
41#[cfg(feature = "staging")]
42pub mod foreign_toplevel_list {
43 //! The purpose of this protocol is to provide protocol object handles for toplevels, possibly
44 //! originating from another client.
45 //!
46 //! This protocol is intentionally minimalistic and expects additional functionality (e.g.
47 //! creating a screencopy source from a toplevel handle, getting information about the state of
48 //! the toplevel) to be implemented in extension protocols.
49 //!
50 //! The compositor may choose to restrict this protocol to a special client launched by the
51 //! compositor itself or expose it to all clients, this is compositor policy.
52
53 #[allow(missing_docs)]
54 pub mod v1 {
55 wayland_protocol!(
56 "./protocols/staging/ext-foreign-toplevel-list/ext-foreign-toplevel-list-v1.xml",
57 []
58 );
59 }
60}
61
62#[cfg(feature = "staging")]
63pub mod transient_seat {
64 //! The transient seat protocol can be used by privileged clients to create
65 //! independent seats that will be removed from the compositor when the client
66 //! destroys its transient seat.
67 //!
68 //! This protocol is intended for use with virtual input protocols such as
69 //! "virtual_keyboard_unstable_v1" or "wlr_virtual_pointer_unstable_v1", both
70 //! of which allow the user to select a seat.
71 //!
72 //! The "wl_seat" global created by this protocol does not generate input events
73 //! on its own, or have any capabilities except those assigned to it by other
74 //! protocol extensions, such as the ones mentioned above.
75 //!
76 //! For example, a remote desktop server can create a seat with virtual inputs
77 //! for each remote user by following these steps for each new connection:
78 //! * Create a transient seat
79 //! * Wait for the transient seat to be created
80 //! * Locate a "wl_seat" global with a matching name
81 //! * Create virtual inputs using the resulting "wl_seat" global
82 #[allow(missing_docs)]
83 pub mod v1 {
84 wayland_protocol!(
85 "./protocols/staging/ext-transient-seat/ext-transient-seat-v1.xml",
86 []
87 );
88 }
89
90}
91
92
93#[cfg(feature = "staging")]
94pub mod image_capture_source {
95 //! This protocol serves as an intermediary between capturing protocols and
96 //! potential image capture sources such as outputs and toplevels.
97 //!
98 //! This protocol may be extended to support more image capture sources in the
99 //! future, thereby adding those image capture sources to other protocols that
100 //! use the image capture source object without having to modify those
101 //! protocols.
102
103 #[allow(missing_docs)]
104 pub mod v1 {
105 wayland_protocol!(
106 "./protocols/staging/ext-image-capture-source/ext-image-capture-source-v1.xml",
107 [crate::ext::foreign_toplevel_list::v1, crate::xdg::shell]
108 );
109 }
110}
111
112#[cfg(feature = "staging")]
113pub mod image_copy_capture {
114 //! This protocol allows clients to ask the compositor to capture image sources
115 //! such as outputs and toplevels into user submitted buffers.
116
117 #[allow(missing_docs)]
118 pub mod v1 {
119 wayland_protocol!(
120 "./protocols/staging/ext-image-copy-capture/ext-image-copy-capture-v1.xml",
121 [crate::ext::image_capture_source::v1, crate::xdg::shell]
122 );
123 }
124}
125
126#[cfg(feature = "staging")]
127pub mod data_control {
128 //! This protocol allows a privileged client to control data devices. In
129 //! particular, the client will be able to manage the current selection and take
130 //! the role of a clipboard manager.
131
132 #[allow(missing_docs)]
133 pub mod v1 {
134 wayland_protocol!(
135 "./protocols/staging/ext-data-control/ext-data-control-v1.xml",
136 []
137 );
138 }
139}
140
141#[cfg(feature = "staging")]
142pub mod workspace {
143 //! List and control workspaces
144
145 #[allow(missing_docs)]
146 pub mod v1 {
147 wayland_protocol!(
148 "./protocols/staging/ext-workspace/ext-workspace-v1.xml",
149 []
150 );
151 }
152}
153