|
| 1 | +<?xml version="1.0" encoding="UTF-8"?> |
| 2 | +<protocol name="pantheon_shell_v1"> |
| 3 | + <copyright><![CDATA[ |
| 4 | + SPDX-FileCopyrightText: 2023 Corentin Noël <[email protected]> |
| 5 | +
|
| 6 | + SPDX-License-Identifier: LGPL-2.1-or-later |
| 7 | + ]]></copyright> |
| 8 | + |
| 9 | + <interface name="io_elementary_pantheon_shell_v1" version="1"> |
| 10 | + <description summary="create panel, widget and get more control"> |
| 11 | + This interface is used by the Pantheon Wayland shell to communicate with |
| 12 | + the compositor. |
| 13 | + </description> |
| 14 | + |
| 15 | + <request name="get_panel"> |
| 16 | + <description summary="create a panel surface from a surface"> |
| 17 | + Create a panel surface from an existing surface. |
| 18 | + </description> |
| 19 | + <arg name="output" type="new_id" interface="io_elementary_pantheon_panel_v1"/> |
| 20 | + <arg name="surface" type="object" interface="wl_surface"/> |
| 21 | + </request> |
| 22 | + |
| 23 | + <request name="get_widget"> |
| 24 | + <description summary="create a widget surface from a surface"> |
| 25 | + Create a desktop widget surface from an existing surface. |
| 26 | + </description> |
| 27 | + <arg name="output" type="new_id" interface="io_elementary_pantheon_widget_v1"/> |
| 28 | + <arg name="surface" type="object" interface="wl_surface"/> |
| 29 | + </request> |
| 30 | + |
| 31 | + <request name="get_extended_behavior"> |
| 32 | + <description summary="create a desktop-specific surface from a surface"> |
| 33 | + Create a desktop-specific surface from an existing surface. |
| 34 | + </description> |
| 35 | + <arg name="output" type="new_id" interface="io_elementary_pantheon_extended_behavior_v1"/> |
| 36 | + <arg name="surface" type="object" interface="wl_surface"/> |
| 37 | + </request> |
| 38 | + </interface> |
| 39 | + |
| 40 | + <interface name="io_elementary_pantheon_panel_v1" version="1"> |
| 41 | + <request name="destroy" type="destructor"/> |
| 42 | + |
| 43 | + <enum name="anchor"> |
| 44 | + <description summary="anchor"> |
| 45 | + The anchor is a placement hint to the compositor. |
| 46 | + </description> |
| 47 | + <entry name="top" value="0" summary="the top edge of the screen"/> |
| 48 | + <entry name="bottom" value="1" summary="the bottom edge of the screen"/> |
| 49 | + <entry name="left" value="2" summary="the left edge of the screen"/> |
| 50 | + <entry name="right" value="3" summary="the right edge of the screen"/> |
| 51 | + </enum> |
| 52 | + |
| 53 | + <enum name="hide_mode"> |
| 54 | + <description summary="hide mode"> |
| 55 | + How the shell should handle the window. |
| 56 | + </description> |
| 57 | + <entry name="never" value="0" summary="make the surface exclusive"/> |
| 58 | + <entry name="maximized_focus_window" value="1" summary="hide when the focused window is maximized"/> |
| 59 | + <entry name="overlapping_focus_window" value="2" summary="hide when the focused window overlaps the surface"/> |
| 60 | + <entry name="overlapping_window" value="3" summary="hide when any window overlaps the surface"/> |
| 61 | + <entry name="always" value="4" summary="always hide and only show if requested by the user"/> |
| 62 | + </enum> |
| 63 | + |
| 64 | + <request name="set_anchor"> |
| 65 | + <description summary="set panel edge anchor"> |
| 66 | + Tell the shell which side of the screen the panel is |
| 67 | + located. This is so that new windows do not overlap the panel |
| 68 | + and maximized windows maximize properly. |
| 69 | + </description> |
| 70 | + |
| 71 | + <arg name="anchor" type="uint" enum="anchor" summary="anchor"/> |
| 72 | + </request> |
| 73 | + |
| 74 | + <request name="focus"> |
| 75 | + <description summary="request keyboard focus"> |
| 76 | + Request keyboard focus, taking it away from any other window. |
| 77 | + Keyboard focus must always be manually be requested and is |
| 78 | + - in contrast to normal windows - never automatically granted |
| 79 | + by the compositor. |
| 80 | + </description> |
| 81 | + </request> |
| 82 | + |
| 83 | + <request name="set_size"> |
| 84 | + <description summary="set size"> |
| 85 | + The given size is only used for exclusive zones and |
| 86 | + collision tracking for auto hide. By default and if set |
| 87 | + to -1 the size of the surface is used. |
| 88 | + </description> |
| 89 | + |
| 90 | + <arg name="width" type="int"/> |
| 91 | + <arg name="height" type="int"/> |
| 92 | + </request> |
| 93 | + |
| 94 | + <request name="set_hide_mode"> |
| 95 | + <description summary="set panel hide mode"> |
| 96 | + Tell the shell when to hide the panel. |
| 97 | + </description> |
| 98 | + |
| 99 | + <arg name="hide_mode" type="uint" enum="hide_mode" summary="hide mode"/> |
| 100 | + </request> |
| 101 | + |
| 102 | + <request name="request_visible_in_multitasking_view"> |
| 103 | + <description summary="request visible in multitasking view"> |
| 104 | + Tell the shell that the panel would like to be visible in the multitasking view. |
| 105 | + </description> |
| 106 | + </request> |
| 107 | + |
| 108 | + <request name="add_blur"> |
| 109 | + <description summary="add blur"> |
| 110 | + Tell the window manager to add background blur. |
| 111 | + </description> |
| 112 | + |
| 113 | + <arg name="left" type="uint"/> |
| 114 | + <arg name="right" type="uint"/> |
| 115 | + <arg name="top" type="uint"/> |
| 116 | + <arg name="bottom" type="uint"/> |
| 117 | + <arg name="clip_radius" type="uint"/> |
| 118 | + </request> |
| 119 | + |
| 120 | + <request name="remove_blur"> |
| 121 | + <description summary="remove blur"> |
| 122 | + Tell the window manager to remove blur that was set in set_blur_region. |
| 123 | + </description> |
| 124 | + </request> |
| 125 | + </interface> |
| 126 | + |
| 127 | + <interface name="io_elementary_pantheon_widget_v1" version="1"> |
| 128 | + <request name="destroy" type="destructor"/> |
| 129 | + </interface> |
| 130 | + |
| 131 | + <interface name="io_elementary_pantheon_extended_behavior_v1" version="1"> |
| 132 | + <request name="destroy" type="destructor"/> |
| 133 | + <request name="set_keep_above"> |
| 134 | + <description summary="set keep above"> |
| 135 | + Tell the shell to keep the surface above on all workspaces |
| 136 | + </description> |
| 137 | + </request> |
| 138 | + |
| 139 | + <request name="make_centered"> |
| 140 | + <description summary="requests to keep the surface centered"> |
| 141 | + Request to keep the surface centered. This will cause keyboard focus |
| 142 | + to not be granted automatically but having to be requested via focus. |
| 143 | + </description> |
| 144 | + </request> |
| 145 | + |
| 146 | + <request name="focus"> |
| 147 | + <description summary="request keyboard focus"> |
| 148 | + Request keyboard focus, taking it away from any other window. |
| 149 | + Keyboard focus must always be manually be requested and is |
| 150 | + - in contrast to normal windows - never automatically granted |
| 151 | + by the compositor. |
| 152 | + </description> |
| 153 | + </request> |
| 154 | + </interface> |
| 155 | +</protocol> |
0 commit comments