0<?xml version="1.0" encoding="UTF-8"?>
1<protocol name="xdg_activation_v1">
3 <copyright>
4 Copyright © 2020 Aleix Pol Gonzalez <aleixpol@kde.org>
5 Copyright © 2020 Carlos Garnacho <carlosg@gnome.org>
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:
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.
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>
27 <description summary="Protocol for requesting activation of surfaces">
28 The way for a client to pass focus to another toplevel is as follows.
30 The client that intends to activate another toplevel uses the
31 xdg_activation_v1.get_activation_token request to get an activation token.
32 This token is then forwarded to the client, which is supposed to activate
33 one of its surfaces, through a separate band of communication.
35 One established way of doing this is through the XDG_ACTIVATION_TOKEN
36 environment variable of a newly launched child process. The child process
37 should unset the environment variable again right after reading it out in
38 order to avoid propagating it to other child processes.
40 Another established way exists for Applications implementing the D-Bus
41 interface org.freedesktop.Application, which should get their token under
42 activation-token on their platform_data.
44 In general activation tokens may be transferred across clients through
45 means not described in this protocol.
47 The client to be activated will then pass the token
48 it received to the xdg_activation_v1.activate request. The compositor can
49 then use this token to decide how to react to the activation request.
51 The token the activating client gets may be ineffective either already at
52 the time it receives it, for example if it was not focused, for focus
53 stealing prevention. The activating client will have no way to discover
54 the validity of the token, and may still forward it to the to be activated
55 client.
57 The created activation token may optionally get information attached to it
58 that can be used by the compositor to identify the application that we
59 intend to activate. This can for example be used to display a visual hint
60 about what application is being started.
62 Warning! The protocol described in this file is currently in the testing
63 phase. Backward compatible changes may be added together with the
64 corresponding interface version bump. Backward incompatible changes can
65 only be done by creating a new major version of the extension.
66 </description>
68 <interface name="xdg_activation_v1" version="1">
69 <description summary="interface for activating surfaces">
70 A global interface used for informing the compositor about applications
71 being activated or started, or for applications to request to be
72 activated.
73 </description>
75 <request name="destroy" type="destructor">
76 <description summary="destroy the xdg_activation object">
77 Notify the compositor that the xdg_activation object will no longer be
78 used.
80 The child objects created via this interface are unaffected and should
81 be destroyed separately.
82 </description>
83 </request>
85 <request name="get_activation_token">
86 <description summary="requests a token">
87 Creates an xdg_activation_token_v1 object that will provide
88 the initiating client with a unique token for this activation. This
89 token should be offered to the clients to be activated.
90 </description>
92 <arg name="id" type="new_id" interface="xdg_activation_token_v1"/>
93 </request>
95 <request name="activate">
96 <description summary="notify new interaction being available">
97 Requests surface activation. It's up to the compositor to display
98 this information as desired, for example by placing the surface above
99 the rest.
101 The compositor may know who requested this by checking the activation
102 token and might decide not to follow through with the activation if it's
103 considered unwanted.
105 Compositors can ignore unknown activation tokens when an invalid
106 token is passed.
107 </description>
108 <arg name="token" type="string" summary="the activation token of the initiating client"/>
109 <arg name="surface" type="object" interface="wl_surface"
110 summary="the wl_surface to activate"/>
111 </request>
112 </interface>
114 <interface name="xdg_activation_token_v1" version="1">
115 <description summary="an exported activation handle">
116 An object for setting up a token and receiving a token handle that can
117 be passed as an activation token to another client.
119 The object is created using the xdg_activation_v1.get_activation_token
120 request. This object should then be populated with the app_id, surface
121 and serial information and committed. The compositor shall then issue a
122 done event with the token. In case the request's parameters are invalid,
123 the compositor will provide an invalid token.
124 </description>
126 <enum name="error">
127 <entry name="already_used" value="0"
128 summary="The token has already been used previously"/>
129 </enum>
131 <request name="set_serial">
132 <description summary="specifies the seat and serial of the activating event">
133 Provides information about the seat and serial event that requested the
134 token.
136 The serial can come from an input or focus event. For instance, if a
137 click triggers the launch of a third-party client, the launcher client
138 should send a set_serial request with the serial and seat from the
139 wl_pointer.button event.
141 Some compositors might refuse to activate toplevels when the token
142 doesn't have a valid and recent enough event serial.
144 Must be sent before commit. This information is optional.
145 </description>
146 <arg name="serial" type="uint"
147 summary="the serial of the event that triggered the activation"/>
148 <arg name="seat" type="object" interface="wl_seat"
149 summary="the wl_seat of the event"/>
150 </request>
152 <request name="set_app_id">
153 <description summary="specifies the application being activated">
154 The requesting client can specify an app_id to associate the token
155 being created with it.
157 Must be sent before commit. This information is optional.
158 </description>
159 <arg name="app_id" type="string"
160 summary="the application id of the client being activated."/>
161 </request>
163 <request name="set_surface">
164 <description summary="specifies the surface requesting activation">
165 This request sets the surface requesting the activation. Note, this is
166 different from the surface that will be activated.
168 Some compositors might refuse to activate toplevels when the token
169 doesn't have a requesting surface.
171 Must be sent before commit. This information is optional.
172 </description>
173 <arg name="surface" type="object" interface="wl_surface"
174 summary="the requesting surface"/>
175 </request>
177 <request name="commit">
178 <description summary="issues the token request">
179 Requests an activation token based on the different parameters that
180 have been offered through set_serial, set_surface and set_app_id.
181 </description>
182 </request>
184 <event name="done">
185 <description summary="the exported activation token">
186 The 'done' event contains the unique token of this activation request
187 and notifies that the provider is done.
188 </description>
189 <arg name="token" type="string" summary="the exported activation token"/>
190 </event>
192 <request name="destroy" type="destructor">
193 <description summary="destroy the xdg_activation_token_v1 object">
194 Notify the compositor that the xdg_activation_token_v1 object will no
195 longer be used. The received token stays valid.
196 </description>
197 </request>
198 </interface>
199</protocol>
index : raylib-jai
---