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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
|
<protocol name="phosh">
<copyright>
Copyright © 2019 Purism SPC
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="phosh_private" version="7">
<description summary="Phone shell extensions">
Private protocol between phosh and the compositor.
Instead of adding more interfaces here consider adding a separate
zphoc-unstable protocol instead.
</description>
<enum name="error">
<entry name="invalid_argument" value="0"
summary="an invalid argument was provided in a request"/>
</enum>
<request name="rotate_display" since="1">
<description summary="rotate output">
This request is unused, ignore. Use wlr-output-management instead.
</description>
<arg name="surface" type="object" interface="wl_surface"/>
<arg name="degree" type="uint"/>
</request>
<request name="get_xdg_switcher" since="2">
<description summary="rotate output">
This request is unused, ignore. Use wlr-foreign-toplevel-management instead.
</description>
<arg name="id" type="new_id" interface="phosh_private_xdg_switcher"/>
</request>
<request name="get_thumbnail" since="4">
<description summary="request a window thumbnail for a given toplevel">
Allows to retrieve a window thumbnail image for a given foreign
toplevel via wlr_screencopy protocol.
The thumbnail will be scaled down to the size provided by
max_width and max_height arguments, preserving original aspect
ratio. Pass 0 to leave it unconstrained.
</description>
<arg name="id" type="new_id" interface="zwlr_screencopy_frame_v1"/>
<arg name="toplevel" type="object" interface="zwlr_foreign_toplevel_handle_v1"/>
<arg name="max_width" type="uint" />
<arg name="max_height" type="uint" />
</request>
<request name="get_keyboard_event" since="5">
<description summary="request a keyboard event handler">
Allows to subscribe to specific keyboard events.
The client grabs an accelerator by a string and gets an action id returned.
When the accelerator is used the client will be informed via the corresponding
action id.
</description>
<arg name="id" type="new_id" interface="phosh_private_keyboard_event"/>
</request>
<request name="get_startup_tracker" since="6">
<description summary="Request an application startup tracker">
Allows to track application startup.
</description>
<arg name="id" type="new_id" interface="phosh_private_startup_tracker"/>
</request>
<enum name="shell_state" since="6">
<entry name="unknown" value="0" summary="shell state unknown"/>
<entry name="up" value="1" summary="shell is up and running"/>
</enum>
<request name="set_shell_state" since="6">
<description summary="Report shell state">
This allows the shell to report it's current state. This can
e.g. be used to notify the compositor that the shell is up.
</description>
<arg name="state" type="uint" enum="shell_state" summary="Status"/>
</request>
</interface>
<interface name="phosh_private_keyboard_event" version="7">
<description summary="Interface for additional keyboard events">
The interface is meant to allow subscription and forwarding of keyboard events.
</description>
<enum name="error">
<entry name="invalid_argument" value="0"
summary="an invalid argument was provided in a request"/>
<entry name="invalid_keysym" value="1"
summary="keysym not subscribeable"/>
<entry name="already_subscribed" value="2"
summary="accelerator has already been subscribed to"/>
<entry name="misc_error" value="3"
summary="an miscellaneous error has occurred"/>
</enum>
<event name="accelerator_activated_event" since="5">
<description summary="Report an accelerator press">
The subscribed accelerator has been pressed.
</description>
<arg name="action_id" type="uint" summary="The previously assigned action_id"/>
<arg name="timestamp" type="uint" summary="The timestamp when the key has been pressed"/>
</event>
<event name="grab_failed_event" since="5">
<description summary="Report subscription failure">
A previous accelerator grab request has failed.
</description>
<arg name="accelerator" type="string" summary="The failed accelerator"/>
<arg name="error" type="uint" summary="The error code"/>
</event>
<event name="grab_success_event" since="5">
<description summary="Report subscription success">
A previous accelerator grab request has succeeded.
</description>
<arg name="accelerator" type="string" summary="The subscribed accelerator"/>
<arg name="action_id" type="uint" summary="The id that has been assigned to the accelerator"/>
</event>
<request name="grab_accelerator_request" since="5">
<description summary="Subscribe to an accelerator">
Client subscribes to a specific accelerator.
</description>
<arg name="accelerator" type="string" summary="The accelerator string (with modifiers)"/>
</request>
<event name="ungrab_failed_event" since="5">
<description summary="Report unsubscription failure">
A previous accelerator ungrab request has failed.
</description>
<arg name="action_id" type="uint" summary="The failed action"/>
<arg name="error" type="uint" summary="The error code"/>
</event>
<event name="ungrab_success_event" since="5">
<description summary="Report unsubscription success">
A previous accelerator ungrab request has succeeded.
</description>
<arg name="action" type="uint" summary="The unsubscribed action"/>
</event>
<request name="ungrab_accelerator_request" since="5">
<description summary="Unsubscribe to an accelerator">
Client unsubscribes a specific accelerator"
</description>
<arg name="action_id" type="uint" summary="The action to unsubscribe"/>
</request>
<request name="destroy" type="destructor" since="5">
<description summary="destroy the keyboard_event interface instance"/>
</request>
<!-- Version 7 additions -->
<event name="accelerator_released_event" since="7">
<description summary="Report an accelerator release">
The subscribed accelerator has been released.
</description>
<arg name="action_id" type="uint" summary="The previously assigned action_id"/>
<arg name="timestamp" type="uint" summary="The timestamp when the key has been released"/>
</event>
</interface>
<!-- application switch/close handling -->
<interface name="phosh_private_xdg_switcher" version="7">
<description summary="Interface to list and raise xdg surfaces">
This interface is unused, ignore. Use wlr-foreign-toplevel-management instead.
</description>
<enum name="error">
<entry name="invalid_argument" value="0"
summary="an invalid argument was provided in a request"/>
</enum>
<request name="list_xdg_surfaces" since="2">
<description summary="Get current xdg surfaces"/>
</request>
<request name="destroy" type="destructor" since="2">
<description summary="destroy the xdg_switcher interface instance"/>
</request>
<request name="raise_xdg_surface" since="2">
<description summary="raise the given xdg surface to the top of the stack"/>
<arg name="app_id" type="string" summary="The app_id of the xdg surface"/>
<arg name="title" type="string" summary="The title of the xdg surface" allow-null="true"/>
</request>
<event name="xdg_surface" since="2">
<description summary="report an xdg surface"/>
<arg name="app_id" type="string" summary="the app_id of the xdg surface"/>
<arg name="title" type="string" summary="the title of the xdg surface" allow-null="true"/>
</event>
<event name="list_xdg_surfaces_done" since="2">
<description summary="all xdg surfaces were sent"/>
</event>
<request name="close_xdg_surface" since="3">
<description summary="close the given xdg surface"/>
<arg name="app_id" type="string" summary="The app_id of the xdg surface"/>
<arg name="title" type="string" summary="The title of the xdg surface" allow-null="true"/>
</request>
</interface>
<!-- application startup tracking -->
<interface name="phosh_private_startup_tracker" version="7">
<description summary="Interface to track application startup">
Allows shells to track application startup.
</description>
<enum name="flag" bitfield="true">
<entry name="none" value="0" summary="no flags"/>
</enum>
<enum name="protocol">
<entry name="unknown" value="0" summary="unknown protocol"/>
<entry name="x11" value="1" summary="x11 startup notification protocol"/>
<entry name="gtk_shell" value="2" summary="gtk_shell protocol"/>
<entry name="xdg_activation" value="3" summary="xdg_activation protocol"/>
</enum>
<event name="startup_id">
<description summary="Report a startup id">
This event indicates that the client sent it's startup id.
(which implies the app is running).
</description>
<arg name="startup_id" type="string" summary="The startup_id"/>
<arg name="protocol" type="uint" enum="protocol" summary="The protocol"/>
<arg name="flags" type="uint" enum="flags" summary="flags"/>
</event>
<event name="launched">
<description summary="Report an application launch">
This event indicates that the launcher spawned the app.
</description>
<arg name="startup_id" type="string" summary="The startup_id"/>
<arg name="protocol" type="uint" enum="protocol" summary="The protocol"/>
<arg name="flags" type="uint" enum="flags" summary="flags"/>
</event>
<request name="destroy" type="destructor">
<description summary="destroy the startup_tracker interface instance">
The Client should invoke this when done using the interface.
</description>
</request>
</interface>
</protocol>
|
