| 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="zcr_remote_shell_v1" version="2"> | 41 <interface name="zcr_remote_shell_v1" version="3"> |
| 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 81 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 133 <arg name="transform" type="int"/> | 133 <arg name="transform" type="int"/> |
| 134 <arg name="scale_factor" type="fixed"/> | 134 <arg name="scale_factor" type="fixed"/> |
| 135 <arg name="work_area_inset_left" type="int"/> | 135 <arg name="work_area_inset_left" type="int"/> |
| 136 <arg name="work_area_inset_top" type="int"/> | 136 <arg name="work_area_inset_top" type="int"/> |
| 137 <arg name="work_area_inset_right" type="int"/> | 137 <arg name="work_area_inset_right" type="int"/> |
| 138 <arg name="work_area_inset_bottom" type="int"/> | 138 <arg name="work_area_inset_bottom" type="int"/> |
| 139 <arg name="layout_mode" type="uint"/> | 139 <arg name="layout_mode" type="uint"/> |
| 140 </event> | 140 </event> |
| 141 </interface> | 141 </interface> |
| 142 | 142 |
| 143 <interface name="zcr_remote_surface_v1" version="2"> | 143 <interface name="zcr_remote_surface_v1" version="3"> |
| 144 <description summary="A desktop window"> | 144 <description summary="A desktop window"> |
| 145 An interface that may be implemented by a wl_surface, for | 145 An interface that may be implemented by a wl_surface, for |
| 146 implementations that provide a desktop-style user interface | 146 implementations that provide a desktop-style user interface |
| 147 and allows for remotely managed windows. | 147 and allows for remotely managed windows. |
| 148 | 148 |
| 149 It provides requests to treat surfaces like windows, allowing to set | 149 It provides requests to treat surfaces like windows, allowing to set |
| 150 properties like app id and geometry. | 150 properties like app id and geometry. |
| 151 | 151 |
| 152 The client must call wl_surface.commit on the corresponding wl_surface | 152 The client must call wl_surface.commit on the corresponding wl_surface |
| 153 for the remote_surface state to take effect. | 153 for the remote_surface state to take effect. |
| (...skipping 46 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 200 | 200 |
| 201 <request name="set_scale"> | 201 <request name="set_scale"> |
| 202 <description summary="set scale"> | 202 <description summary="set scale"> |
| 203 Set a scale factor that will be applied to surface and all descendants. | 203 Set a scale factor that will be applied to surface and all descendants. |
| 204 </description> | 204 </description> |
| 205 <arg name="scale" type="fixed"/> | 205 <arg name="scale" type="fixed"/> |
| 206 </request> | 206 </request> |
| 207 | 207 |
| 208 <request name="set_rectangular_shadow"> | 208 <request name="set_rectangular_shadow"> |
| 209 <description summary="set a rectangular shadow"> | 209 <description summary="set a rectangular shadow"> |
| 210 » Request that surface needs a rectangular shadow. | 210 » [Deprecated] Request that surface needs a rectangular shadow. |
| 211 | 211 |
| 212 This is only a request that the surface should have a rectangular | 212 This is only a request that the surface should have a rectangular |
| 213 shadow. The compositor may choose to ignore this request. | 213 shadow. The compositor may choose to ignore this request. |
| 214 | 214 |
| 215 The arguments are given in the output coordinate space and specifies | 215 The arguments are given in the output coordinate space and specifies |
| 216 the inner bounds of the shadow. | 216 the inner bounds of the shadow. |
| 217 | 217 |
| 218 The arguments are given in the output coordinate space. | 218 The arguments are given in the output coordinate space. |
| 219 Specifying zero width and height will disable the shadow. | 219 Specifying zero width and height will disable the shadow. |
| 220 </description> | 220 </description> |
| (...skipping 154 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 375 This is an event to notify that the window state changed in compositor. | 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 | 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 | 377 action directly handled by the compositor. The client may choose to |
| 378 ignore this event. | 378 ignore this event. |
| 379 </description> | 379 </description> |
| 380 <arg name="state_type" type="uint"/> | 380 <arg name="state_type" type="uint"/> |
| 381 </event> | 381 </event> |
| 382 | 382 |
| 383 <!-- Version 2 additions --> | 383 <!-- Version 2 additions --> |
| 384 | 384 |
| 385 <request name="set_moving" since="2"> | 385 <request name="set_rectangular_surface_shadow" since="2"> |
| 386 <description summary="set a rectangular shadow"> |
| 387 » Request that surface needs a rectangular shadow. |
| 388 |
| 389 » This is only a request that the surface should have a rectangular |
| 390 » shadow. The compositor may choose to ignore this request. |
| 391 |
| 392 » The arguments are given in the remote surface coordinate space and |
| 393 » specifies inner bounds of the shadow. Specifying zero width and height |
| 394 » will disable the shadow. |
| 395 </description> |
| 396 <arg name="x" type="int"/> |
| 397 <arg name="y" type="int"/> |
| 398 <arg name="width" type="int"/> |
| 399 <arg name="height" type="int"/> |
| 400 </request> |
| 401 |
| 402 <!-- Version 3 additions --> |
| 403 |
| 404 <event name="configure" since="3"> |
| 405 <description summary="suggest a surface change"> |
| 406 » The configure event asks the client to change surface state. |
| 407 |
| 408 » The origin arguments specify the position, in the compositor coordinate |
| 409 » space, of the virtual display used by the client to simulate multiple |
| 410 » displays. The client must offset window positions in set_window_geometry |
| 411 » requests by this origin in order to convert between coordinate spaces. |
| 412 |
| 413 » Clients should arrange their surface for the new state, and then send an |
| 414 » ack_configure request with the serial sent in this configure event at |
| 415 » some point before committing the new surface. |
| 416 |
| 417 » If the client receives multiple configure events before it can respond |
| 418 » to one, it is free to discard all but the last event it received. |
| 419 </description> |
| 420 <arg name="origin_x" type="int"/> |
| 421 <arg name="origin_y" type="int"/> |
| 422 <arg name="serial" type="uint"/> |
| 423 </event> |
| 424 |
| 425 <request name="ack_configure" since="3"> |
| 426 <description summary="ack a configure event"> |
| 427 » When a configure event is received, if a client commits the |
| 428 » surface in response to the configure event, then the client |
| 429 » must make an ack_configure request sometime before the commit |
| 430 » request, passing along the serial of the configure event. |
| 431 |
| 432 » For instance, the compositor might use this information during display |
| 433 » configuration to change its coordinate space for set_window_geometry |
| 434 » requests only when the client has switched to the new coordinate space. |
| 435 |
| 436 » If the client receives multiple configure events before it |
| 437 » can respond to one, it only has to ack the last configure event. |
| 438 |
| 439 » A client is not required to commit immediately after sending |
| 440 » an ack_configure request - it may even ack_configure several times |
| 441 » before its next surface commit. |
| 442 |
| 443 » A client may send multiple ack_configure requests before committing, but |
| 444 » only the last request sent before a commit indicates which configure |
| 445 » event the client really is responding to. |
| 446 </description> |
| 447 <arg name="serial" type="uint" summary="the serial from the configure even
t"/> |
| 448 </request> |
| 449 |
| 450 <request name="set_moving" since="3"> |
| 386 <description summary="interactive move started"> | 451 <description summary="interactive move started"> |
| 387 Notifies the compositor when an interactive, user-driven move of the | 452 Notifies the compositor when an interactive, user-driven move of the |
| 388 surface starts. The compositor may assume that subsequent | 453 surface starts. The compositor may assume that subsequent |
| 389 set_window_geometry requests are position updates until it receives a | 454 set_window_geometry requests are position updates until it receives a |
| 390 unset_moving request. | 455 unset_moving request. |
| 391 </description> | 456 </description> |
| 392 </request> | 457 </request> |
| 393 | 458 |
| 394 <request name="unset_moving" since="2"> | 459 <request name="unset_moving" since="3"> |
| 395 <description summary="interactive move stopped"> | 460 <description summary="interactive move stopped"> |
| 396 Notifies the compositor when an interactive, user-driven move of the | 461 Notifies the compositor when an interactive, user-driven move of the |
| 397 surface stops. The compositor may choose to stop the move regardless | 462 surface stops. The compositor may choose to stop the move regardless |
| 398 of this request. | 463 of this request. |
| 399 </description> | 464 </description> |
| 400 </request> | 465 </request> |
| 466 |
| 401 </interface> | 467 </interface> |
| 402 | 468 |
| 403 <interface name="zcr_notification_surface_v1" version="1"> | 469 <interface name="zcr_notification_surface_v1" version="1"> |
| 404 <description summary="A notification window"> | 470 <description summary="A notification window"> |
| 405 An interface that may be implemented by a wl_surface to host | 471 An interface that may be implemented by a wl_surface to host |
| 406 notification contents. | 472 notification contents. |
| 407 </description> | 473 </description> |
| 408 | 474 |
| 409 <request name="destroy" type="destructor"> | 475 <request name="destroy" type="destructor"> |
| 410 <description summary="Destroy the notification_surface"> | 476 <description summary="Destroy the notification_surface"> |
| 411 Unmap and destroy the notification surface. | 477 Unmap and destroy the notification surface. |
| 412 </description> | 478 </description> |
| 413 </request> | 479 </request> |
| 414 </interface> | 480 </interface> |
| 415 | 481 |
| 416 </protocol> | 482 </protocol> |
| OLD | NEW |