| 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="3"> | 41 <interface name="zcr_remote_shell_v1" version="4"> |
| 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 80 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 132 <arg name="width" type="int"/> | 132 <arg name="width" type="int"/> |
| 133 <arg name="height" type="int"/> | 133 <arg name="height" type="int"/> |
| 134 <arg name="transform" type="int"/> | 134 <arg name="transform" type="int"/> |
| 135 <arg name="scale_factor" type="fixed"/> | 135 <arg name="scale_factor" type="fixed"/> |
| 136 <arg name="work_area_inset_left" type="int"/> | 136 <arg name="work_area_inset_left" type="int"/> |
| 137 <arg name="work_area_inset_top" type="int"/> | 137 <arg name="work_area_inset_top" type="int"/> |
| 138 <arg name="work_area_inset_right" type="int"/> | 138 <arg name="work_area_inset_right" type="int"/> |
| 139 <arg name="work_area_inset_bottom" type="int"/> | 139 <arg name="work_area_inset_bottom" type="int"/> |
| 140 <arg name="layout_mode" type="uint"/> | 140 <arg name="layout_mode" type="uint"/> |
| 141 </event> | 141 </event> |
| 142 |
| 142 </interface> | 143 </interface> |
| 143 | 144 |
| 144 <interface name="zcr_remote_surface_v1" version="3"> | 145 <interface name="zcr_remote_surface_v1" version="4"> |
| 145 <description summary="A desktop window"> | 146 <description summary="A desktop window"> |
| 146 An interface that may be implemented by a wl_surface, for | 147 An interface that may be implemented by a wl_surface, for |
| 147 implementations that provide a desktop-style user interface | 148 implementations that provide a desktop-style user interface |
| 148 and allows for remotely managed windows. | 149 and allows for remotely managed windows. |
| 149 | 150 |
| 150 It provides requests to treat surfaces like windows, allowing to set | 151 It provides requests to treat surfaces like windows, allowing to set |
| 151 properties like app id and geometry. | 152 properties like app id and geometry. |
| 152 | 153 |
| 153 The client must call wl_surface.commit on the corresponding wl_surface | 154 The client must call wl_surface.commit on the corresponding wl_surface |
| 154 for the remote_surface state to take effect. | 155 for the remote_surface state to take effect. |
| 155 | 156 |
| 156 For a surface to be mapped by the compositor the client must have | 157 For a surface to be mapped by the compositor the client must have |
| 157 committed both an remote_surface state and a buffer. | 158 committed both an remote_surface state and a buffer. |
| 158 </description> | 159 </description> |
| 159 | 160 |
| 161 <enum name="systemui_visibility_state"> |
| 162 <description summary="systemui visibility behavior"> |
| 163 Determine the visibility behavior of the system UI. |
| 164 </description> |
| 165 <entry name="visible" value="1" summary="system ui is visible"/> |
| 166 <entry name="autohide_non_sticky" value="2" summary="system ui autohides a
nd is not sticky"/> |
| 167 <entry name="autohide_sticky" value="3" summary="system ui autohides and i
s sticky"/> |
| 168 </enum> |
| 169 |
| 160 <request name="destroy" type="destructor"> | 170 <request name="destroy" type="destructor"> |
| 161 <description summary="Destroy the remote_surface"> | 171 <description summary="Destroy the remote_surface"> |
| 162 Unmap and destroy the window. The window will be effectively | 172 Unmap and destroy the window. The window will be effectively |
| 163 hidden from the user's point of view, and all state will be lost. | 173 hidden from the user's point of view, and all state will be lost. |
| 164 </description> | 174 </description> |
| 165 </request> | 175 </request> |
| 166 | 176 |
| 167 <request name="set_app_id"> | 177 <request name="set_app_id"> |
| 168 <description summary="set application ID"> | 178 <description summary="set application ID"> |
| 169 Set an application identifier for the surface. | 179 Set an application identifier for the surface. |
| (...skipping 224 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 394 specifies inner bounds of the shadow. Specifying zero width and height | 404 specifies inner bounds of the shadow. Specifying zero width and height |
| 395 will disable the shadow. | 405 will disable the shadow. |
| 396 </description> | 406 </description> |
| 397 <arg name="x" type="int"/> | 407 <arg name="x" type="int"/> |
| 398 <arg name="y" type="int"/> | 408 <arg name="y" type="int"/> |
| 399 <arg name="width" type="int"/> | 409 <arg name="width" type="int"/> |
| 400 <arg name="height" type="int"/> | 410 <arg name="height" type="int"/> |
| 401 </request> | 411 </request> |
| 402 | 412 |
| 403 <!-- Version 3 additions --> | 413 <!-- Version 3 additions --> |
| 414 <request name="set_systemui_visibility" since="3"> |
| 415 <description summary="requests the system ui visibility behavior for the s
urface"> |
| 416 Requests how the surface will change the visibility of the system UI whe
n it is made active. |
| 417 </description> |
| 418 <arg name="visibility" type="uint"/> |
| 419 </request> |
| 404 | 420 |
| 405 <event name="configure" since="3"> | 421 <!-- Version 4 additions --> |
| 422 |
| 423 <event name="configure" since="4"> |
| 406 <description summary="suggest a surface change"> | 424 <description summary="suggest a surface change"> |
| 407 The configure event asks the client to change surface state. | 425 The configure event asks the client to change surface state. |
| 408 | 426 |
| 409 The origin arguments specify the position, in the compositor coordinate | 427 The origin arguments specify the position, in the compositor coordinate |
| 410 space, of the virtual display used by the client to simulate multiple | 428 space, of the virtual display used by the client to simulate multiple |
| 411 displays. The client must offset window positions in set_window_geometry | 429 displays. The client must offset window positions in set_window_geometry |
| 412 requests by this origin in order to convert between coordinate spaces. | 430 requests by this origin in order to convert between coordinate spaces. |
| 413 | 431 |
| 414 The states listed in the event are state_type values, and might change | 432 The states listed in the event are state_type values, and might change |
| 415 due to a client request or an event directly handled by the compositor. | 433 due to a client request or an event directly handled by the compositor. |
| 416 | 434 |
| 417 Clients should arrange their surface for the new state, and then send an | 435 Clients should arrange their surface for the new state, and then send an |
| 418 ack_configure request with the serial sent in this configure event at | 436 ack_configure request with the serial sent in this configure event at |
| 419 some point before committing the new surface. | 437 some point before committing the new surface. |
| 420 | 438 |
| 421 If the client receives multiple configure events before it can respond | 439 If the client receives multiple configure events before it can respond |
| 422 to one, it is free to discard all but the last event it received. | 440 to one, it is free to discard all but the last event it received. |
| 423 </description> | 441 </description> |
| 424 <arg name="origin_x" type="int"/> | 442 <arg name="origin_x" type="int"/> |
| 425 <arg name="origin_y" type="int"/> | 443 <arg name="origin_y" type="int"/> |
| 426 <arg name="states" type="array"/> | 444 <arg name="states" type="array"/> |
| 427 <arg name="serial" type="uint"/> | 445 <arg name="serial" type="uint"/> |
| 428 </event> | 446 </event> |
| 429 | 447 |
| 430 <request name="ack_configure" since="3"> | 448 <request name="ack_configure" since="4"> |
| 431 <description summary="ack a configure event"> | 449 <description summary="ack a configure event"> |
| 432 When a configure event is received, if a client commits the | 450 When a configure event is received, if a client commits the |
| 433 surface in response to the configure event, then the client | 451 surface in response to the configure event, then the client |
| 434 must make an ack_configure request sometime before the commit | 452 must make an ack_configure request sometime before the commit |
| 435 request, passing along the serial of the configure event. | 453 request, passing along the serial of the configure event. |
| 436 | 454 |
| 437 For instance, the compositor might use this information during display | 455 For instance, the compositor might use this information during display |
| 438 configuration to change its coordinate space for set_window_geometry | 456 configuration to change its coordinate space for set_window_geometry |
| 439 requests only when the client has switched to the new coordinate space. | 457 requests only when the client has switched to the new coordinate space. |
| 440 | 458 |
| 441 If the client receives multiple configure events before it | 459 If the client receives multiple configure events before it |
| 442 can respond to one, it only has to ack the last configure event. | 460 can respond to one, it only has to ack the last configure event. |
| 443 | 461 |
| 444 A client is not required to commit immediately after sending | 462 A client is not required to commit immediately after sending |
| 445 an ack_configure request - it may even ack_configure several times | 463 an ack_configure request - it may even ack_configure several times |
| 446 before its next surface commit. | 464 before its next surface commit. |
| 447 | 465 |
| 448 A client may send multiple ack_configure requests before committing, but | 466 A client may send multiple ack_configure requests before committing, but |
| 449 only the last request sent before a commit indicates which configure | 467 only the last request sent before a commit indicates which configure |
| 450 event the client really is responding to. | 468 event the client really is responding to. |
| 451 </description> | 469 </description> |
| 452 <arg name="serial" type="uint" summary="the serial from the configure even
t"/> | 470 <arg name="serial" type="uint" summary="the serial from the configure even
t"/> |
| 453 </request> | 471 </request> |
| 454 | 472 |
| 455 <request name="move" since="3"> | 473 <request name="move" since="4"> |
| 456 <description summary="start an interactive move"> | 474 <description summary="start an interactive move"> |
| 457 Start an interactive, user-driven move of the surface. | 475 Start an interactive, user-driven move of the surface. |
| 458 | 476 |
| 459 The compositor responds to this request with a configure event that | 477 The compositor responds to this request with a configure event that |
| 460 transitions to the "moving" state. The client must only initiate motion | 478 transitions to the "moving" state. The client must only initiate motion |
| 461 after acknowledging the state change. The compositor can assume that | 479 after acknowledging the state change. The compositor can assume that |
| 462 subsequent set_window_geometry requests are position updates until the | 480 subsequent set_window_geometry requests are position updates until the |
| 463 next state transition is acknowledged. | 481 next state transition is acknowledged. |
| 464 | 482 |
| 465 The compositor may ignore move requests depending on the state of the | 483 The compositor may ignore move requests depending on the state of the |
| (...skipping 10 matching lines...) Expand all Loading... |
| 476 </description> | 494 </description> |
| 477 | 495 |
| 478 <request name="destroy" type="destructor"> | 496 <request name="destroy" type="destructor"> |
| 479 <description summary="Destroy the notification_surface"> | 497 <description summary="Destroy the notification_surface"> |
| 480 Unmap and destroy the notification surface. | 498 Unmap and destroy the notification surface. |
| 481 </description> | 499 </description> |
| 482 </request> | 500 </request> |
| 483 </interface> | 501 </interface> |
| 484 | 502 |
| 485 </protocol> | 503 </protocol> |
| OLD | NEW |