1<?xml version="1.0" encoding="UTF-8"?> 2<protocol name="remote_shell_unstable_v1"> 3 4 <copyright> 5 Copyright 2016 The Chromium Authors. 6 7 Permission is hereby granted, free of charge, to any person obtaining a 8 copy of this software and associated documentation files (the "Software"), 9 to deal in the Software without restriction, including without limitation 10 the rights to use, copy, modify, merge, publish, distribute, sublicense, 11 and/or sell copies of the Software, and to permit persons to whom the 12 Software is furnished to do so, subject to the following conditions: 13 14 The above copyright notice and this permission notice (including the next 15 paragraph) shall be included in all copies or substantial portions of the 16 Software. 17 18 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 19 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 20 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 21 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 22 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 23 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 24 DEALINGS IN THE SOFTWARE. 25 </copyright> 26 27 <description summary="Create remote desktop-style surfaces"> 28 remote_shell allows clients to turn a wl_surface into a "real window" 29 which can be stacked and activated by the user. 30 31 Warning! The protocol described in this file is experimental and backward 32 incompatible changes may be made. Backward compatible changes may be added 33 together with the corresponding interface version bump. Backward 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 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 38 reset. 39 </description> 40 41 <interface name="zcr_remote_shell_v1" version="33"> 42 <description summary="remote_shell"> 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 45 and made fullscreen by the user. 46 </description> 47 48 <enum name="container"> 49 <description summary="containers for remote surfaces"> 50 Determine how a remote surface should be stacked relative to other 51 shell surfaces. 52 </description> 53 <entry name="default" value="1" summary="default container"/> 54 <entry name="overlay" value="2" summary="system modal container"/> 55 </enum> 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"/> 66 <entry name="trusted_pinned" value="6" summary="trusted pinned window state"/> 67 <entry name="moving" value="7" summary="moving window state"/> 68 <entry name="resizing" value="8" summary="resizing window state"/> 69 <entry name="left_snapped" value="9" summary="left snapped window state"/> 70 <entry name="right_snapped" value="10" summary="right snapped window state"/> 71 <entry name="pip" value="11" summary="pip window state"/> 72 </enum> 73 74 <enum name="error"> 75 <entry name="role" value="0" summary="given wl_surface has another role"/> 76 <entry name="invalid_notification_key" value="1" 77 summary="invalid notification key"/> 78 </enum> 79 80 <enum name="layout_mode"> 81 <description summary="the layout mode"> 82 Determine how a client should layout surfaces. 83 </description> 84 <entry name="windowed" value="1" summary="multiple windows"/> 85 <entry name="tablet" value="2" summary="restricted mode for tablet"/> 86 </enum> 87 88 <request name="destroy" type="destructor"> 89 <description summary="destroy remote_shell"> 90 Destroy this remote_shell object. 91 92 Destroying a bound remote_shell object while there are surfaces 93 still alive created by this remote_shell object instance is illegal 94 and will result in a protocol error. 95 </description> 96 </request> 97 98 <request name="get_remote_surface"> 99 <description summary="create a remote shell surface from a surface"> 100 This creates an remote_surface for the given surface and gives it the 101 remote_surface role. A wl_surface can only be given a remote_surface 102 role once. If get_remote_surface is called with a wl_surface that 103 already has an active remote_surface associated with it, or if it had 104 any other role, an error is raised. 105 106 See the documentation of remote_surface for more details about what an 107 remote_surface is and how it is used. 108 </description> 109 <arg name="id" type="new_id" interface="zcr_remote_surface_v1"/> 110 <arg name="surface" type="object" interface="wl_surface"/> 111 <arg name="container" type="uint"/> 112 </request> 113 114 <event name="activated"> 115 <description summary="activated surface changed"> 116 Notifies client that the activated surface changed. 117 </description> 118 <arg name="gained_active" type="object" interface="wl_surface" allow-null="true"/> 119 <arg name="lost_active" type="object" interface="wl_surface" allow-null="true"/> 120 </event> 121 122 <request name="get_notification_surface"> 123 <description summary="create a notification surface from a surface"> 124 Creates a notification_surface for the given surface, gives it the 125 notification_surface role and associated it with a notification id. 126 </description> 127 <arg name="id" type="new_id" interface="zcr_notification_surface_v1"/> 128 <arg name="surface" type="object" interface="wl_surface"/> 129 <arg name="notification_key" type="string" /> 130 </request> 131 132 <event name="configuration_changed"> 133 <description summary="suggests a re-configuration of remote shell"> 134 [Deprecated] Suggests a re-configuration of remote shell. 135 </description> 136 <arg name="width" type="int"/> 137 <arg name="height" type="int"/> 138 <arg name="transform" type="int"/> 139 <arg name="scale_factor" type="fixed"/> 140 <arg name="work_area_inset_left" type="int"/> 141 <arg name="work_area_inset_top" type="int"/> 142 <arg name="work_area_inset_right" type="int"/> 143 <arg name="work_area_inset_bottom" type="int"/> 144 <arg name="layout_mode" type="uint"/> 145 </event> 146 147 <!-- Version 5 additions --> 148 149 <event name="workspace" since="5"> 150 <description summary="area of remote shell"> 151 [Deprecated] Defines an area of the remote shell used for layout. Each series of 152 "workspace" events must be terminated by a "configure" event. 153 </description> 154 <arg name="display_id_hi" type="uint"/> 155 <arg name="display_id_lo" type="uint"/> 156 <arg name="x" type="int"/> 157 <arg name="y" type="int"/> 158 <arg name="width" type="int"/> 159 <arg name="height" type="int"/> 160 <arg name="inset_left" type="int"/> 161 <arg name="inset_top" type="int"/> 162 <arg name="inset_right" type="int"/> 163 <arg name="inset_bottom" type="int"/> 164 <arg name="transform" type="int"/> 165 <arg name="scale_factor" type="fixed"/> 166 <arg name="is_internal" type="uint" summary="1 if screen is built-in"/> 167 </event> 168 169 <event name="configure" since="5"> 170 <description summary="suggests configuration of remote shell"> 171 Suggests a new configuration of the remote shell. Preceded by a series 172 of "workspace" events. 173 </description> 174 <arg name="layout_mode" type="uint"/> 175 </event> 176 177 <!-- Version 8 additions --> 178 179 <event name="default_device_scale_factor" since="8"> 180 <description summary="initialize scale configuration"> 181 Sends the default device scale factor. 182 </description> 183 <arg name="scale" type="int" summary="DP to pixels ratio, in 8.24 fixed point format"/> 184 </event> 185 186 <!-- Version 17 additions --> 187 188 <request name="get_input_method_surface" since="17"> 189 <description summary="Create a input method surface from a surface"> 190 Creates an input_method_surface for the given surface, gives it 191 the input_method_surface role. 192 </description> 193 <arg name="id" type="new_id" interface="zcr_input_method_surface_v1"/> 194 <arg name="surface" type="object" interface="wl_surface"/> 195 </request> 196 197 <!-- Version 19 additions --> 198 199 <event name="display_info" since="19"> 200 <description summary="extra display information"> 201 [Deprecated] Sends display size in pixels and display identification data, typically 202 in EDID format. Preceded by a "workspace" event for the same display. 203 </description> 204 <arg name="display_id_hi" type="uint"/> 205 <arg name="display_id_lo" type="uint"/> 206 <arg name="width" type="int"/> 207 <arg name="height" type="int"/> 208 <arg name="identification_data" type="array"/> 209 </event> 210 211 <!-- Version 20 additions --> 212 213 <event name="workspace_info" since="20"> 214 <description summary="area of remote shell in pixels"> 215 [Deprecated] Sends display information such as size, work area and its related information. 216 Each series of "workspace_info" events must be terminated by a "configure" event. 217 </description> 218 <arg name="display_id_hi" type="uint"/> 219 <arg name="display_id_lo" type="uint"/> 220 <arg name="x" type="int"/> 221 <arg name="y" type="int"/> 222 <arg name="width" type="int"/> 223 <arg name="height" type="int"/> 224 <arg name="inset_left" type="int"/> 225 <arg name="inset_top" type="int"/> 226 <arg name="inset_right" type="int"/> 227 <arg name="inset_bottom" type="int"/> 228 <arg name="stable_inset_left" type="int"/> 229 <arg name="stable_inset_top" type="int"/> 230 <arg name="stable_inset_right" type="int"/> 231 <arg name="stable_inset_bottom" type="int"/> 232 <arg name="systemui_visibility" type="int" summary="systemui_visibility_state"/> 233 <arg name="transform" type="int"/> 234 <arg name="is_internal" type="uint" summary="1 if screen is built-in"/> 235 <arg name="identification_data" type="array" summary="EDID blob data"/> 236 </event> 237 238 <!-- Version 28 additions --> 239 240 <request name="get_toast_surface" since="28"> 241 <description summary="Create a toast surface from a surface"> 242 Creates an toast_surface for the given surface, gives it 243 the toast_surface role. 244 </description> 245 <arg name="id" type="new_id" interface="zcr_toast_surface_v1"/> 246 <arg name="surface" type="object" interface="wl_surface"/> 247 </request> 248 249 <!-- Version 29 additions --> 250 251 <event name="layout_mode" since="29"> 252 <description summary="sends the layout_mode"> 253 Sends the layout_mode used by the server. 254 </description> 255 <arg name="layout_mode" type="uint" summary="layout_mode enum"/> 256 </event> 257 258 <request name="get_remote_output" since="29"> 259 <description summary="extend output interface for remote shell"> 260 Instantiate an interface extension for the given wl_output to 261 provide remote shell functionality. 262 </description> 263 <arg name="id" type="new_id" interface="zcr_remote_output_v1" summary="the new remote output interface id"/> 264 <arg name="output" type="object" interface="wl_output" summary="the output"/> 265 </request> 266 267 <request name="set_use_default_device_scale_cancellation" since="29"> 268 <description summary="set use default device scale cancellation"> 269 Request the compositor to use the default_device_scale_factor to undo any 270 scaling applied to the client's buffers. When this is disabled, the 271 compositor will use the device_scale_factor of the display of the buffer to 272 cancel any buffer scaling. 273 </description> 274 <arg name="use_default_device_scale_factor" type="int" summary="0 if false"/> 275 </request> 276 277 <!-- Version 30 additions --> 278 279 <enum name="desktop_focus_state"> 280 <description summary="desktop foucs state"> 281 Desktop client window focus state. 282 </description> 283 <entry name="no_focus" value="1" summary="no window get focused"/> 284 <entry name="client_focused" value="2" summary="client window get focused"/> 285 <entry name="other_client_focused" value="3" summary="other client window get focused"/> 286 </enum> 287 288 <event name="desktop_focus_state_changed" since="30"> 289 <description summary="desktop window focus state change"> 290 Notifies client that the window focus state change. 291 </description> 292 <arg name="focus_state" type="uint"/> 293 </event> 294 295 </interface> 296 297 <interface name="zcr_remote_surface_v1" version="33"> 298 <description summary="A desktop window"> 299 An interface that may be implemented by a wl_surface, for 300 implementations that provide a desktop-style user interface 301 and allows for remotely managed windows. 302 303 It provides requests to treat surfaces like windows, allowing to set 304 properties like app id and geometry. 305 306 The client must call wl_surface.commit on the corresponding wl_surface 307 for the remote_surface state to take effect. 308 309 For a surface to be mapped by the compositor the client must have 310 committed both an remote_surface state and a buffer. 311 </description> 312 313 <enum name="systemui_visibility_state"> 314 <description summary="systemui visibility behavior"> 315 Determine the visibility behavior of the system UI. 316 </description> 317 <entry name="visible" value="1" summary="system ui is visible"/> 318 <entry name="autohide_non_sticky" value="2" summary="system ui autohides and is not sticky"/> 319 <entry name="autohide_sticky" value="3" summary="system ui autohides and is sticky"/> 320 </enum> 321 322 <enum name="orientation"> 323 <description summary="window orientation"> 324 The orientation of the window. 325 </description> 326 <entry name="portrait" value="1" summary="portrait"/> 327 <entry name="landscape" value="2" summary="landscape"/> 328 </enum> 329 330 <enum name="window_type"> 331 <description summary="window type"> 332 The type of the window. 333 </description> 334 <entry name="normal" value="1" summary="normal app window"/> 335 <entry name="system_ui" value="2" summary="window is treated as systemui"/> 336 <entry name="hidden_in_overview" value="3" summary="window is normal, but hidden in overview"/> 337 </enum> 338 339 <request name="destroy" type="destructor"> 340 <description summary="Destroy the remote_surface"> 341 Unmap and destroy the window. The window will be effectively 342 hidden from the user's point of view, and all state will be lost. 343 </description> 344 </request> 345 346 <request name="set_app_id"> 347 <description summary="set application ID"> 348 Set an application identifier for the surface. 349 </description> 350 <arg name="app_id" type="string"/> 351 </request> 352 353 <request name="set_window_geometry"> 354 <description summary="set the new window geometry"> 355 [Deprecated] The window geometry of a window is its "visible bounds" 356 from the user's perspective. Client-side decorations often have 357 invisible portions like drop-shadows which should be ignored for the 358 purposes of aligning, placing and constraining windows. 359 360 The window geometry is double buffered, and will be applied at the 361 time wl_surface.commit of the corresponding wl_surface is called. 362 363 Once the window geometry of the surface is set once, it is not 364 possible to unset it, and it will remain the same until 365 set_window_geometry is called again, even if a new subsurface or 366 buffer is attached. 367 368 If never set, the value is the full bounds of the output. This 369 updates dynamically on every commit. 370 371 The arguments are given in the output coordinate space. 372 373 The width and height must be greater than zero. 374 </description> 375 <arg name="x" type="int"/> 376 <arg name="y" type="int"/> 377 <arg name="width" type="int"/> 378 <arg name="height" type="int"/> 379 </request> 380 381 <request name="set_scale"> 382 <description summary="set scale"> 383 Set a scale factor that will be applied to surface and all descendants. 384 </description> 385 <arg name="scale" type="fixed"/> 386 </request> 387 388 <request name="set_rectangular_shadow"> 389 <description summary="set a rectangular shadow"> 390 [Deprecated] Request that surface needs a rectangular shadow. 391 392 This is only a request that the surface should have a rectangular 393 shadow. The compositor may choose to ignore this request. 394 395 The arguments are given in the output coordinate space and specifies 396 the inner bounds of the shadow. 397 398 The arguments are given in the output coordinate space. 399 Specifying zero width and height will disable the shadow. 400 </description> 401 <arg name="x" type="int"/> 402 <arg name="y" type="int"/> 403 <arg name="width" type="int"/> 404 <arg name="height" type="int"/> 405 </request> 406 407 <request name="set_rectangular_shadow_background_opacity"> 408 <description summary="suggests the window's background opacity"> 409 [Deprecated] Suggests the window's background opacity when the shadow is requested. 410 </description> 411 <arg name="opacity" type="fixed"/> 412 </request> 413 414 <request name="set_title"> 415 <description summary="set surface title"> 416 Set a short title for the surface. 417 418 This string may be used to identify the surface in a task bar, 419 window list, or other user interface elements provided by the 420 compositor. 421 422 The string must be encoded in UTF-8. 423 </description> 424 <arg name="title" type="string"/> 425 </request> 426 427 <request name="set_top_inset"> 428 <description summary="set top inset for surface"> 429 Set distance from the top of the surface to the contents. 430 431 This distance typically represents the size of the window caption. 432 </description> 433 <arg name="height" type="int"/> 434 </request> 435 436 <request name="activate"> 437 <description summary="make the surface active"> 438 Make the surface active and bring it to the front. 439 </description> 440 <arg name="serial" type="uint" summary="the serial of the user event"/> 441 </request> 442 443 <request name="maximize"> 444 <description summary="maximize"> 445 Request that surface is maximized. The window geometry will be updated 446 to whatever the compositor finds appropriate for a maximized window. 447 448 This is only a request that the window should be maximized. The 449 compositor may choose to ignore this request. The client should 450 listen to set_maximized events to determine if the window was 451 maximized or not. 452 </description> 453 </request> 454 455 <request name="minimize"> 456 <description summary="minimize"> 457 Request that surface is minimized. 458 459 This is only a request that the window should be minimized. The 460 compositor may choose to ignore this request. The client should 461 listen to set_minimized events to determine if the window was 462 minimized or not. 463 </description> 464 </request> 465 466 <request name="restore"> 467 <description summary="restore"> 468 Request that surface is restored. This restores the window geometry 469 to what it was before the window was minimized, maximized or made 470 fullscreen. 471 472 This is only a request that the window should be restored. The 473 compositor may choose to ignore this request. The client should 474 listen to unset_maximized, unset_minimize and unset_fullscreen 475 events to determine if the window was restored or not. 476 </description> 477 </request> 478 479 <request name="fullscreen"> 480 <description summary="fullscreen"> 481 Request that surface is made fullscreen. 482 483 This is only a request that the window should be made fullscreen. 484 The compositor may choose to ignore this request. The client should 485 listen to set_fullscreen events to determine if the window was 486 made fullscreen or not. 487 </description> 488 </request> 489 490 <request name="unfullscreen"> 491 <description summary="unfullscreen"> 492 Request that surface is made unfullscreen. 493 494 This is only a request that the window should be made unfullscreen. 495 The compositor may choose to ignore this request. The client should 496 listen to unset_fullscreen events to determine if the window was 497 made unfullscreen or not. 498 </description> 499 </request> 500 501 <request name="pin"> 502 <description summary="pin"> 503 Request that surface is pinned. 504 505 This is only a request that the window should be pinned. 506 The compositor may choose to ignore this request. The client should 507 listen to state_changed events to determine if the window was 508 pinned or not. If trusted flag is non-zero, the app can prevent users 509 from exiting the pinned mode. 510 </description> 511 <arg name="trusted" type="int"/> 512 </request> 513 514 <request name="unpin"> 515 <description summary="unpin"> 516 Request that surface is unpinned. 517 518 This is only a request that the window should be unpinned. 519 The compositor may choose to ignore this request. The client should 520 listen to unset_pinned events to determine if the window was 521 unpinned or not. 522 </description> 523 </request> 524 525 <request name="set_system_modal"> 526 <description summary="suggests a re-layout of remote shell input area"> 527 Suggests a surface should become system modal. 528 </description> 529 </request> 530 531 <request name="unset_system_modal"> 532 <description summary="suggests a re-layout of remote shell input area"> 533 Suggests a surface should become non system modal. 534 </description> 535 </request> 536 537 <event name="close"> 538 <description summary="surface wants to be closed"> 539 The close event is sent by the compositor when the user 540 wants the surface to be closed. This should be equivalent to 541 the user clicking the close button in client-side decorations, 542 if your application has any... 543 544 This is only a request that the user intends to close your 545 window. The client may choose to ignore this request, or show 546 a dialog to ask the user to save their data... 547 </description> 548 </event> 549 550 <event name="state_type_changed"> 551 <description summary="surface state type changed"> 552 [Deprecated] The state_type_changed event is sent by the compositor when 553 the surface state changed. 554 555 This is an event to notify that the window state changed in compositor. 556 The state change may be triggered by a client's request, or some user 557 action directly handled by the compositor. The client may choose to 558 ignore this event. 559 </description> 560 <arg name="state_type" type="uint"/> 561 </event> 562 563 <!-- Version 2 additions --> 564 565 <request name="set_rectangular_surface_shadow" since="2"> 566 <description summary="set a rectangular shadow"> 567 Request that surface needs a rectangular shadow. 568 569 This is only a request that the surface should have a rectangular 570 shadow. The compositor may choose to ignore this request. 571 572 The arguments are given in the remote surface coordinate space and 573 specifies inner bounds of the shadow. Specifying zero width and height 574 will disable the shadow. 575 </description> 576 <arg name="x" type="int"/> 577 <arg name="y" type="int"/> 578 <arg name="width" type="int"/> 579 <arg name="height" type="int"/> 580 </request> 581 582 <!-- Version 3 additions --> 583 584 <request name="set_systemui_visibility" since="3"> 585 <description summary="requests the system ui visibility behavior for the surface"> 586 Requests how the surface will change the visibility of the system UI when it is made active. 587 </description> 588 <arg name="visibility" type="uint"/> 589 </request> 590 591 <!-- Version 4 additions --> 592 593 <request name="set_always_on_top" since="4"> 594 <description summary="set always on top"> 595 Request that surface is made to be always on top. 596 597 This is only a request that the window should be always on top. 598 The compositor may choose to ignore this request. 599 600 </description> 601 </request> 602 603 <request name="unset_always_on_top" since="4"> 604 <description summary="unset always on top"> 605 Request that surface is made to be not always on top. 606 607 This is only a request that the window should be not always on top. 608 The compositor may choose to ignore this request. 609 </description> 610 </request> 611 612 <!-- Version 5 additions --> 613 614 <event name="configure" since="5"> 615 <description summary="suggest a surface change"> 616 The configure event asks the client to change surface state. 617 618 The client must apply the origin offset to window positions in 619 set_window_geometry requests. 620 621 The states listed in the event are state_type values, and might change 622 due to a client request or an event directly handled by the compositor. 623 624 Clients should arrange their surface for the new state, and then send an 625 ack_configure request with the serial sent in this configure event at 626 some point before committing the new surface. 627 628 If the client receives multiple configure events before it can respond 629 to one, it is free to discard all but the last event it received. 630 </description> 631 <arg name="origin_offset_x" type="int"/> 632 <arg name="origin_offset_y" type="int"/> 633 <arg name="states" type="array"/> 634 <arg name="serial" type="uint"/> 635 </event> 636 637 <request name="ack_configure" since="5"> 638 <description summary="ack a configure event"> 639 When a configure event is received, if a client commits the 640 surface in response to the configure event, then the client 641 must make an ack_configure request sometime before the commit 642 request, passing along the serial of the configure event. 643 644 For instance, the compositor might use this information during display 645 configuration to change its coordinate space for set_window_geometry 646 requests only when the client has switched to the new coordinate space. 647 648 If the client receives multiple configure events before it 649 can respond to one, it only has to ack the last configure event. 650 651 A client is not required to commit immediately after sending 652 an ack_configure request - it may even ack_configure several times 653 before its next surface commit. 654 655 A client may send multiple ack_configure requests before committing, but 656 only the last request sent before a commit indicates which configure 657 event the client really is responding to. 658 </description> 659 <arg name="serial" type="uint" summary="the serial from the configure event"/> 660 </request> 661 662 <request name="move" since="5"> 663 <description summary="start an interactive move"> 664 [Deprecated] Start an interactive, user-driven move of the surface. 665 666 The compositor responds to this request with a configure event that 667 transitions to the "moving" state. The client must only initiate motion 668 after acknowledging the state change. The compositor can assume that 669 subsequent set_window_geometry requests are position updates until the 670 next state transition is acknowledged. 671 672 The compositor may ignore move requests depending on the state of the 673 surface, e.g. fullscreen or maximized. 674 </description> 675 </request> 676 677 <!-- Version 6 additions --> 678 679 <request name="set_orientation" since="6"> 680 <description summary="set orientation"> 681 Set an orientation for the surface. 682 </description> 683 <arg name="orientation" type="int"/> 684 </request> 685 686 <!-- Version 7 additions --> 687 688 <request name="set_window_type" since="7"> 689 <description summary="set the type of the window"> 690 Set the type of window. This is only a hint to the compositor and the 691 compositor is free to ignore it. 692 </description> 693 <arg name="type" type="uint" summary="type of the window"/> 694 </request> 695 696 <!-- Version 9 additions --> 697 698 <request name="resize" since="9"> 699 <description summary="start an interactive resize"> 700 [Deprecated] Start an interactive, user-driven resize of the surface. 701 702 The compositor responds to this request with a configure event that 703 transitions to the "resizing" state. The client must only initiate 704 resizing after acknowledging the state change. The compositor can assume 705 that subsequent set_window_geometry requests are resizes until the next 706 state transition is acknowledged. 707 708 The compositor may ignore resize requests depending on the state of the 709 surface, e.g. fullscreen or maximized. 710 </description> 711 </request> 712 713 <request name="set_resize_outset" since="9"> 714 <description summary="expand input region for resizing"> 715 Expand input region of surface with resize outset. 716 717 The compositor clips the input region of each surface to its bounds, 718 unless the client requests a resize outset. In that case, the input 719 region of the root surface is expanded to allow for some leeway around 720 visible bounds when starting a user-driven resize. 721 </description> 722 <arg name="outset" type="int"/> 723 </request> 724 725 <event name="window_geometry_changed" since="9"> 726 <description summary="announce window geometry commit"> 727 Notify the client of committed window geometry. 728 729 The compositor sends this event when it commits window geometry. The 730 client may use this information to convert coordinates of input events 731 using the latest committed geometry. 732 </description> 733 <arg name="x" type="int"/> 734 <arg name="y" type="int"/> 735 <arg name="width" type="int"/> 736 <arg name="height" type="int"/> 737 </event> 738 739 <!-- Version 10 additions --> 740 741 <enum name="bounds_change_reason"> 742 <description summary="bounds_change_reason"> 743 Specifies the cause of the window bounds change event. 744 </description> 745 <entry name="drag_move" value="1" summary="the window is being moved by drag operation"/> 746 <entry name="drag_resize" value="2" summary="the window is being resized by drag operation."/> 747 <entry name="snap_to_left" value="3" 748 summary="the window is resized to left snapped state"/> 749 <entry name="snap_to_right" value="4" 750 summary="the window is resized to right snapped state"/> 751 <entry name="move" value="5" 752 summary="the window bounds is moved due to other WM operations"/> 753 <entry name="resize" value="6" 754 summary="the window bounds is reiszed due to other WM operations"/> 755 <entry name="pip" value="7" summary="the window bounds is resized or moved for PIP"/> 756 </enum> 757 758 <event name="bounds_changed" since="10"> 759 <description summary="The compositor requested to change the bounds"> 760 [Deprecated] The compositor requested to change its 761 bounds. "bounds_change_reason" specifies the cause of the 762 bounds change. The client may apply the different move/resize 763 strategy depending on the reason. 764 765 "display_id_hi", "display_id_lo" specifies in which workspace 766 the surface should live in. 767 768 The client responds with set_window_geometry request, with the 769 bounds it is resized to (this may be different from the bounds 770 requested). 771 772 The client may ignore move request depending on the state, 773 e.g, if it becomes resizable or other constrants. 774 </description> 775 <arg name="display_id_hi" type="uint"/> 776 <arg name="display_id_lo" type="uint"/> 777 <arg name="x" type="int"/> 778 <arg name="y" type="int"/> 779 <arg name="width" type="int"/> 780 <arg name="height" type="int"/> 781 <arg name="bounds_change_reason" type="uint"/> 782 </event> 783 784 <request name="start_move" since="10"> 785 <description summary="start an interactive move"> 786 Request an interactive, user-driven move of the surface. "x" 787 and "y" specifies the starting point of the pointer device 788 that initiated the move. 789 790 The compositor responds to this request with a drag_started 791 event with "none" direction. Please see drag_started event 792 for more details. 793 794 The compositor may ignore move requests depending on the state of the 795 surface, e.g. fullscreen or maximized. 796 </description> 797 <arg name="x" type="int"/> 798 <arg name="y" type="int"/> 799 </request> 800 801 <enum name="resize_direction"> 802 <description summary="resize direction"> 803 The resize direction for drag operation 804 </description> 805 <entry name="none" value="0" summary="move only, no resize"/> 806 <entry name="left" value="1" summary="resize to the left"/> 807 <entry name="topleft" value="2" summary="resize to the top left"/> 808 <entry name="top" value="3" summary="resize to the top"/> 809 <entry name="topright" value="4" summary="resize to the top right"/> 810 <entry name="right" value="5" summary="resize to the right"/> 811 <entry name="bottomright" value="6" summary="resize to the buttom right"/> 812 <entry name="bottom" value="7" summary="resize to the bottom"/> 813 <entry name="bottomleft" value="8" summary="resize to the bottom left"/> 814 </enum> 815 816 <event name="drag_started" since="10"> 817 <description summary="Notifies that a drag to move/resize started."> 818 Notifies a client that the compositor started drag 819 operation. "direction" specifies which direction it is being 820 resized. "none" direction means just move but not resize. 821 822 This will be followed by series of the "bounds_changed" event 823 with "drag_resize" or "drag_move" reasons to update the window 824 bounds druing the drag operation. 825 </description> 826 <arg name="direction" type="uint"/> 827 </event> 828 829 <event name="drag_finished" since="10"> 830 <description summary="Notifies that a drag operation has finished."> 831 Called when the drag operation is finished. "x" and "y" 832 specifies the position of the pointer device used to drag. 833 "canceled" is true if the drag operation is aborted during 834 drag (e.g. by capture change or user action.) 835 </description> 836 <arg name="x" type="int"/> 837 <arg name="y" type="int"/> 838 <arg name="canceled" type="int" summary="true if the operation was canceled"/> 839 </event> 840 841 <request name="set_can_maximize" since="10"> 842 <description summary="set can_maximize"> 843 Request that surface can be in maximzied state. 844 </description> 845 </request> 846 847 <request name="unset_can_maximize" since="10"> 848 <description summary="unset can_maximize"> 849 Request that surface can not be in maximzied state. 850 </description> 851 </request> 852 853 <request name="set_min_size" since="10"> 854 <description summary="set the minimum size"> 855 Set a minimum size of the surface. 856 857 Values set in this way are double-buffered. They will get 858 applied on the next commit. 859 </description> 860 <arg name="width" type="int"/> 861 <arg name="height" type="int"/> 862 </request> 863 864 <request name="set_max_size" since="10"> 865 <description summary="set the maximum size"> 866 Set a maximum size of the surface. 867 868 Values set in this way are double-buffered. They will get 869 applied on the next commit. 870 871 Setting the same size as minimum size makes the surface 872 unresizable. 873 </description> 874 <arg name="width" type="int"/> 875 <arg name="height" type="int"/> 876 </request> 877 878 <!-- Version 11 additions --> 879 880 <request name="set_snapped_to_left" since="11"> 881 <description summary="set the surface to left snapped"> 882 Request that surface is snapped to left. 883 </description> 884 </request> 885 886 <request name="set_snapped_to_right" since="11"> 887 <description summary="set the surface to right snapped"> 888 Request that surface is snapped to right. 889 </description> 890 </request> 891 892 <!-- Version 12 additions --> 893 894 <request name="start_resize" since="12"> 895 <description summary="start an interactive resize"> 896 Request to start an interactive, user-driven resize of the surface. 897 "x" and "y" specifies the starting point of the pointer device 898 that initiated the reize. 899 900 The compositor responds to this request with a "drag_started" 901 event, followed by "bounds_changed" events, and ends the 902 resize operation with a "drag_finhsed" event. The compositor 903 determines the new bounds using the resize_direction and the 904 pointer event location. 905 906 The compositor may ignore resize requests depending on the state of the 907 surface, e.g. fullscreen or maximized, or no drag event is in pregress. 908 </description> 909 <arg name="resize_direction" type="uint" summary="the direction of resize"/> 910 <arg name="x" type="int"/> 911 <arg name="y" type="int"/> 912 </request> 913 914 <!-- Version 13 additions --> 915 916 <enum name="frame_type"> 917 <description summary="frame types"> 918 Frame type that can be used to decorate a surface. 919 </description> 920 <entry name="none" value="0" summary="no frame"/> 921 <entry name="normal" value="1" summary="caption with shadow" /> 922 <entry name="shadow" value="2" summary="shadow only"/> 923 <entry name="autohide" value="3" summary="autohide frame with shadow"/> 924 <entry name="overlay" value="4" summary="overlay frame with shadow" /> 925 </enum> 926 927 <request name="set_frame" since="13"> 928 <description summary="request a frame for surface"> 929 Enables compositor side frame decoration. |type| 930 specifies the type of frame to use for the surface. 931 </description> 932 <arg name="type" type="uint" summary="the frame type"/> 933 </request> 934 935 <enum name="frame_button_type"> 936 <description summary="frame button types"> 937 The mask that represents buttons on frame. 938 </description> 939 <entry name="back" value="1" summary="a button to naviate backwards"/> 940 <entry name="minimize" value="2" summary="a button to minimize the window"/> 941 <entry name="maximize_restore" value="4" 942 summary="a button to maximize or restore"/> 943 <entry name="menu" value="8" 944 summary="a button to activate application's menu"/> 945 <entry name="close" value="16" summary="a button to close the window"/> 946 <entry name="zoom" value="32" 947 summary="a mask to turn the maximize_restore button to zoom button"/> 948 </enum> 949 950 <request name="set_frame_buttons" since="13"> 951 <description summary="updates buttons' state on frame"> 952 Updates the frame's button state. |visible_buttons| and |enabled_buttons| 953 are the union of button mask defined in |frame_button_type| enum. 954 955 The mask present in |enabled_buttons| but not in |visible_buttons| will 956 be ignored. 957 </description> 958 <arg name="visible_buttons" type="uint"/> 959 <arg name="enabled_buttons" type="uint"/> 960 </request> 961 962 <request name="set_extra_title" since="13"> 963 <description summary="set extra title string"> 964 The extra informational string about the surface. This can be 965 used to show the debug information in the title bar, or log 966 messages. 967 968 This is different from "set_title" which is used to identify 969 the surface. 970 971 The string must be encoded in UTF-8. 972 </description> 973 <arg name="extra_title" type="string"/> 974 </request> 975 976 <!-- Version 14 additions --> 977 978 <enum name="orientation_lock"> 979 <description summary="orientation lock request for remote surfaces"> 980 Defines orientation request when a remote surface is in foreground. 981 </description> 982 <entry name="none" value="1" summary="no orientation lock"/> 983 <entry name="portrait" value="2" summary="primary or secondary portrait"/> 984 <entry name="landscape" value="3" summary="primary or secondary landscape"/> 985 <entry name="current" value="4" summary="keep current orientation"/> 986 <entry name="portrait_primary" value="5" summary="primary portrait"/> 987 <entry name="landscape_primary" value="6" summary="primary landscape"/> 988 <entry name="portrait_secondary" value="7" summary="secondary portrait"/> 989 <entry name="landscape_secondary" value="8" summary="secondary landscape"/> 990 </enum> 991 992 <request name="set_orientation_lock" since="14"> 993 <description summary="set orientation lock for a remote surface"> 994 Request a specific orientation behavior when this surface is in foreground. 995 </description> 996 <arg name="orientation_lock" type="uint" summary="the orientation lock"/> 997 </request> 998 999 <!-- Version 15 additions --> 1000 1001 <request name="pip" since="15"> 1002 <description summary="set pip for a remote surface"> 1003 Request that surface is set to Picture-in-Picture (PIP). 1004 </description> 1005 </request> 1006 1007 <!-- Version 18 additions --> 1008 1009 <request name="set_bounds" since="18"> 1010 <description summary="set window bounds"> 1011 [Deprecated] Set the "visible bounds" of a window from the user's perspective. 1012 Client-side decorations often have invisible portions like drop shadows 1013 which should be ignored for the purposes of aligning, placing and 1014 constraining windows. 1015 1016 The bounds are double buffered, and will be applied at the 1017 time wl_surface.commit of the corresponding wl_surface is called. 1018 1019 Once the bounds are set, it is not possible to unset them, and they will 1020 remain the same until set_bounds is called again, even if a new sub- 1021 surface or buffer is attached. 1022 1023 If never set, the value is the surface content bounds. This updates 1024 dynamically on every commit. 1025 1026 The bounds are relative to the given display. If the display is invalid, 1027 they are assumed to be relative to the primary display. 1028 1029 The width and height must be greater than zero. 1030 </description> 1031 <arg name="display_id_hi" type="uint"/> 1032 <arg name="display_id_lo" type="uint"/> 1033 <arg name="x" type="int"/> 1034 <arg name="y" type="int"/> 1035 <arg name="width" type="int"/> 1036 <arg name="height" type="int"/> 1037 </request> 1038 1039 <!-- Version 19 additions --> 1040 1041 <request name="set_aspect_ratio" since="19"> 1042 <description summary="set the maximum size"> 1043 Set an aspect ratio of the surface. 1044 1045 Values set in this way are double-buffered. They will get 1046 applied on the next commit. 1047 1048 Setting the aspect ratio of the surface. The ratio of the values is used 1049 for the ratio of width to height of the surface. The size of surface is 1050 restricted to the ratio. If any value is zero, the restriction on aspect 1051 ratio is unset. 1052 </description> 1053 <arg name="width" type="int"/> 1054 <arg name="height" type="int"/> 1055 </request> 1056 1057 <!-- Version 20 additions --> 1058 1059 <request name="block_ime" since="20"> 1060 <description summary="block server side IME"> 1061 Block server side IME and always send key events through Wayland. 1062 1063 For some client, it's possible that server side IME is connected to the 1064 client through other mechanism e.g. ime.mojom. When set_ime_blocked 1065 is requested, server side IME should give up handling key events and 1066 forward those events through Wayland protocol. 1067 </description> 1068 </request> 1069 1070 <request name="unblock_ime" since="20"> 1071 <description summary="unblock host side IME"> 1072 Unblock server side IME. Some events can be handled by server side IME, 1073 while others can still be sent through Wayland protocol. See the 1074 description of set_ime_blocked for detail. 1075 </description> 1076 </request> 1077 1078 <!-- Version 23 additions --> 1079 <enum name="zoom_change"> 1080 <description summary="zoom level change"> 1081 Zoom level change. 1082 </description> 1083 <entry name="in" value="0" summary="zoom in"/> 1084 <entry name="out" value="1" summary="zoom out"/> 1085 <entry name="reset" value="2" summary="reset zoom level"/> 1086 </enum> 1087 1088 <event name="change_zoom_level" since="23"> 1089 <description summary="change zoom level"> 1090 Request application zoom level change. 1091 </description> 1092 <arg name="change" type="int" summary="zoom_change"/> 1093 </event> 1094 1095 <!-- Version 25 additions --> 1096 <request name="set_accessibility_id" since="25"> 1097 <description summary="set accessibility ID to the surface"> 1098 Set accessibility window ID to the surface 1099 </description> 1100 <arg name="id" type="int" summary="Accessibility ID. Negative number causes to unset existing accessibility ID from the surface."/> 1101 </request> 1102 1103 <!-- Version 26 additions --> 1104 <request name="set_pip_original_window" since="26"> 1105 <description summary="set the pip original window"> 1106 Set this surface the original window for the current PIP window. 1107 </description> 1108 </request> 1109 1110 <request name="unset_pip_original_window" since="26"> 1111 <description summary="unset the pip original window"> 1112 Unset this surface the original window for the current PIP window. 1113 </description> 1114 </request> 1115 1116 <!-- Version 27 additions --> 1117 <request name="set_system_gesture_exclusion" since="27"> 1118 <description summary="set system gesture exclusion"> 1119 Set system gesture exclusion region in which system gestures e.g. back 1120 gesture should not be triggered. 1121 </description> 1122 <arg name="region" type="object" interface="wl_region" allow-null="true"/> 1123 </request> 1124 1125 <!-- Version 31 additions --> 1126 <request name="set_resize_lock" since="31"> 1127 <description summary="set resize lock state"> 1128 Enable the resize lock and put restrictions related to resizing on 1129 the shell surface. 1130 1131 The resize lock state is double buffered, and will be applied at the 1132 time wl_surface.commit of the corresponding wl_surface is called. 1133 </description> 1134 </request> 1135 1136 <request name="unset_resize_lock" since="31"> 1137 <description summary="unset resize lock state"> 1138 Disable the resize lock and allow the shell surface to be resized 1139 freely. 1140 1141 The resize lock state is double buffered, and will be applied at the 1142 time wl_surface.commit of the corresponding wl_surface is called. 1143 </description> 1144 </request> 1145 1146 <!-- Version 33 additions --> 1147 1148 <event name="bounds_changed_in_output" since="33"> 1149 <description summary="The compositor requested to change the bounds"> 1150 The compositor requested to change its 1151 bounds. "bounds_change_reason" specifies the cause of the 1152 bounds change. The client may apply the different move/resize 1153 strategy depending on the reason. 1154 1155 The "output" specifies the wayland output in which the suface should live. 1156 1157 The client responds with set_window_geometry request, with the 1158 bounds it is resized to (this may be different from the bounds 1159 requested). 1160 1161 The client may ignore move request depending on the state, 1162 e.g, if it becomes resizable or other constrants. 1163 </description> 1164 <arg name="output" type="object" interface="wl_output" summary="the output"/> 1165 <arg name="x" type="int"/> 1166 <arg name="y" type="int"/> 1167 <arg name="width" type="int"/> 1168 <arg name="height" type="int"/> 1169 <arg name="bounds_change_reason" type="uint"/> 1170 </event> 1171 1172 <request name="set_bounds_in_output" since="33"> 1173 <description summary="set window bounds"> 1174 Set the "visible bounds" of a window from the user's perspective. 1175 Client-side decorations often have invisible portions like drop shadows 1176 which should be ignored for the purposes of aligning, placing and 1177 constraining windows. 1178 1179 The bounds are double buffered, and will be applied at the 1180 time wl_surface.commit of the corresponding wl_surface is called. 1181 1182 Once the bounds are set, it is not possible to unset them, and they will 1183 remain the same until set_bounds is called again, even if a new sub- 1184 surface or buffer is attached. 1185 1186 If never set, the value is the surface content bounds. This updates 1187 dynamically on every commit. 1188 1189 The bounds are relative to the given display. If the display is invalid, 1190 they are assumed to be relative to the primary display. 1191 1192 The width and height must be greater than zero. 1193 </description> 1194 <arg name="output" type="object" interface="wl_output" summary="the output"/> 1195 <arg name="x" type="int"/> 1196 <arg name="y" type="int"/> 1197 <arg name="width" type="int"/> 1198 <arg name="height" type="int"/> 1199 </request> 1200 </interface> 1201 1202 <interface name="zcr_notification_surface_v1" version="16"> 1203 <description summary="A notification window"> 1204 An interface that may be implemented by a wl_surface to host 1205 notification contents. 1206 </description> 1207 1208 <request name="destroy" type="destructor"> 1209 <description summary="Destroy the notification_surface"> 1210 Unmap and destroy the notification surface. 1211 </description> 1212 </request> 1213 1214 <!-- Version 16 additions --> 1215 1216 <request name="set_app_id" since="16"> 1217 <description summary="set application ID"> 1218 Set an application identifier for the notification surface. 1219 </description> 1220 <arg name="app_id" type="string"/> 1221 </request> 1222 </interface> 1223 1224 <interface name="zcr_input_method_surface_v1" version="33"> 1225 <description summary="An input method window"> 1226 An interface that may be implemented by a wl_surface to host IME contents. 1227 </description> 1228 1229 <request name="destroy" type="destructor"> 1230 <description summary="Destroy the ime_surface"> 1231 Unmap and destroy the input mtehod surface. 1232 </description> 1233 </request> 1234 1235 <!-- Version 18 additions --> 1236 1237 <request name="set_bounds" since="18"> 1238 <description summary="set window bounds"> 1239 [Deprecated] Set the "visible bounds" of a window from the user's perspective. 1240 1241 The bounds are double buffered, and will be applied at the 1242 time wl_surface.commit of the corresponding wl_surface is called. 1243 1244 Once the bounds are set, it is not possible to unset them, and they will 1245 remain the same until set_bounds is called again, even if a new sub- 1246 surface or buffer is attached. 1247 1248 If never set, the value is the surface content bounds. This updates 1249 dynamically on every commit. 1250 1251 The bounds are relative to the given display. If the display is invalid, 1252 they are assumed to be relative to the primary display. 1253 1254 The width and height must be greater than zero. 1255 </description> 1256 <arg name="display_id_hi" type="uint"/> 1257 <arg name="display_id_lo" type="uint"/> 1258 <arg name="x" type="int"/> 1259 <arg name="y" type="int"/> 1260 <arg name="width" type="int"/> 1261 <arg name="height" type="int"/> 1262 </request> 1263 1264 <!-- Version 33 additions --> 1265 1266 <request name="set_bounds_in_output" since="33"> 1267 <description summary="set window bounds"> 1268 Set the "visible bounds" of a window from the user's perspective. 1269 1270 The bounds are double buffered, and will be applied at the 1271 time wl_surface.commit of the corresponding wl_surface is called. 1272 1273 Once the bounds are set, it is not possible to unset them, and they will 1274 remain the same until set_bounds is called again, even if a new sub- 1275 surface or buffer is attached. 1276 1277 If never set, the value is the surface content bounds. This updates 1278 dynamically on every commit. 1279 1280 The bounds are relative to the given display. If the display is invalid, 1281 they are assumed to be relative to the primary display. 1282 1283 The width and height must be greater than zero. 1284 </description> 1285 <arg name="output" type="object" interface="wl_output" summary="the output"/> 1286 <arg name="x" type="int"/> 1287 <arg name="y" type="int"/> 1288 <arg name="width" type="int"/> 1289 <arg name="height" type="int"/> 1290 </request> 1291 </interface> 1292 1293 <interface name="zcr_toast_surface_v1" version="33"> 1294 <description summary="A toast window"> 1295 An interface that may be implemented by a wl_surface to host 1296 toast contents. 1297 </description> 1298 1299 <request name="destroy" type="destructor"> 1300 <description summary="Destroy the toast_surface"> 1301 Unmap and destroy the toast surface. 1302 </description> 1303 </request> 1304 1305 <request name="set_position"> 1306 <description summary="set toast bounds position"> 1307 [Deprecated] Set the position of bounds of a window from the user's perspective. 1308 1309 The bounds are double buffered, and will be applied at the 1310 time wl_surface.commit of the corresponding wl_surface is called. 1311 1312 Once the bounds are set, it is not possible to unset them, and they will 1313 remain the same until set_position is called again, even if a new sub- 1314 surface or buffer is attached. 1315 1316 If never set, the compositor will determine the toast position. 1317 1318 The bounds are relative to the given display. If the display is invalid, 1319 they are assumed to be relative to the primary display. 1320 </description> 1321 <arg name="display_id_hi" type="uint"/> 1322 <arg name="display_id_lo" type="uint"/> 1323 <arg name="x" type="int"/> 1324 <arg name="y" type="int"/> 1325 </request> 1326 1327 <request name="set_size"> 1328 <description summary="set toast bounds size"> 1329 [Deprecated] Set the size of bounds of a window from the user's perspective. 1330 1331 The bounds are double buffered, and will be applied at the 1332 time wl_surface.commit of the corresponding wl_surface is called. 1333 1334 Once the bounds are set, it is not possible to unset them, and they will 1335 remain the same until set_size is called again, even if a new sub- 1336 surface or buffer is attached. 1337 1338 If never set, the value is the surface content bounds. This updates 1339 dynamically on every commit. 1340 1341 The width and height must be greater than zero. 1342 </description> 1343 <arg name="width" type="int"/> 1344 <arg name="height" type="int"/> 1345 </request> 1346 1347 <!-- Version 33 additions --> 1348 1349 <request name="set_bounds_in_output" since="33"> 1350 <description summary="set toast bounds position"> 1351 Set the bounds of a toast window from the user's perspective. 1352 1353 The bounds are double buffered, and will be applied at the 1354 time wl_surface.commit of the corresponding wl_surface is called. 1355 1356 Once the bounds are set, it is not possible to unset them, and they will 1357 remain the same until set_bounds is called again, even if a new sub- 1358 surface or buffer is attached. 1359 1360 If never set, the compositor will determine the toast position. 1361 1362 The bounds are relative to the given display. If the display is invalid, 1363 they are assumed to be relative to the primary display. 1364 </description> 1365 <arg name="output" type="object" interface="wl_output" summary="the output"/> 1366 <arg name="x" type="int"/> 1367 <arg name="y" type="int"/> 1368 <arg name="width" type="int"/> 1369 <arg name="height" type="int"/> 1370 </request> 1371 </interface> 1372 1373 <interface name="zcr_remote_output_v1" version="32"> 1374 <description summary="remote shell interface to a wl_output"> 1375 An additional interface to a wl_output object, which allows the 1376 client to access additional functionality for output. 1377 </description> 1378 1379 <request name="destroy" type="destructor" since="29"> 1380 <description summary="destroy remote_output"> 1381 Destroy this remote_output object. 1382 </description> 1383 </request> 1384 1385 <event name="display_id" since="29"> 1386 <description summary="the identifier for the display"> 1387 [Deprecated] Sends the display identifier used by the server for the display. 1388 </description> 1389 <arg name="display_id_hi" type="uint"/> 1390 <arg name="display_id_lo" type="uint"/> 1391 </event> 1392 1393 <event name="port" since="29"> 1394 <description summary="the port of the display"> 1395 Sends the port to which the display is connected for the server. 1396 </description> 1397 <arg name="port" type="uint"/> 1398 </event> 1399 1400 <event name="identification_data" since="29"> 1401 <description summary="the identification data for the display"> 1402 Sends the identification data for the display, typically in the EDID format. 1403 </description> 1404 <arg name="identification_data" type="array"/> 1405 </event> 1406 1407 <event name="insets" since="29"> 1408 <description summary="insets for the display in pixels"> 1409 Sends inset information about a particular display in the display's native coordinates. 1410 </description> 1411 <arg name="inset_left" type="int"/> 1412 <arg name="inset_top" type="int"/> 1413 <arg name="inset_right" type="int"/> 1414 <arg name="inset_bottom" type="int"/> 1415 </event> 1416 1417 <event name="stable_insets" since="29"> 1418 <description summary="stable insets for a display in pixels"> 1419 Sends stable inset information about a particular display in the display's native 1420 coordinates. 1421 </description> 1422 <arg name="stable_inset_left" type="int"/> 1423 <arg name="stable_inset_top" type="int"/> 1424 <arg name="stable_inset_right" type="int"/> 1425 <arg name="stable_inset_bottom" type="int"/> 1426 </event> 1427 1428 <event name="systemui_visibility" since="29"> 1429 <description summary="systemui_visibility_state for a display"> 1430 [Deprecated] Sends information about whether the systemui is visible. 1431 The "systemui_visibility" value is of enum type "systemui_visibility_state". 1432 </description> 1433 <arg name="systemui_visibility" type="int" summary="systemui_visibility_state enum"/> 1434 </event> 1435 1436 <!-- Version 32 additions --> 1437 1438 <enum name="systemui_behavior"> 1439 <description summary="systemui behavior"> 1440 Determine the behavior of the system UI. 1441 </description> 1442 <entry name="visible" value="1" summary="system ui is visible"/> 1443 <entry name="hidden" value="2" summary="system ui is autohide or hidden"/> 1444 </enum> 1445 1446 <event name="systemui_behavior" since="32"> 1447 <description summary="systemui_behavior_state for a display"> 1448 Sends information about whether the systemui behavior is auto hide. 1449 The "systemui_behavior" value is of enum type "systemui_behavior". 1450 </description> 1451 <arg name="systemui_behavior" type="int" summary="systemui_behavior enum"/> 1452 </event> 1453 1454 </interface> 1455 1456</protocol> 1457