| 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 376 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 387 notification contents. | 387 notification contents. |
| 388 </description> | 388 </description> |
| 389 | 389 |
| 390 <request name="destroy" type="destructor"> | 390 <request name="destroy" type="destructor"> |
| 391 <description summary="Destroy the notification_surface"> | 391 <description summary="Destroy the notification_surface"> |
| 392 Unmap and destroy the notification surface. | 392 Unmap and destroy the notification surface. |
| 393 </description> | 393 </description> |
| 394 </request> | 394 </request> |
| 395 </interface> | 395 </interface> |
| 396 | 396 |
| 397 <interface name="zwp_remote_shell_v1" version="11"> | |
| 398 <description summary="DEPRECATED"> | |
| 399 The global interface that allows clients to turn a wl_surface into a | |
| 400 "real window" which is remotely managed but can be stacked, activated | |
| 401 and made fullscreen by the user. | |
| 402 </description> | |
| 403 | |
| 404 <enum name="container"> | |
| 405 <description summary="containers for remote surfaces"> | |
| 406 Determine how a remote surface should be stacked relative to other | |
| 407 shell surfaces. | |
| 408 </description> | |
| 409 <entry name="default" value="1" summary="default container"/> | |
| 410 <entry name="overlay" value="2" summary="system modal container"/> | |
| 411 </enum> | |
| 412 | |
| 413 <enum name="state_type"> | |
| 414 <description summary="state types for remote surfaces"> | |
| 415 Defines common show states for shell surfaces. | |
| 416 </description> | |
| 417 <entry name="normal" value="1" summary="normal window state"/> | |
| 418 <entry name="minimized" value="2" summary="minimized window state"/> | |
| 419 <entry name="maximized" value="3" summary="maximized window state"/> | |
| 420 <entry name="fullscreen" value="4" summary="fullscreen window state"/> | |
| 421 <entry name="pinned" value="5" summary="pinned window state"/> | |
| 422 <entry name="trusted_pinned" value="6" summary="trusted pinned window stat
e"/> | |
| 423 </enum> | |
| 424 | |
| 425 <enum name="error"> | |
| 426 <entry name="role" value="0" summary="given wl_surface has another role"/> | |
| 427 <entry name="invalid_notification_id" value="1" | |
| 428 summary="invalid notification id"/> | |
| 429 </enum> | |
| 430 | |
| 431 <enum name="layout_mode"> | |
| 432 <description summary="the layout mode"> | |
| 433 Determine how a client should layout surfaces. | |
| 434 </description> | |
| 435 <entry name="windowed" value="1" summary="multiple windows"/> | |
| 436 <entry name="tablet" value="2" summary="restricted mode for tablet"/> | |
| 437 </enum> | |
| 438 | |
| 439 <request name="destroy" type="destructor"> | |
| 440 <description summary="destroy remote_shell"> | |
| 441 Destroy this remote_shell object. | |
| 442 | |
| 443 Destroying a bound remote_shell object while there are surfaces | |
| 444 still alive created by this remote_shell object instance is illegal | |
| 445 and will result in a protocol error. | |
| 446 </description> | |
| 447 </request> | |
| 448 | |
| 449 <request name="get_remote_surface"> | |
| 450 <description summary="create a remote shell surface from a surface"> | |
| 451 This creates an remote_surface for the given surface and gives it the | |
| 452 remote_surface role. A wl_surface can only be given a remote_surface | |
| 453 role once. If get_remote_surface is called with a wl_surface that | |
| 454 already has an active remote_surface associated with it, or if it had | |
| 455 any other role, an error is raised. | |
| 456 | |
| 457 See the documentation of remote_surface for more details about what an | |
| 458 remote_surface is and how it is used. | |
| 459 </description> | |
| 460 <arg name="id" type="new_id" interface="zwp_remote_surface_v1"/> | |
| 461 <arg name="surface" type="object" interface="wl_surface"/> | |
| 462 <arg name="container" type="uint"/> | |
| 463 </request> | |
| 464 | |
| 465 <event name="configure"> | |
| 466 <description summary="suggests a re-layout of remote shell"> | |
| 467 Obsolete: Suggests a re-layout of remote surface geometry. | |
| 468 </description> | |
| 469 <arg name="width" type="int"/> | |
| 470 <arg name="height" type="int"/> | |
| 471 <arg name="work_area_inset_left" type="int"/> | |
| 472 <arg name="work_area_inset_top" type="int"/> | |
| 473 <arg name="work_area_inset_right" type="int"/> | |
| 474 <arg name="work_area_inset_bottom" type="int"/> | |
| 475 </event> | |
| 476 | |
| 477 <event name="activated"> | |
| 478 <description summary="activated surface changed"> | |
| 479 Notifies client that the activated surface changed. | |
| 480 </description> | |
| 481 <arg name="gained_active" type="object" interface="wl_surface" allow-null=
"true"/> | |
| 482 <arg name="lost_active" type="object" interface="wl_surface" allow-null="t
rue"/> | |
| 483 </event> | |
| 484 | |
| 485 <!-- Version 6 additions --> | |
| 486 | |
| 487 <request name="get_notification_surface" since="6"> | |
| 488 <description summary="create a notification surface from a surface"> | |
| 489 Creates a notification_surface for the given surface, gives it the | |
| 490 notification_surface role and associated it with a notification id. | |
| 491 </description> | |
| 492 <arg name="id" type="new_id" interface="zwp_notification_surface_v1"/> | |
| 493 <arg name="surface" type="object" interface="wl_surface"/> | |
| 494 <arg name="notification_id" type="string" /> | |
| 495 </request> | |
| 496 | |
| 497 <!-- Version 8 additions --> | |
| 498 | |
| 499 <event name="layout_mode_changed" since="8"> | |
| 500 <description summary="layout mode changed"> | |
| 501 The shell_mode_changed event is sent by the compositor when | |
| 502 the shell mode was changed. | |
| 503 | |
| 504 This is an event to notify that the shell mode has switched. | |
| 505 </description> | |
| 506 <arg name="layout_mode" type="uint"/> | |
| 507 </event> | |
| 508 | |
| 509 <!-- Version 9 additions --> | |
| 510 | |
| 511 <event name="configuration_changed" since="9"> | |
| 512 <description summary="suggests a re-configuration of remote shell"> | |
| 513 Suggests a re-configuration of remote shell. | |
| 514 </description> | |
| 515 <arg name="width" type="int"/> | |
| 516 <arg name="height" type="int"/> | |
| 517 <arg name="transform" type="int"/> | |
| 518 <arg name="scale_factor" type="fixed"/> | |
| 519 <arg name="work_area_inset_left" type="int"/> | |
| 520 <arg name="work_area_inset_top" type="int"/> | |
| 521 <arg name="work_area_inset_right" type="int"/> | |
| 522 <arg name="work_area_inset_bottom" type="int"/> | |
| 523 <arg name="layout_mode" type="uint"/> | |
| 524 </event> | |
| 525 </interface> | |
| 526 | |
| 527 <interface name="zwp_remote_surface_v1" version="11"> | |
| 528 <description summary="DEPRECATED"> | |
| 529 An interface that may be implemented by a wl_surface, for | |
| 530 implementations that provide a desktop-style user interface | |
| 531 and allows for remotely managed windows. | |
| 532 | |
| 533 It provides requests to treat surfaces like windows, allowing to set | |
| 534 properties like app id and geometry. | |
| 535 | |
| 536 The client must call wl_surface.commit on the corresponding wl_surface | |
| 537 for the remote_surface state to take effect. | |
| 538 | |
| 539 For a surface to be mapped by the compositor the client must have | |
| 540 committed both an remote_surface state and a buffer. | |
| 541 </description> | |
| 542 | |
| 543 <request name="destroy" type="destructor"> | |
| 544 <description summary="Destroy the remote_surface"> | |
| 545 Unmap and destroy the window. The window will be effectively | |
| 546 hidden from the user's point of view, and all state will be lost. | |
| 547 </description> | |
| 548 </request> | |
| 549 | |
| 550 <request name="set_app_id"> | |
| 551 <description summary="set application ID"> | |
| 552 Set an application identifier for the surface. | |
| 553 </description> | |
| 554 <arg name="app_id" type="string"/> | |
| 555 </request> | |
| 556 | |
| 557 <request name="set_window_geometry"> | |
| 558 <description summary="set the new window geometry"> | |
| 559 The window geometry of a window is its "visible bounds" from the | |
| 560 user's perspective. Client-side decorations often have invisible | |
| 561 portions like drop-shadows which should be ignored for the | |
| 562 purposes of aligning, placing and constraining windows. | |
| 563 | |
| 564 The window geometry is double buffered, and will be applied at the | |
| 565 time wl_surface.commit of the corresponding wl_surface is called. | |
| 566 | |
| 567 Once the window geometry of the surface is set once, it is not | |
| 568 possible to unset it, and it will remain the same until | |
| 569 set_window_geometry is called again, even if a new subsurface or | |
| 570 buffer is attached. | |
| 571 | |
| 572 If never set, the value is the full bounds of the output. This | |
| 573 updates dynamically on every commit. | |
| 574 | |
| 575 The arguments are given in the output coordinate space. | |
| 576 | |
| 577 The width and height must be greater than zero. | |
| 578 </description> | |
| 579 <arg name="x" type="int"/> | |
| 580 <arg name="y" type="int"/> | |
| 581 <arg name="width" type="int"/> | |
| 582 <arg name="height" type="int"/> | |
| 583 </request> | |
| 584 | |
| 585 <request name="set_scale"> | |
| 586 <description summary="set scale"> | |
| 587 Set a scale factor that will be applied to surface and all descendants. | |
| 588 </description> | |
| 589 <arg name="scale" type="fixed"/> | |
| 590 </request> | |
| 591 | |
| 592 <event name="set_fullscreen"> | |
| 593 <description summary="surface wants to be fullscreen"> | |
| 594 The set_fullscreen event is sent by the compositor when the user | |
| 595 wants the surface to be made fullscreen. | |
| 596 | |
| 597 This is only a request that the user intends to make your | |
| 598 window fullscreen. The client may choose to ignore this request. | |
| 599 </description> | |
| 600 </event> | |
| 601 | |
| 602 <event name="unset_fullscreen"> | |
| 603 <description summary="surface wants to be non-fullscreen"> | |
| 604 The unset_fullscreen event is sent by the compositor when the user | |
| 605 wants the surface to be made non-fullscreen. | |
| 606 | |
| 607 This is only a request that the user intends to make your | |
| 608 window non-fullscreen. The client may choose to ignore this request. | |
| 609 </description> | |
| 610 </event> | |
| 611 | |
| 612 <event name="close"> | |
| 613 <description summary="surface wants to be closed"> | |
| 614 The close event is sent by the compositor when the user | |
| 615 wants the surface to be closed. This should be equivalent to | |
| 616 the user clicking the close button in client-side decorations, | |
| 617 if your application has any... | |
| 618 | |
| 619 This is only a request that the user intends to close your | |
| 620 window. The client may choose to ignore this request, or show | |
| 621 a dialog to ask the user to save their data... | |
| 622 </description> | |
| 623 </event> | |
| 624 | |
| 625 <!-- Version 2 additions --> | |
| 626 | |
| 627 <request name="fullscreen" since="2"> | |
| 628 <description summary="fullscreen"> | |
| 629 Request that surface is made fullscreen. | |
| 630 | |
| 631 This is only a request that the window should be made fullscreen. | |
| 632 The compositor may choose to ignore this request. The client should | |
| 633 listen to set_fullscreen events to determine if the window was | |
| 634 made fullscreen or not. | |
| 635 </description> | |
| 636 </request> | |
| 637 | |
| 638 <request name="maximize" since="2"> | |
| 639 <description summary="maximize"> | |
| 640 Request that surface is maximized. The window geometry will be updated | |
| 641 to whatever the compositor finds appropriate for a maximized window. | |
| 642 | |
| 643 This is only a request that the window should be maximized. The | |
| 644 compositor may choose to ignore this request. The client should | |
| 645 listen to set_maximized events to determine if the window was | |
| 646 maximized or not. | |
| 647 </description> | |
| 648 </request> | |
| 649 | |
| 650 <request name="minimize" since="2"> | |
| 651 <description summary="minimize"> | |
| 652 Request that surface is minimized. | |
| 653 | |
| 654 This is only a request that the window should be minimized. The | |
| 655 compositor may choose to ignore this request. The client should | |
| 656 listen to set_minimized events to determine if the window was | |
| 657 minimized or not. | |
| 658 </description> | |
| 659 </request> | |
| 660 | |
| 661 <request name="restore" since="2"> | |
| 662 <description summary="restore"> | |
| 663 Request that surface is restored. This restores the window geometry | |
| 664 to what it was before the window was minimized, maximized or made | |
| 665 fullscreen. | |
| 666 | |
| 667 This is only a request that the window should be restored. The | |
| 668 compositor may choose to ignore this request. The client should | |
| 669 listen to unset_maximized, unset_minimize and unset_fullscreen | |
| 670 events to determine if the window was restored or not. | |
| 671 </description> | |
| 672 </request> | |
| 673 | |
| 674 <event name="set_maximized" since="2"> | |
| 675 <description summary="surface wants to be maximized"> | |
| 676 The set_maximized event is sent by the compositor when the user | |
| 677 wants the surface to be maximized. | |
| 678 | |
| 679 This is only a request that the user intends to maximized the window. | |
| 680 The client may choose to ignore this request. | |
| 681 </description> | |
| 682 </event> | |
| 683 | |
| 684 <event name="unset_maximized" since="2"> | |
| 685 <description summary="surface wants to be restored"> | |
| 686 The unset_maximized event is sent by the compositor when the user | |
| 687 wants the surface to be made visible. | |
| 688 | |
| 689 This is only a request that the user intends to make your | |
| 690 window visible. The client may choose to ignore this request. | |
| 691 </description> | |
| 692 </event> | |
| 693 | |
| 694 <event name="set_minimized" since="2"> | |
| 695 <description summary="surface wants to be minimized"> | |
| 696 The set_minimized event is sent by the compositor when the user | |
| 697 wants the surface to be minimized. | |
| 698 | |
| 699 This is only a request that the user intends to minimize the window. | |
| 700 The client may choose to ignore this request. | |
| 701 </description> | |
| 702 </event> | |
| 703 | |
| 704 <event name="unset_minimized" since="2"> | |
| 705 <description summary="surface wants to be restored"> | |
| 706 The unset_minimized event is sent by the compositor when the user | |
| 707 wants the surface to be made visible. | |
| 708 | |
| 709 This is only a request that the user intends to make your | |
| 710 window visible. The client may choose to ignore this request. | |
| 711 </description> | |
| 712 </event> | |
| 713 | |
| 714 <!-- Version 3 additions --> | |
| 715 | |
| 716 <request name="pin" since="3"> | |
| 717 <description summary="pin"> | |
| 718 Request that surface is pinned. | |
| 719 | |
| 720 This is only a request that the window should be pinned. | |
| 721 The compositor may choose to ignore this request. The client should | |
| 722 listen to set_pinned events to determine if the window was | |
| 723 pinned or not. | |
| 724 </description> | |
| 725 </request> | |
| 726 | |
| 727 <request name="unpin" since="3"> | |
| 728 <description summary="unpin"> | |
| 729 Request that surface is unpinned. | |
| 730 | |
| 731 This is only a request that the window should be unpinned. | |
| 732 The compositor may choose to ignore this request. The client should | |
| 733 listen to unset_pinned events to determine if the window was | |
| 734 unpinned or not. | |
| 735 </description> | |
| 736 </request> | |
| 737 | |
| 738 <request name="unfullscreen" since="3"> | |
| 739 <description summary="unfullscreen"> | |
| 740 Request that surface is made unfullscreen. | |
| 741 | |
| 742 This is only a request that the window should be made unfullscreen. | |
| 743 The compositor may choose to ignore this request. The client should | |
| 744 listen to unset_fullscreen events to determine if the window was | |
| 745 made unfullscreen or not. | |
| 746 </description> | |
| 747 </request> | |
| 748 | |
| 749 <event name="set_pinned" since="3"> | |
| 750 <description summary="surface was pinned"> | |
| 751 The set_pinned event is sent by the compositor when the surface | |
| 752 was pinned. | |
| 753 | |
| 754 This is an event to notify that the window is pinned in compositor. | |
| 755 The pin may be triggered by a client's request, or some user action | |
| 756 directly handled by the compositor. | |
| 757 The client may choose to ignore this event. | |
| 758 </description> | |
| 759 </event> | |
| 760 | |
| 761 <event name="unset_pinned" since="3"> | |
| 762 <description summary="surface was unpinned"> | |
| 763 The unset_pinned event is sent by the compositor when the surface | |
| 764 was unpinned. | |
| 765 | |
| 766 This is an event to notify that the window is unpinned in compositor. | |
| 767 The unpin may be triggered by a client's request, or some user action | |
| 768 directly handled by the compositor. | |
| 769 The client may choose to ignore this event. | |
| 770 </description> | |
| 771 </event> | |
| 772 | |
| 773 <!-- Version 4 additions --> | |
| 774 | |
| 775 <request name="set_rectangular_shadow" since="4"> | |
| 776 <description summary="set a rectangular shadow"> | |
| 777 Request that surface needs a rectangular shadow. | |
| 778 | |
| 779 This is only a request that the surface should have a rectangular | |
| 780 shadow. The compositor may choose to ignore this request. | |
| 781 | |
| 782 The arguments are given in the output coordinate space and specifies | |
| 783 the inner bounds of the shadow. | |
| 784 | |
| 785 The arguments are given in the output coordinate space. | |
| 786 Specifying zero width and height will disable the shadow. | |
| 787 </description> | |
| 788 <arg name="x" type="int"/> | |
| 789 <arg name="y" type="int"/> | |
| 790 <arg name="width" type="int"/> | |
| 791 <arg name="height" type="int"/> | |
| 792 </request> | |
| 793 | |
| 794 <!-- Version 5 additions --> | |
| 795 | |
| 796 <request name="set_title" since="5"> | |
| 797 <description summary="set surface title"> | |
| 798 Set a short title for the surface. | |
| 799 | |
| 800 This string may be used to identify the surface in a task bar, | |
| 801 window list, or other user interface elements provided by the | |
| 802 compositor. | |
| 803 | |
| 804 The string must be encoded in UTF-8. | |
| 805 </description> | |
| 806 <arg name="title" type="string"/> | |
| 807 </request> | |
| 808 | |
| 809 <request name="set_top_inset" since="5"> | |
| 810 <description summary="set top inset for surface"> | |
| 811 Set distance from the top of the surface to the contents. | |
| 812 | |
| 813 This distance typically represents the size of the window caption. | |
| 814 </description> | |
| 815 <arg name="height" type="int"/> | |
| 816 </request> | |
| 817 | |
| 818 <!-- Version 7 additions --> | |
| 819 | |
| 820 <event name="state_type_changed" since="7"> | |
| 821 <description summary="surface state type changed"> | |
| 822 The state_type_changed event is sent by the compositor when the surface | |
| 823 state changed. | |
| 824 | |
| 825 This is an event to notify that the window state changed in compositor. | |
| 826 The state change may be triggered by a client's request, or some user | |
| 827 action directly handled by the compositor. The client may choose to | |
| 828 ignore this event. | |
| 829 </description> | |
| 830 <arg name="state_type" type="uint"/> | |
| 831 </event> | |
| 832 | |
| 833 <!-- Version 8 additions --> | |
| 834 | |
| 835 <request name="set_system_modal" since="8"> | |
| 836 <description summary="suggests a re-layout of remote shell input area"> | |
| 837 Suggests a surface should become system modal. | |
| 838 </description> | |
| 839 </request> | |
| 840 | |
| 841 <request name="unset_system_modal" since="8"> | |
| 842 <description summary="suggests a re-layout of remote shell input area"> | |
| 843 Suggests a surface should become non system modal. | |
| 844 </description> | |
| 845 </request> | |
| 846 | |
| 847 <!-- Version 9 additions --> | |
| 848 | |
| 849 <request name="set_rectangular_shadow_background_opacity" since="9"> | |
| 850 <description summary="suggests the window's background opacity"> | |
| 851 Suggests the window's background opacity when the shadow is requested. | |
| 852 </description> | |
| 853 <arg name="opacity" type="fixed"/> | |
| 854 </request> | |
| 855 | |
| 856 <!-- Version 10 additions --> | |
| 857 | |
| 858 <request name="activate" since="10"> | |
| 859 <description summary="make the surface active"> | |
| 860 Make the surface active and bring it to the front. | |
| 861 </description> | |
| 862 <arg name="serial" type="uint" summary="the serial of the user event"/> | |
| 863 </request> | |
| 864 | |
| 865 <!-- Version 11 additions --> | |
| 866 | |
| 867 <request name="pin_with_trusted_flag" since="11"> | |
| 868 <description summary="set window mode as pinned with taking a trasted flag
."> | |
| 869 Request that surface is pinned. | |
| 870 | |
| 871 This is only a request that the window should be pinned. | |
| 872 The compositor may choose to ignore this request. The client should | |
| 873 listen to set_pinned events to determine if the window was | |
| 874 pinned or not. If trusted flag is non-zero, the app can prevent users | |
| 875 from exiting the pinned mode. | |
| 876 </description> | |
| 877 <arg name="trusted" type="int" summary="whether the app can enforce users | |
| 878 to stay in the pinned mode."/> | |
| 879 </request> | |
| 880 </interface> | |
| 881 | |
| 882 <!-- Version 6 additions --> | |
| 883 | |
| 884 <interface name="zwp_notification_surface_v1" version="6"> | |
| 885 <description summary="DEPRECATED"> | |
| 886 An interface that may be implemented by a wl_surface to host | |
| 887 notification contents. | |
| 888 </description> | |
| 889 | |
| 890 <request name="destroy" type="destructor"> | |
| 891 <description summary="Destroy the notification_surface"> | |
| 892 Unmap and destroy the notification surface. | |
| 893 </description> | |
| 894 </request> | |
| 895 </interface> | |
| 896 | |
| 897 </protocol> | 397 </protocol> |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 2352563002:
third_party: Remove deprecated zwp wayland interfaces. (Closed)
