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="5"> | 41 <interface name="zwp_remote_shell_v1" version="6"> |
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. |
52 </description> | 52 </description> |
53 <entry name="default" value="1" summary="default container"/> | 53 <entry name="default" value="1" summary="default container"/> |
54 <entry name="overlay" value="2" summary="system modal container"/> | 54 <entry name="overlay" value="2" summary="system modal container"/> |
55 </enum> | 55 </enum> |
56 | 56 |
57 <enum name="error"> | 57 <enum name="error"> |
58 <entry name="role" value="0" summary="given wl_surface has another role"/> | 58 <entry name="role" value="0" summary="given wl_surface has another role"/> |
59 <entry name="invalid_notification_id" value="1" | |
60 summary="invalid notification id"/> | |
59 </enum> | 61 </enum> |
60 | 62 |
61 <request name="destroy" type="destructor"> | 63 <request name="destroy" type="destructor"> |
62 <description summary="destroy remote_shell"> | 64 <description summary="destroy remote_shell"> |
63 Destroy this remote_shell object. | 65 Destroy this remote_shell object. |
64 | 66 |
65 Destroying a bound remote_shell object while there are surfaces | 67 Destroying a bound remote_shell object while there are surfaces |
66 still alive created by this remote_shell object instance is illegal | 68 still alive created by this remote_shell object instance is illegal |
67 and will result in a protocol error. | 69 and will result in a protocol error. |
68 </description> | 70 </description> |
69 </request> | 71 </request> |
70 | 72 |
71 <request name="get_remote_surface"> | 73 <request name="get_remote_surface"> |
72 <description summary="create a remote shell surface from a surface"> | 74 <description summary="create a remote shell surface from a surface"> |
73 This creates an remote_surface for the given surface and gives it the | 75 This creates an remote_surface for the given surface and gives it the |
74 remote_surface role. A wl_surface can only be given a remote_surface | 76 remote_surface role. A wl_surface can only be given a remote_surface |
75 role once. If get_remote_surface is called with a wl_surface that | 77 role once. If get_remote_surface is called with a wl_surface that |
76 already has an active remote_surface associated with it, or if it had | 78 already has an active remote_surface associated with it, or if it had |
77 any other role, an error is raised. | 79 any other role, an error is raised. |
78 | 80 |
79 See the documentation of remote_surface for more details about what an | 81 See the documentation of remote_surface for more details about what an |
80 remote_surface is and how it is used. | 82 remote_surface is and how it is used. |
81 </description> | 83 </description> |
82 <arg name="id" type="new_id" interface="zwp_remote_surface_v1"/> | 84 <arg name="id" type="new_id" interface="zwp_remote_surface_v1"/> |
83 <arg name="surface" type="object" interface="wl_surface"/> | 85 <arg name="surface" type="object" interface="wl_surface"/> |
84 <arg name="container" type="uint"/> | 86 <arg name="container" type="uint"/> |
85 </request> | 87 </request> |
86 | 88 |
89 <request name="get_notification_surface" since="6"> | |
reveman
2016/06/23 18:28:00
please move this down to "Version 6 additions" sec
xiyuan
2016/06/23 18:34:11
Added a "Version 6 additions" section for zwp_remo
| |
90 <description summary="create a notification surface from a surface"> | |
91 Creates a notification_surface for the given surface, gives it the | |
92 notification_surface role and associated it with a notification id. | |
93 </description> | |
94 <arg name="id" type="new_id" interface="zwp_notification_surface_v1"/> | |
95 <arg name="surface" type="object" interface="wl_surface"/> | |
96 <arg name="notification_id" type="string" /> | |
97 </request> | |
98 | |
87 <event name="configure"> | 99 <event name="configure"> |
88 <description summary="suggests a re-layout of remote shell"> | 100 <description summary="suggests a re-layout of remote shell"> |
89 Suggests a re-layout of remote surface geometry. | 101 Suggests a re-layout of remote surface geometry. |
90 </description> | 102 </description> |
91 <arg name="width" type="int"/> | 103 <arg name="width" type="int"/> |
92 <arg name="height" type="int"/> | 104 <arg name="height" type="int"/> |
93 <arg name="work_area_inset_left" type="int"/> | 105 <arg name="work_area_inset_left" type="int"/> |
94 <arg name="work_area_inset_top" type="int"/> | 106 <arg name="work_area_inset_top" type="int"/> |
95 <arg name="work_area_inset_right" type="int"/> | 107 <arg name="work_area_inset_right" type="int"/> |
96 <arg name="work_area_inset_bottom" type="int"/> | 108 <arg name="work_area_inset_bottom" type="int"/> |
97 </event> | 109 </event> |
98 | 110 |
99 <event name="activated"> | 111 <event name="activated"> |
100 <description summary="activated surface changed"> | 112 <description summary="activated surface changed"> |
101 Notifies client that the activated surface changed. | 113 Notifies client that the activated surface changed. |
102 </description> | 114 </description> |
103 <arg name="gained_active" type="object" interface="wl_surface" allow-null= "true"/> | 115 <arg name="gained_active" type="object" interface="wl_surface" allow-null= "true"/> |
104 <arg name="lost_active" type="object" interface="wl_surface" allow-null="t rue"/> | 116 <arg name="lost_active" type="object" interface="wl_surface" allow-null="t rue"/> |
105 </event> | 117 </event> |
106 </interface> | 118 </interface> |
107 | 119 |
108 <interface name="zwp_remote_surface_v1" version="5"> | 120 <interface name="zwp_remote_surface_v1" version="6"> |
109 <description summary="A desktop window"> | 121 <description summary="A desktop window"> |
110 An interface that may be implemented by a wl_surface, for | 122 An interface that may be implemented by a wl_surface, for |
111 implementations that provide a desktop-style user interface | 123 implementations that provide a desktop-style user interface |
112 and allows for remotely managed windows. | 124 and allows for remotely managed windows. |
113 | 125 |
114 It provides requests to treat surfaces like windows, allowing to set | 126 It provides requests to treat surfaces like windows, allowing to set |
115 properties like app id and geometry. | 127 properties like app id and geometry. |
116 | 128 |
117 The client must call wl_surface.commit on the corresponding wl_surface | 129 The client must call wl_surface.commit on the corresponding wl_surface |
118 for the remote_surface state to take effect. | 130 for the remote_surface state to take effect. |
(...skipping 271 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
390 <request name="set_top_inset" since="5"> | 402 <request name="set_top_inset" since="5"> |
391 <description summary="set top inset for surface"> | 403 <description summary="set top inset for surface"> |
392 Set distance from the top of the surface to the contents. | 404 Set distance from the top of the surface to the contents. |
393 | 405 |
394 This distance typically represents the size of the window caption. | 406 This distance typically represents the size of the window caption. |
395 </description> | 407 </description> |
396 <arg name="height" type="int"/> | 408 <arg name="height" type="int"/> |
397 </request> | 409 </request> |
398 </interface> | 410 </interface> |
399 | 411 |
412 <!-- Version 6 additions --> | |
413 | |
414 <interface name="zwp_notification_surface_v1" version="6"> | |
415 <description summary="A notification window"> | |
416 An interface that may be implemented by a wl_surface to host | |
417 notification contents. | |
418 </description> | |
419 | |
420 <request name="destroy" type="destructor"> | |
421 <description summary="Destroy the notification_surface"> | |
422 Unmap and destroy the notification surface. | |
423 </description> | |
424 </request> | |
425 </interface> | |
426 | |
400 </protocol> | 427 </protocol> |
OLD | NEW |