OLD | NEW |
1 <?xml version="1.0" encoding="UTF-8"?> | 1 <?xml version="1.0" encoding="UTF-8"?> |
2 <protocol name="remote_shell_unstable_v1"> | 2 <protocol name="remote_shell_unstable_v1"> |
3 | 3 |
4 <copyright> | 4 <copyright> |
5 Copyright 2016 The Chromium Authors. | 5 Copyright 2016 The Chromium Authors. |
6 | 6 |
7 Permission is hereby granted, free of charge, to any person obtaining a | 7 Permission is hereby granted, free of charge, to any person obtaining a |
8 copy of this software and associated documentation files (the "Software"), | 8 copy of this software and associated documentation files (the "Software"), |
9 to deal in the Software without restriction, including without limitation | 9 to deal in the Software without restriction, including without limitation |
10 the rights to use, copy, modify, merge, publish, distribute, sublicense, | 10 the rights to use, copy, modify, merge, publish, distribute, sublicense, |
(...skipping 20 matching lines...) Expand all Loading... |
31 Warning! The protocol described in this file is experimental and backward | 31 Warning! The protocol described in this file is experimental and backward |
32 incompatible changes may be made. Backward compatible changes may be added | 32 incompatible changes may be made. Backward compatible changes may be added |
33 together with the corresponding interface version bump. Backward | 33 together with the corresponding interface version bump. Backward |
34 incompatible changes are done by bumping the version number in the protocol | 34 incompatible changes are done by bumping the version number in the protocol |
35 and interface names and resetting the interface version. Once the protocol | 35 and interface names and resetting the interface version. Once the protocol |
36 is to be declared stable, the 'z' prefix and the version number in the | 36 is to be declared stable, the 'z' prefix and the version number in the |
37 protocol and interface names are removed and the interface version number is | 37 protocol and interface names are removed and the interface version number is |
38 reset. | 38 reset. |
39 </description> | 39 </description> |
40 | 40 |
41 <interface name="zwp_remote_shell_v1" version="11"> | 41 <interface name="zcr_remote_shell_v1" version="1"> |
42 <description summary="remote_shell"> | 42 <description summary="remote_shell"> |
43 The global interface that allows clients to turn a wl_surface into a | 43 The global interface that allows clients to turn a wl_surface into a |
44 "real window" which is remotely managed but can be stacked, activated | 44 "real window" which is remotely managed but can be stacked, activated |
45 and made fullscreen by the user. | 45 and made fullscreen by the user. |
46 </description> | 46 </description> |
47 | 47 |
48 <enum name="container"> | 48 <enum name="container"> |
49 <description summary="containers for remote surfaces"> | 49 <description summary="containers for remote surfaces"> |
50 Determine how a remote surface should be stacked relative to other | 50 Determine how a remote surface should be stacked relative to other |
51 shell surfaces. | 51 shell surfaces. |
(...skipping 42 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
94 <description summary="create a remote shell surface from a surface"> | 94 <description summary="create a remote shell surface from a surface"> |
95 This creates an remote_surface for the given surface and gives it the | 95 This creates an remote_surface for the given surface and gives it the |
96 remote_surface role. A wl_surface can only be given a remote_surface | 96 remote_surface role. A wl_surface can only be given a remote_surface |
97 role once. If get_remote_surface is called with a wl_surface that | 97 role once. If get_remote_surface is called with a wl_surface that |
98 already has an active remote_surface associated with it, or if it had | 98 already has an active remote_surface associated with it, or if it had |
99 any other role, an error is raised. | 99 any other role, an error is raised. |
100 | 100 |
101 See the documentation of remote_surface for more details about what an | 101 See the documentation of remote_surface for more details about what an |
102 remote_surface is and how it is used. | 102 remote_surface is and how it is used. |
103 </description> | 103 </description> |
| 104 <arg name="id" type="new_id" interface="zcr_remote_surface_v1"/> |
| 105 <arg name="surface" type="object" interface="wl_surface"/> |
| 106 <arg name="container" type="uint"/> |
| 107 </request> |
| 108 |
| 109 <event name="activated"> |
| 110 <description summary="activated surface changed"> |
| 111 Notifies client that the activated surface changed. |
| 112 </description> |
| 113 <arg name="gained_active" type="object" interface="wl_surface" allow-null=
"true"/> |
| 114 <arg name="lost_active" type="object" interface="wl_surface" allow-null="t
rue"/> |
| 115 </event> |
| 116 |
| 117 <request name="get_notification_surface"> |
| 118 <description summary="create a notification surface from a surface"> |
| 119 Creates a notification_surface for the given surface, gives it the |
| 120 notification_surface role and associated it with a notification id. |
| 121 </description> |
| 122 <arg name="id" type="new_id" interface="zcr_notification_surface_v1"/> |
| 123 <arg name="surface" type="object" interface="wl_surface"/> |
| 124 <arg name="notification_id" type="string" /> |
| 125 </request> |
| 126 |
| 127 <event name="configuration_changed"> |
| 128 <description summary="suggests a re-configuration of remote shell"> |
| 129 Suggests a re-configuration of remote shell. |
| 130 </description> |
| 131 <arg name="width" type="int"/> |
| 132 <arg name="height" type="int"/> |
| 133 <arg name="transform" type="int"/> |
| 134 <arg name="scale_factor" type="fixed"/> |
| 135 <arg name="work_area_inset_left" type="int"/> |
| 136 <arg name="work_area_inset_top" type="int"/> |
| 137 <arg name="work_area_inset_right" type="int"/> |
| 138 <arg name="work_area_inset_bottom" type="int"/> |
| 139 <arg name="layout_mode" type="uint"/> |
| 140 </event> |
| 141 </interface> |
| 142 |
| 143 <interface name="zcr_remote_surface_v1" version="1"> |
| 144 <description summary="A desktop window"> |
| 145 An interface that may be implemented by a wl_surface, for |
| 146 implementations that provide a desktop-style user interface |
| 147 and allows for remotely managed windows. |
| 148 |
| 149 It provides requests to treat surfaces like windows, allowing to set |
| 150 properties like app id and geometry. |
| 151 |
| 152 The client must call wl_surface.commit on the corresponding wl_surface |
| 153 for the remote_surface state to take effect. |
| 154 |
| 155 For a surface to be mapped by the compositor the client must have |
| 156 committed both an remote_surface state and a buffer. |
| 157 </description> |
| 158 |
| 159 <request name="destroy" type="destructor"> |
| 160 <description summary="Destroy the remote_surface"> |
| 161 Unmap and destroy the window. The window will be effectively |
| 162 hidden from the user's point of view, and all state will be lost. |
| 163 </description> |
| 164 </request> |
| 165 |
| 166 <request name="set_app_id"> |
| 167 <description summary="set application ID"> |
| 168 Set an application identifier for the surface. |
| 169 </description> |
| 170 <arg name="app_id" type="string"/> |
| 171 </request> |
| 172 |
| 173 <request name="set_window_geometry"> |
| 174 <description summary="set the new window geometry"> |
| 175 The window geometry of a window is its "visible bounds" from the |
| 176 user's perspective. Client-side decorations often have invisible |
| 177 portions like drop-shadows which should be ignored for the |
| 178 purposes of aligning, placing and constraining windows. |
| 179 |
| 180 The window geometry is double buffered, and will be applied at the |
| 181 time wl_surface.commit of the corresponding wl_surface is called. |
| 182 |
| 183 Once the window geometry of the surface is set once, it is not |
| 184 possible to unset it, and it will remain the same until |
| 185 set_window_geometry is called again, even if a new subsurface or |
| 186 buffer is attached. |
| 187 |
| 188 If never set, the value is the full bounds of the output. This |
| 189 updates dynamically on every commit. |
| 190 |
| 191 The arguments are given in the output coordinate space. |
| 192 |
| 193 The width and height must be greater than zero. |
| 194 </description> |
| 195 <arg name="x" type="int"/> |
| 196 <arg name="y" type="int"/> |
| 197 <arg name="width" type="int"/> |
| 198 <arg name="height" type="int"/> |
| 199 </request> |
| 200 |
| 201 <request name="set_scale"> |
| 202 <description summary="set scale"> |
| 203 Set a scale factor that will be applied to surface and all descendants. |
| 204 </description> |
| 205 <arg name="scale" type="fixed"/> |
| 206 </request> |
| 207 |
| 208 <request name="set_rectangular_shadow"> |
| 209 <description summary="set a rectangular shadow"> |
| 210 Request that surface needs a rectangular shadow. |
| 211 |
| 212 This is only a request that the surface should have a rectangular |
| 213 shadow. The compositor may choose to ignore this request. |
| 214 |
| 215 The arguments are given in the output coordinate space and specifies |
| 216 the inner bounds of the shadow. |
| 217 |
| 218 The arguments are given in the output coordinate space. |
| 219 Specifying zero width and height will disable the shadow. |
| 220 </description> |
| 221 <arg name="x" type="int"/> |
| 222 <arg name="y" type="int"/> |
| 223 <arg name="width" type="int"/> |
| 224 <arg name="height" type="int"/> |
| 225 </request> |
| 226 |
| 227 <request name="set_rectangular_shadow_background_opacity"> |
| 228 <description summary="suggests the window's background opacity"> |
| 229 Suggests the window's background opacity when the shadow is requested. |
| 230 </description> |
| 231 <arg name="opacity" type="fixed"/> |
| 232 </request> |
| 233 |
| 234 <request name="set_title"> |
| 235 <description summary="set surface title"> |
| 236 Set a short title for the surface. |
| 237 |
| 238 This string may be used to identify the surface in a task bar, |
| 239 window list, or other user interface elements provided by the |
| 240 compositor. |
| 241 |
| 242 The string must be encoded in UTF-8. |
| 243 </description> |
| 244 <arg name="title" type="string"/> |
| 245 </request> |
| 246 |
| 247 <request name="set_top_inset"> |
| 248 <description summary="set top inset for surface"> |
| 249 Set distance from the top of the surface to the contents. |
| 250 |
| 251 This distance typically represents the size of the window caption. |
| 252 </description> |
| 253 <arg name="height" type="int"/> |
| 254 </request> |
| 255 |
| 256 <request name="activate"> |
| 257 <description summary="make the surface active"> |
| 258 Make the surface active and bring it to the front. |
| 259 </description> |
| 260 <arg name="serial" type="uint" summary="the serial of the user event"/> |
| 261 </request> |
| 262 |
| 263 <request name="maximize"> |
| 264 <description summary="maximize"> |
| 265 Request that surface is maximized. The window geometry will be updated |
| 266 to whatever the compositor finds appropriate for a maximized window. |
| 267 |
| 268 This is only a request that the window should be maximized. The |
| 269 compositor may choose to ignore this request. The client should |
| 270 listen to set_maximized events to determine if the window was |
| 271 maximized or not. |
| 272 </description> |
| 273 </request> |
| 274 |
| 275 <request name="minimize"> |
| 276 <description summary="minimize"> |
| 277 Request that surface is minimized. |
| 278 |
| 279 This is only a request that the window should be minimized. The |
| 280 compositor may choose to ignore this request. The client should |
| 281 listen to set_minimized events to determine if the window was |
| 282 minimized or not. |
| 283 </description> |
| 284 </request> |
| 285 |
| 286 <request name="restore"> |
| 287 <description summary="restore"> |
| 288 Request that surface is restored. This restores the window geometry |
| 289 to what it was before the window was minimized, maximized or made |
| 290 fullscreen. |
| 291 |
| 292 This is only a request that the window should be restored. The |
| 293 compositor may choose to ignore this request. The client should |
| 294 listen to unset_maximized, unset_minimize and unset_fullscreen |
| 295 events to determine if the window was restored or not. |
| 296 </description> |
| 297 </request> |
| 298 |
| 299 <request name="fullscreen"> |
| 300 <description summary="fullscreen"> |
| 301 Request that surface is made fullscreen. |
| 302 |
| 303 This is only a request that the window should be made fullscreen. |
| 304 The compositor may choose to ignore this request. The client should |
| 305 listen to set_fullscreen events to determine if the window was |
| 306 made fullscreen or not. |
| 307 </description> |
| 308 </request> |
| 309 |
| 310 <request name="unfullscreen"> |
| 311 <description summary="unfullscreen"> |
| 312 Request that surface is made unfullscreen. |
| 313 |
| 314 This is only a request that the window should be made unfullscreen. |
| 315 The compositor may choose to ignore this request. The client should |
| 316 listen to unset_fullscreen events to determine if the window was |
| 317 made unfullscreen or not. |
| 318 </description> |
| 319 </request> |
| 320 |
| 321 <request name="pin"> |
| 322 <description summary="pin"> |
| 323 Request that surface is pinned. |
| 324 |
| 325 This is only a request that the window should be pinned. |
| 326 The compositor may choose to ignore this request. The client should |
| 327 listen to state_changed events to determine if the window was |
| 328 pinned or not. If trusted flag is non-zero, the app can prevent users |
| 329 from exiting the pinned mode. |
| 330 </description> |
| 331 <arg name="trusted" type="int"/> |
| 332 </request> |
| 333 |
| 334 <request name="unpin"> |
| 335 <description summary="unpin"> |
| 336 Request that surface is unpinned. |
| 337 |
| 338 This is only a request that the window should be unpinned. |
| 339 The compositor may choose to ignore this request. The client should |
| 340 listen to unset_pinned events to determine if the window was |
| 341 unpinned or not. |
| 342 </description> |
| 343 </request> |
| 344 |
| 345 <request name="set_system_modal"> |
| 346 <description summary="suggests a re-layout of remote shell input area"> |
| 347 Suggests a surface should become system modal. |
| 348 </description> |
| 349 </request> |
| 350 |
| 351 <request name="unset_system_modal"> |
| 352 <description summary="suggests a re-layout of remote shell input area"> |
| 353 Suggests a surface should become non system modal. |
| 354 </description> |
| 355 </request> |
| 356 |
| 357 <event name="close"> |
| 358 <description summary="surface wants to be closed"> |
| 359 The close event is sent by the compositor when the user |
| 360 wants the surface to be closed. This should be equivalent to |
| 361 the user clicking the close button in client-side decorations, |
| 362 if your application has any... |
| 363 |
| 364 This is only a request that the user intends to close your |
| 365 window. The client may choose to ignore this request, or show |
| 366 a dialog to ask the user to save their data... |
| 367 </description> |
| 368 </event> |
| 369 |
| 370 <event name="state_type_changed"> |
| 371 <description summary="surface state type changed"> |
| 372 The state_type_changed event is sent by the compositor when the surface |
| 373 state changed. |
| 374 |
| 375 This is an event to notify that the window state changed in compositor. |
| 376 The state change may be triggered by a client's request, or some user |
| 377 action directly handled by the compositor. The client may choose to |
| 378 ignore this event. |
| 379 </description> |
| 380 <arg name="state_type" type="uint"/> |
| 381 </event> |
| 382 </interface> |
| 383 |
| 384 <interface name="zcr_notification_surface_v1" version="1"> |
| 385 <description summary="A notification window"> |
| 386 An interface that may be implemented by a wl_surface to host |
| 387 notification contents. |
| 388 </description> |
| 389 |
| 390 <request name="destroy" type="destructor"> |
| 391 <description summary="Destroy the notification_surface"> |
| 392 Unmap and destroy the notification surface. |
| 393 </description> |
| 394 </request> |
| 395 </interface> |
| 396 |
| 397 <interface name="zwp_remote_shell_v1" version="11"> |
| 398 <description summary="DEPRECATED"> |
| 399 The global interface that allows clients to turn a wl_surface into a |
| 400 "real window" which is remotely managed but can be stacked, activated |
| 401 and made fullscreen by the user. |
| 402 </description> |
| 403 |
| 404 <enum name="container"> |
| 405 <description summary="containers for remote surfaces"> |
| 406 Determine how a remote surface should be stacked relative to other |
| 407 shell surfaces. |
| 408 </description> |
| 409 <entry name="default" value="1" summary="default container"/> |
| 410 <entry name="overlay" value="2" summary="system modal container"/> |
| 411 </enum> |
| 412 |
| 413 <enum name="state_type"> |
| 414 <description summary="state types for remote surfaces"> |
| 415 Defines common show states for shell surfaces. |
| 416 </description> |
| 417 <entry name="normal" value="1" summary="normal window state"/> |
| 418 <entry name="minimized" value="2" summary="minimized window state"/> |
| 419 <entry name="maximized" value="3" summary="maximized window state"/> |
| 420 <entry name="fullscreen" value="4" summary="fullscreen window state"/> |
| 421 <entry name="pinned" value="5" summary="pinned window state"/> |
| 422 <entry name="trusted_pinned" value="6" summary="trusted pinned window stat
e"/> |
| 423 </enum> |
| 424 |
| 425 <enum name="error"> |
| 426 <entry name="role" value="0" summary="given wl_surface has another role"/> |
| 427 <entry name="invalid_notification_id" value="1" |
| 428 summary="invalid notification id"/> |
| 429 </enum> |
| 430 |
| 431 <enum name="layout_mode"> |
| 432 <description summary="the layout mode"> |
| 433 Determine how a client should layout surfaces. |
| 434 </description> |
| 435 <entry name="windowed" value="1" summary="multiple windows"/> |
| 436 <entry name="tablet" value="2" summary="restricted mode for tablet"/> |
| 437 </enum> |
| 438 |
| 439 <request name="destroy" type="destructor"> |
| 440 <description summary="destroy remote_shell"> |
| 441 Destroy this remote_shell object. |
| 442 |
| 443 Destroying a bound remote_shell object while there are surfaces |
| 444 still alive created by this remote_shell object instance is illegal |
| 445 and will result in a protocol error. |
| 446 </description> |
| 447 </request> |
| 448 |
| 449 <request name="get_remote_surface"> |
| 450 <description summary="create a remote shell surface from a surface"> |
| 451 This creates an remote_surface for the given surface and gives it the |
| 452 remote_surface role. A wl_surface can only be given a remote_surface |
| 453 role once. If get_remote_surface is called with a wl_surface that |
| 454 already has an active remote_surface associated with it, or if it had |
| 455 any other role, an error is raised. |
| 456 |
| 457 See the documentation of remote_surface for more details about what an |
| 458 remote_surface is and how it is used. |
| 459 </description> |
104 <arg name="id" type="new_id" interface="zwp_remote_surface_v1"/> | 460 <arg name="id" type="new_id" interface="zwp_remote_surface_v1"/> |
105 <arg name="surface" type="object" interface="wl_surface"/> | 461 <arg name="surface" type="object" interface="wl_surface"/> |
106 <arg name="container" type="uint"/> | 462 <arg name="container" type="uint"/> |
107 </request> | 463 </request> |
108 | 464 |
109 <event name="configure"> | 465 <event name="configure"> |
110 <description summary="suggests a re-layout of remote shell"> | 466 <description summary="suggests a re-layout of remote shell"> |
111 Obsolete: Suggests a re-layout of remote surface geometry. | 467 Obsolete: Suggests a re-layout of remote surface geometry. |
112 </description> | 468 </description> |
113 <arg name="width" type="int"/> | 469 <arg name="width" type="int"/> |
(...skipping 48 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
162 <arg name="scale_factor" type="fixed"/> | 518 <arg name="scale_factor" type="fixed"/> |
163 <arg name="work_area_inset_left" type="int"/> | 519 <arg name="work_area_inset_left" type="int"/> |
164 <arg name="work_area_inset_top" type="int"/> | 520 <arg name="work_area_inset_top" type="int"/> |
165 <arg name="work_area_inset_right" type="int"/> | 521 <arg name="work_area_inset_right" type="int"/> |
166 <arg name="work_area_inset_bottom" type="int"/> | 522 <arg name="work_area_inset_bottom" type="int"/> |
167 <arg name="layout_mode" type="uint"/> | 523 <arg name="layout_mode" type="uint"/> |
168 </event> | 524 </event> |
169 </interface> | 525 </interface> |
170 | 526 |
171 <interface name="zwp_remote_surface_v1" version="11"> | 527 <interface name="zwp_remote_surface_v1" version="11"> |
172 <description summary="A desktop window"> | 528 <description summary="DEPRECATED"> |
173 An interface that may be implemented by a wl_surface, for | 529 An interface that may be implemented by a wl_surface, for |
174 implementations that provide a desktop-style user interface | 530 implementations that provide a desktop-style user interface |
175 and allows for remotely managed windows. | 531 and allows for remotely managed windows. |
176 | 532 |
177 It provides requests to treat surfaces like windows, allowing to set | 533 It provides requests to treat surfaces like windows, allowing to set |
178 properties like app id and geometry. | 534 properties like app id and geometry. |
179 | 535 |
180 The client must call wl_surface.commit on the corresponding wl_surface | 536 The client must call wl_surface.commit on the corresponding wl_surface |
181 for the remote_surface state to take effect. | 537 for the remote_surface state to take effect. |
182 | 538 |
(...skipping 336 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
519 from exiting the pinned mode. | 875 from exiting the pinned mode. |
520 </description> | 876 </description> |
521 <arg name="trusted" type="int" summary="whether the app can enforce users | 877 <arg name="trusted" type="int" summary="whether the app can enforce users |
522 to stay in the pinned mode."/> | 878 to stay in the pinned mode."/> |
523 </request> | 879 </request> |
524 </interface> | 880 </interface> |
525 | 881 |
526 <!-- Version 6 additions --> | 882 <!-- Version 6 additions --> |
527 | 883 |
528 <interface name="zwp_notification_surface_v1" version="6"> | 884 <interface name="zwp_notification_surface_v1" version="6"> |
529 <description summary="A notification window"> | 885 <description summary="DEPRECATED"> |
530 An interface that may be implemented by a wl_surface to host | 886 An interface that may be implemented by a wl_surface to host |
531 notification contents. | 887 notification contents. |
532 </description> | 888 </description> |
533 | 889 |
534 <request name="destroy" type="destructor"> | 890 <request name="destroy" type="destructor"> |
535 <description summary="Destroy the notification_surface"> | 891 <description summary="Destroy the notification_surface"> |
536 Unmap and destroy the notification surface. | 892 Unmap and destroy the notification surface. |
537 </description> | 893 </description> |
538 </request> | 894 </request> |
539 </interface> | 895 </interface> |
540 | 896 |
541 </protocol> | 897 </protocol> |
OLD | NEW |