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="6"> | 41 <interface name="zwp_remote_shell_v1" version="7"> |
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="state_type"> | |
58 <description summary="state types for remote surfaces"> | |
59 Defines common show states for shell surfaces. | |
60 </description> | |
61 <entry name="normal" value="1" summary="normal window state"/> | |
62 <entry name="minimized" value="2" summary="minimized window state"/> | |
63 <entry name="maximized" value="3" summary="maximized window state"/> | |
64 <entry name="fullscreen" value="4" summary="fullscreen window state"/> | |
65 <entry name="pinned" value="5" summary="pinned window state"/> | |
oshima
2016/06/28 18:36:00
just q: is it possible to add new types in the fut
reveman
2016/06/28 19:02:19
yes, new types can be added as long as we're not c
| |
66 </enum> | |
67 | |
57 <enum name="error"> | 68 <enum name="error"> |
58 <entry name="role" value="0" summary="given wl_surface has another role"/> | 69 <entry name="role" value="0" summary="given wl_surface has another role"/> |
59 <entry name="invalid_notification_id" value="1" | 70 <entry name="invalid_notification_id" value="1" |
60 summary="invalid notification id"/> | 71 summary="invalid notification id"/> |
61 </enum> | 72 </enum> |
62 | 73 |
63 <request name="destroy" type="destructor"> | 74 <request name="destroy" type="destructor"> |
64 <description summary="destroy remote_shell"> | 75 <description summary="destroy remote_shell"> |
65 Destroy this remote_shell object. | 76 Destroy this remote_shell object. |
66 | 77 |
(...skipping 36 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
103 Notifies client that the activated surface changed. | 114 Notifies client that the activated surface changed. |
104 </description> | 115 </description> |
105 <arg name="gained_active" type="object" interface="wl_surface" allow-null= "true"/> | 116 <arg name="gained_active" type="object" interface="wl_surface" allow-null= "true"/> |
106 <arg name="lost_active" type="object" interface="wl_surface" allow-null="t rue"/> | 117 <arg name="lost_active" type="object" interface="wl_surface" allow-null="t rue"/> |
107 </event> | 118 </event> |
108 | 119 |
109 <!-- Version 6 additions --> | 120 <!-- Version 6 additions --> |
110 | 121 |
111 <request name="get_notification_surface" since="6"> | 122 <request name="get_notification_surface" since="6"> |
112 <description summary="create a notification surface from a surface"> | 123 <description summary="create a notification surface from a surface"> |
113 Creates a notification_surface for the given surface, gives it the | 124 » Creates a notification_surface for the given surface, gives it the |
114 notification_surface role and associated it with a notification id. | 125 » notification_surface role and associated it with a notification id. |
hidehiko
2016/06/28 18:44:24
nit: s/\t/ /
reveman
2016/06/28 19:02:19
the rest of the file and other interfaces use tabs
hidehiko
2016/06/28 19:20:12
Looks mixed? At least, your new "state_type_change
reveman
2016/06/28 22:58:28
The style of upstream interfaces is 2 space indent
| |
115 </description> | 126 </description> |
116 <arg name="id" type="new_id" interface="zwp_notification_surface_v1"/> | 127 <arg name="id" type="new_id" interface="zwp_notification_surface_v1"/> |
117 <arg name="surface" type="object" interface="wl_surface"/> | 128 <arg name="surface" type="object" interface="wl_surface"/> |
118 <arg name="notification_id" type="string" /> | 129 <arg name="notification_id" type="string" /> |
119 </request> | 130 </request> |
120 </interface> | 131 </interface> |
121 | 132 |
122 <interface name="zwp_remote_surface_v1" version="6"> | 133 <interface name="zwp_remote_surface_v1" version="7"> |
123 <description summary="A desktop window"> | 134 <description summary="A desktop window"> |
124 An interface that may be implemented by a wl_surface, for | 135 An interface that may be implemented by a wl_surface, for |
125 implementations that provide a desktop-style user interface | 136 implementations that provide a desktop-style user interface |
126 and allows for remotely managed windows. | 137 and allows for remotely managed windows. |
127 | 138 |
128 It provides requests to treat surfaces like windows, allowing to set | 139 It provides requests to treat surfaces like windows, allowing to set |
129 properties like app id and geometry. | 140 properties like app id and geometry. |
130 | 141 |
131 The client must call wl_surface.commit on the corresponding wl_surface | 142 The client must call wl_surface.commit on the corresponding wl_surface |
132 for the remote_surface state to take effect. | 143 for the remote_surface state to take effect. |
(...skipping 269 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
402 </request> | 413 </request> |
403 | 414 |
404 <request name="set_top_inset" since="5"> | 415 <request name="set_top_inset" since="5"> |
405 <description summary="set top inset for surface"> | 416 <description summary="set top inset for surface"> |
406 Set distance from the top of the surface to the contents. | 417 Set distance from the top of the surface to the contents. |
407 | 418 |
408 This distance typically represents the size of the window caption. | 419 This distance typically represents the size of the window caption. |
409 </description> | 420 </description> |
410 <arg name="height" type="int"/> | 421 <arg name="height" type="int"/> |
411 </request> | 422 </request> |
423 | |
424 <!-- Version 7 additions --> | |
425 | |
426 <event name="state_type_changed" since="7"> | |
427 <description summary="surface state type changed"> | |
428 The state_type_changed event is sent by the compositor when the surface | |
429 state changed. | |
430 | |
431 This is an event to notify that the window state changed in compositor. | |
432 The state change may be triggered by a client's request, or some user | |
433 action directly handled by the compositor. The client may choose to | |
434 ignore this event. | |
435 </description> | |
436 <arg name="state_type" type="uint"/> | |
hidehiko
2016/06/28 18:44:24
QQ: Don't we need previous state type?
Is it neces
reveman
2016/06/28 19:02:19
I considered this but I can't think of anything we
hidehiko
2016/06/28 19:20:12
Thank you for explanation. I just wanted to clarif
| |
437 </event> | |
412 </interface> | 438 </interface> |
413 | 439 |
414 <!-- Version 6 additions --> | 440 <!-- Version 6 additions --> |
415 | 441 |
416 <interface name="zwp_notification_surface_v1" version="6"> | 442 <interface name="zwp_notification_surface_v1" version="6"> |
417 <description summary="A notification window"> | 443 <description summary="A notification window"> |
418 An interface that may be implemented by a wl_surface to host | 444 An interface that may be implemented by a wl_surface to host |
419 notification contents. | 445 notification contents. |
420 </description> | 446 </description> |
421 | 447 |
422 <request name="destroy" type="destructor"> | 448 <request name="destroy" type="destructor"> |
423 <description summary="Destroy the notification_surface"> | 449 <description summary="Destroy the notification_surface"> |
424 Unmap and destroy the notification surface. | 450 » Unmap and destroy the notification surface. |
425 </description> | 451 </description> |
426 </request> | 452 </request> |
427 </interface> | 453 </interface> |
428 | 454 |
429 </protocol> | 455 </protocol> |
OLD | NEW |