1<?xml version="1.0" encoding="UTF-8"?>
2<protocol name="xdg_shell">
3
4 <copyright>
5 Copyright © 2008-2013 Kristian Høgsberg
6 Copyright © 2013 Rafael Antognolli
7 Copyright © 2013 Jasper St. Pierre
8 Copyright © 2010-2013 Intel Corporation
9 Copyright © 2015-2017 Samsung Electronics Co., Ltd
10 Copyright © 2015-2017 Red Hat Inc.
11
12 Permission is hereby granted, free of charge, to any person obtaining a
13 copy of this software and associated documentation files (the "Software"),
14 to deal in the Software without restriction, including without limitation
15 the rights to use, copy, modify, merge, publish, distribute, sublicense,
16 and/or sell copies of the Software, and to permit persons to whom the
17 Software is furnished to do so, subject to the following conditions:
18
19 The above copyright notice and this permission notice (including the next
20 paragraph) shall be included in all copies or substantial portions of the
21 Software.
22
23 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
26 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
28 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
29 DEALINGS IN THE SOFTWARE.
30 </copyright>
31
32 <interface name="xdg_wm_base" version="7">
33 <description summary="create desktop-style surfaces">
34 The xdg_wm_base interface is exposed as a global object enabling clients
35 to turn their wl_surfaces into windows in a desktop environment. It
36 defines the basic functionality needed for clients and the compositor to
37 create windows that can be dragged, resized, maximized, etc, as well as
38 creating transient windows such as popup menus.
39 </description>
40
41 <enum name="error">
42 <entry name="role" value="0" summary="given wl_surface has another role"/>
43 <entry name="defunct_surfaces" value="1"
44 summary="xdg_wm_base was destroyed before children"/>
45 <entry name="not_the_topmost_popup" value="2"
46 summary="the client tried to map or destroy a non-topmost popup"/>
47 <entry name="invalid_popup_parent" value="3"
48 summary="the client specified an invalid popup parent surface"/>
49 <entry name="invalid_surface_state" value="4"
50 summary="the client provided an invalid surface state"/>
51 <entry name="invalid_positioner" value="5"
52 summary="the client provided an invalid positioner"/>
53 <entry name="unresponsive" value="6"
54 summary="the client didn’t respond to a ping event in time"/>
55 </enum>
56
57 <request name="destroy" type="destructor">
58 <description summary="destroy xdg_wm_base">
59 Destroy this xdg_wm_base object.
60
61 Destroying a bound xdg_wm_base object while there are surfaces
62 still alive created by this xdg_wm_base object instance is illegal
63 and will result in a defunct_surfaces error.
64 </description>
65 </request>
66
67 <request name="create_positioner">
68 <description summary="create a positioner object">
69 Create a positioner object. A positioner object is used to position
70 surfaces relative to some parent surface. See the interface description
71 and xdg_surface.get_popup for details.
72 </description>
73 <arg name="id" type="new_id" interface="xdg_positioner"/>
74 </request>
75
76 <request name="get_xdg_surface">
77 <description summary="create a shell surface from a surface">
78 This creates an xdg_surface for the given surface. An xdg_surface is
79 used as basis to define a role to a given surface, such as xdg_toplevel
80 or xdg_popup. It also manages functionality shared between xdg_surface
81 based surface roles.
82
83 While xdg_surface itself is not a role, the corresponding surface may
84 only be assigned a role extending xdg_surface, such as xdg_toplevel or
85 xdg_popup. It is illegal to create an xdg_surface for a wl_surface which
86 already has anassigned role and this will result in a role error.
87
88 See the documentation of xdg_surface for more details about what an
89 xdg_surface is and how it is used.
90 </description>
91 <arg name="id" type="new_id" interface="xdg_surface"/>
92 <arg name="surface" type="object" interface="wl_surface"/>
93 </request>
94
95 <request name="pong">
96 <description summary="respond to a ping event">
97 A client must respond to a ping event with a pong request or
98 the client may be deemed unresponsive. See xdg_wm_base.ping
99 and xdg_wm_base.error.unresponsive.
100 </description>
101 <arg name="serial" type="uint" summary="serial of the ping event"/>
102 </request>
103
104 <event name="ping">
105 <description summary="check if the client is alive">
106 The ping event asks the client if it's still alive. Pass the
107 serial specified in the event back to the compositor by sending
108 a "pong" request back with the specified serial. See xdg_wm_base.pong.
109
110 Compositors can use this to determine if the client is still
111 alive. It's unspecified what will happen if the client doesn't
112 respond to the ping request, or in what timeframe. Clients should
113 try to respond in a reasonable amount of time. The “unresponsive”
114 error is provided for compositors that wish to disconnect unresponsive
115 clients.
116
117 A compositor is free to ping in any way it wants, but a client must
118 always respond to any xdg_wm_base object it created.
119 </description>
120 <arg name="serial" type="uint" summary="pass this to the pong request"/>
121 </event>
122 </interface>
123
124 <interface name="xdg_positioner" version="7">
125 <description summary="child surface positioner">
126 The xdg_positioner provides a collection of rules for the placement of a
127 child surface relative to a parent surface. Rules can be defined to ensure
128 the child surface remains within the visible area's borders, and to
129 specify how the child surface changes its position, such as sliding along
130 an axis, or flipping around a rectangle. These positioner-created rules are
131 constrained by the requirement that a child surface must intersect with or
132 be at least partially adjacent to its parent surface.
133
134 See the various requests for details about possible rules.
135
136 At the time of the request, the compositor makes a copy of the rules
137 specified by the xdg_positioner. Thus, after the request is complete the
138 xdg_positioner object can be destroyed or reused; further changes to the
139 object will have no effect on previous usages.
140
141 For an xdg_positioner object to be considered complete, it must have a
142 non-zero size set by set_size, and a non-zero anchor rectangle set by
143 set_anchor_rect. Passing an incomplete xdg_positioner object when
144 positioning a surface raises an invalid_positioner error.
145 </description>
146
147 <enum name="error">
148 <entry name="invalid_input" value="0" summary="invalid input provided"/>
149 </enum>
150
151 <request name="destroy" type="destructor">
152 <description summary="destroy the xdg_positioner object">
153 Notify the compositor that the xdg_positioner will no longer be used.
154 </description>
155 </request>
156
157 <request name="set_size">
158 <description summary="set the size of the to-be positioned rectangle">
159 Set the size of the surface that is to be positioned with the positioner
160 object. The size is in surface-local coordinates and corresponds to the
161 window geometry. See xdg_surface.set_window_geometry.
162
163 If a zero or negative size is set the invalid_input error is raised.
164 </description>
165 <arg name="width" type="int" summary="width of positioned rectangle"/>
166 <arg name="height" type="int" summary="height of positioned rectangle"/>
167 </request>
168
169 <request name="set_anchor_rect">
170 <description summary="set the anchor rectangle within the parent surface">
171 Specify the anchor rectangle within the parent surface that the child
172 surface will be placed relative to. The rectangle is relative to the
173 window geometry as defined by xdg_surface.set_window_geometry of the
174 parent surface.
175
176 When the xdg_positioner object is used to position a child surface, the
177 anchor rectangle may not extend outside the window geometry of the
178 positioned child's parent surface.
179
180 If a negative size is set the invalid_input error is raised.
181 </description>
182 <arg name="x" type="int" summary="x position of anchor rectangle"/>
183 <arg name="y" type="int" summary="y position of anchor rectangle"/>
184 <arg name="width" type="int" summary="width of anchor rectangle"/>
185 <arg name="height" type="int" summary="height of anchor rectangle"/>
186 </request>
187
188 <enum name="anchor">
189 <entry name="none" value="0"/>
190 <entry name="top" value="1"/>
191 <entry name="bottom" value="2"/>
192 <entry name="left" value="3"/>
193 <entry name="right" value="4"/>
194 <entry name="top_left" value="5"/>
195 <entry name="bottom_left" value="6"/>
196 <entry name="top_right" value="7"/>
197 <entry name="bottom_right" value="8"/>
198 </enum>
199
200 <request name="set_anchor">
201 <description summary="set anchor rectangle anchor">
202 Defines the anchor point for the anchor rectangle. The specified anchor
203 is used to derive an anchor point that the child surface will be
204 positioned relative to. If a corner anchor is set (e.g. 'top_left' or
205 'bottom_right'), the anchor point will be at the specified corner;
206 otherwise, the derived anchor point will be centered on the specified
207 edge, or in the center of the anchor rectangle if no edge is specified.
208 </description>
209 <arg name="anchor" type="uint" enum="anchor"
210 summary="anchor point"/>
211 </request>
212
213 <enum name="gravity">
214 <entry name="none" value="0"/>
215 <entry name="top" value="1"/>
216 <entry name="bottom" value="2"/>
217 <entry name="left" value="3"/>
218 <entry name="right" value="4"/>
219 <entry name="top_left" value="5"/>
220 <entry name="bottom_left" value="6"/>
221 <entry name="top_right" value="7"/>
222 <entry name="bottom_right" value="8"/>
223 </enum>
224
225 <request name="set_gravity">
226 <description summary="set child surface gravity">
227 Defines in what direction a surface should be positioned, relative to
228 the anchor point of the parent surface. If a corner gravity is
229 specified (e.g. 'bottom_right' or 'top_left'), then the child surface
230 will be placed towards the specified gravity; otherwise, the child
231 surface will be centered over the anchor point on any axis that had no
232 gravity specified. If the gravity is not in the ‘gravity’ enum, an
233 invalid_input error is raised.
234 </description>
235 <arg name="gravity" type="uint" enum="gravity"
236 summary="gravity direction"/>
237 </request>
238
239 <enum name="constraint_adjustment" bitfield="true">
240 <description summary="constraint adjustments">
241 The constraint adjustment value define ways the compositor will adjust
242 the position of the surface, if the unadjusted position would result
243 in the surface being partly constrained.
244
245 Whether a surface is considered 'constrained' is left to the compositor
246 to determine. For example, the surface may be partly outside the
247 compositor's defined 'work area', thus necessitating the child surface's
248 position be adjusted until it is entirely inside the work area.
249
250 The adjustments can be combined, according to a defined precedence: 1)
251 Flip, 2) Slide, 3) Resize.
252 </description>
253 <entry name="none" value="0">
254 <description summary="don't move the child surface when constrained">
255 Don't alter the surface position even if it is constrained on some
256 axis, for example partially outside the edge of an output.
257 </description>
258 </entry>
259 <entry name="slide_x" value="1">
260 <description summary="move along the x axis until unconstrained">
261 Slide the surface along the x axis until it is no longer constrained.
262
263 First try to slide towards the direction of the gravity on the x axis
264 until either the edge in the opposite direction of the gravity is
265 unconstrained or the edge in the direction of the gravity is
266 constrained.
267
268 Then try to slide towards the opposite direction of the gravity on the
269 x axis until either the edge in the direction of the gravity is
270 unconstrained or the edge in the opposite direction of the gravity is
271 constrained.
272 </description>
273 </entry>
274 <entry name="slide_y" value="2">
275 <description summary="move along the y axis until unconstrained">
276 Slide the surface along the y axis until it is no longer constrained.
277
278 First try to slide towards the direction of the gravity on the y axis
279 until either the edge in the opposite direction of the gravity is
280 unconstrained or the edge in the direction of the gravity is
281 constrained.
282
283 Then try to slide towards the opposite direction of the gravity on the
284 y axis until either the edge in the direction of the gravity is
285 unconstrained or the edge in the opposite direction of the gravity is
286 constrained.
287 </description>
288 </entry>
289 <entry name="flip_x" value="4">
290 <description summary="invert the anchor and gravity on the x axis">
291 Invert the anchor and gravity on the x axis if the surface is
292 constrained on the x axis. For example, if the left edge of the
293 surface is constrained, the gravity is 'left' and the anchor is
294 'left', change the gravity to 'right' and the anchor to 'right'.
295
296 If the adjusted position also ends up being constrained, the resulting
297 position of the flip_x adjustment will be the one before the
298 adjustment.
299 </description>
300 </entry>
301 <entry name="flip_y" value="8">
302 <description summary="invert the anchor and gravity on the y axis">
303 Invert the anchor and gravity on the y axis if the surface is
304 constrained on the y axis. For example, if the bottom edge of the
305 surface is constrained, the gravity is 'bottom' and the anchor is
306 'bottom', change the gravity to 'top' and the anchor to 'top'.
307
308 The adjusted position is calculated given the original anchor
309 rectangle and offset, but with the new flipped anchor and gravity
310 values.
311
312 If the adjusted position also ends up being constrained, the resulting
313 position of the flip_y adjustment will be the one before the
314 adjustment.
315 </description>
316 </entry>
317 <entry name="resize_x" value="16">
318 <description summary="horizontally resize the surface">
319 Resize the surface horizontally so that it is completely
320 unconstrained.
321 </description>
322 </entry>
323 <entry name="resize_y" value="32">
324 <description summary="vertically resize the surface">
325 Resize the surface vertically so that it is completely unconstrained.
326 </description>
327 </entry>
328 </enum>
329
330 <request name="set_constraint_adjustment">
331 <description summary="set the adjustment to be done when constrained">
332 Specify how the window should be positioned if the originally intended
333 position caused the surface to be constrained, meaning at least
334 partially outside positioning boundaries set by the compositor. The
335 adjustment is set by constructing a bitmask describing the adjustment to
336 be made when the surface is constrained on that axis.
337
338 If no bit for one axis is set, the compositor will assume that the child
339 surface should not change its position on that axis when constrained.
340
341 If more than one bit for one axis is set, the order of how adjustments
342 are applied is specified in the corresponding adjustment descriptions.
343
344 The default adjustment is none.
345 </description>
346 <arg name="constraint_adjustment" type="uint" enum="constraint_adjustment"
347 summary="bit mask of constraint adjustments"/>
348 </request>
349
350 <request name="set_offset">
351 <description summary="set surface position offset">
352 Specify the surface position offset relative to the position of the
353 anchor on the anchor rectangle and the anchor on the surface. For
354 example if the anchor of the anchor rectangle is at (x, y), the surface
355 has the gravity bottom|right, and the offset is (ox, oy), the calculated
356 surface position will be (x + ox, y + oy). The offset position of the
357 surface is the one used for constraint testing. See
358 set_constraint_adjustment.
359
360 An example use case is placing a popup menu on top of a user interface
361 element, while aligning the user interface element of the parent surface
362 with some user interface element placed somewhere in the popup surface.
363 </description>
364 <arg name="x" type="int" summary="surface position x offset"/>
365 <arg name="y" type="int" summary="surface position y offset"/>
366 </request>
367
368 <!-- Version 3 additions -->
369
370 <request name="set_reactive" since="3">
371 <description summary="continuously reconstrain the surface">
372 When set reactive, the surface is reconstrained if the conditions used
373 for constraining changed, e.g. the parent window moved.
374
375 If the conditions changed and the popup was reconstrained, an
376 xdg_popup.configure event is sent with updated geometry, followed by an
377 xdg_surface.configure event.
378 </description>
379 </request>
380
381 <request name="set_parent_size" since="3">
382 <description summary="set parent size">
383 Set the parent window geometry the compositor should use when
384 positioning the popup. The compositor may use this information to
385 determine the future state the popup should be constrained using. If
386 this doesn't match the dimension of the parent the popup is eventually
387 positioned against, the behavior is undefined.
388
389 The arguments are given in the surface-local coordinate space.
390 </description>
391 <arg name="parent_width" type="int"
392 summary="future window geometry width of parent"/>
393 <arg name="parent_height" type="int"
394 summary="future window geometry height of parent"/>
395 </request>
396
397 <request name="set_parent_configure" since="3">
398 <description summary="set parent configure this is a response to">
399 Set the serial of an xdg_surface.configure event this positioner will be
400 used in response to. The compositor may use this information together
401 with set_parent_size to determine what future state the popup should be
402 constrained using.
403 </description>
404 <arg name="serial" type="uint"
405 summary="serial of parent configure event"/>
406 </request>
407 </interface>
408
409 <interface name="xdg_surface" version="7">
410 <description summary="desktop user interface surface base interface">
411 An interface that may be implemented by a wl_surface, for
412 implementations that provide a desktop-style user interface.
413
414 It provides a base set of functionality required to construct user
415 interface elements requiring management by the compositor, such as
416 toplevel windows, menus, etc. The types of functionality are split into
417 xdg_surface roles.
418
419 Creating an xdg_surface does not set the role for a wl_surface. In order
420 to map an xdg_surface, the client must create a role-specific object
421 using, e.g., get_toplevel, get_popup. The wl_surface for any given
422 xdg_surface can have at most one role, and may not be assigned any role
423 not based on xdg_surface.
424
425 A role must be assigned before any other requests are made to the
426 xdg_surface object.
427
428 The client must call wl_surface.commit on the corresponding wl_surface
429 for the xdg_surface state to take effect.
430
431 Creating an xdg_surface from a wl_surface which has a buffer attached or
432 committed is a client error, and any attempts by a client to attach or
433 manipulate a buffer prior to the first xdg_surface.configure call must
434 also be treated as errors.
435
436 After creating a role-specific object and setting it up (e.g. by sending
437 the title, app ID, size constraints, parent, etc), the client must
438 perform an initial commit without any buffer attached. The compositor
439 will reply with initial wl_surface state such as
440 wl_surface.preferred_buffer_scale followed by an xdg_surface.configure
441 event. The client must acknowledge it and is then allowed to attach a
442 buffer to map the surface.
443
444 Mapping an xdg_surface-based role surface is defined as making it
445 possible for the surface to be shown by the compositor. Note that
446 a mapped surface is not guaranteed to be visible once it is mapped.
447
448 For an xdg_surface to be mapped by the compositor, the following
449 conditions must be met:
450 (1) the client has assigned an xdg_surface-based role to the surface
451 (2) the client has set and committed the xdg_surface state and the
452 role-dependent state to the surface
453 (3) the client has committed a buffer to the surface
454
455 A newly-unmapped surface is considered to have met condition (1) out
456 of the 3 required conditions for mapping a surface if its role surface
457 has not been destroyed, i.e. the client must perform the initial commit
458 again before attaching a buffer.
459 </description>
460
461 <enum name="error">
462 <entry name="not_constructed" value="1"
463 summary="Surface was not fully constructed"/>
464 <entry name="already_constructed" value="2"
465 summary="Surface was already constructed"/>
466 <entry name="unconfigured_buffer" value="3"
467 summary="Attaching a buffer to an unconfigured surface"/>
468 <entry name="invalid_serial" value="4"
469 summary="Invalid serial number when acking a configure event"/>
470 <entry name="invalid_size" value="5"
471 summary="Width or height was zero or negative"/>
472 <entry name="defunct_role_object" value="6"
473 summary="Surface was destroyed before its role object"/>
474 </enum>
475
476 <request name="destroy" type="destructor">
477 <description summary="destroy the xdg_surface">
478 Destroy the xdg_surface object. An xdg_surface must only be destroyed
479 after its role object has been destroyed, otherwise
480 a defunct_role_object error is raised.
481 </description>
482 </request>
483
484 <request name="get_toplevel">
485 <description summary="assign the xdg_toplevel surface role">
486 This creates an xdg_toplevel object for the given xdg_surface and gives
487 the associated wl_surface the xdg_toplevel role.
488
489 See the documentation of xdg_toplevel for more details about what an
490 xdg_toplevel is and how it is used.
491 </description>
492 <arg name="id" type="new_id" interface="xdg_toplevel"/>
493 </request>
494
495 <request name="get_popup">
496 <description summary="assign the xdg_popup surface role">
497 This creates an xdg_popup object for the given xdg_surface and gives
498 the associated wl_surface the xdg_popup role.
499
500 If null is passed as a parent, a parent surface must be specified using
501 some other protocol, before committing the initial state.
502
503 See the documentation of xdg_popup for more details about what an
504 xdg_popup is and how it is used.
505 </description>
506 <arg name="id" type="new_id" interface="xdg_popup"/>
507 <arg name="parent" type="object" interface="xdg_surface" allow-null="true" summary="parent surface for this popup"/>
508 <arg name="positioner" type="object" interface="xdg_positioner" summary="positioner for this popup"/>
509 </request>
510
511 <request name="set_window_geometry">
512 <description summary="set the new window geometry">
513 The window geometry of a surface is its "visible bounds" from the
514 user's perspective. Client-side decorations often have invisible
515 portions like drop-shadows which should be ignored for the
516 purposes of aligning, placing and constraining windows. Note that
517 in some situations, compositors may clip rendering to the window
518 geometry, so the client should avoid putting functional elements
519 outside of it.
520
521 The window geometry is double-buffered state, see wl_surface.commit.
522
523 When maintaining a position, the compositor should treat the (x, y)
524 coordinate of the window geometry as the top left corner of the window.
525 A client changing the (x, y) window geometry coordinate should in
526 general not alter the position of the window.
527
528 Once the window geometry of the surface is set, it is not possible to
529 unset it, and it will remain the same until set_window_geometry is
530 called again, even if a new subsurface or buffer is attached.
531
532 If never set, the value is the full bounds of the surface,
533 including any subsurfaces. This updates dynamically on every
534 commit. This unset is meant for extremely simple clients.
535
536 The arguments are given in the surface-local coordinate space of
537 the wl_surface associated with this xdg_surface, and may extend outside
538 of the wl_surface itself to mark parts of the subsurface tree as part of
539 the window geometry.
540
541 When applied, the effective window geometry will be the set window
542 geometry clamped to the bounding rectangle of the combined
543 geometry of the surface of the xdg_surface and the associated
544 subsurfaces.
545
546 The effective geometry will not be recalculated unless a new call to
547 set_window_geometry is done and the new pending surface state is
548 subsequently applied.
549
550 The width and height of the effective window geometry must be
551 greater than zero. Setting an invalid size will raise an
552 invalid_size error.
553 </description>
554 <arg name="x" type="int" summary="x coordinate of the top-left corner of the window inside this surface"/>
555 <arg name="y" type="int" summary="y coordinate of the top-left corner of the window inside this surface"/>
556 <arg name="width" type="int" summary="width of the window"/>
557 <arg name="height" type="int" summary="height of the window"/>
558 </request>
559
560 <request name="ack_configure">
561 <description summary="ack a configure event">
562 When a configure event is received, if a client commits the
563 surface in response to the configure event, then the client
564 must make an ack_configure request sometime before the commit
565 request, passing along the serial of the configure event.
566
567 For instance, for toplevel surfaces the compositor might use this
568 information to move a surface to the top left only when the client has
569 drawn itself for the maximized or fullscreen state.
570
571 If the client receives multiple configure events before it
572 can respond to one, it only has to ack the last configure event.
573 Acking a configure event that was never sent raises an invalid_serial
574 error.
575
576 A client is not required to commit immediately after sending
577 an ack_configure request - it may even ack_configure several times
578 before its next surface commit.
579
580 A client may send multiple ack_configure requests before committing, but
581 only the last request sent before a commit indicates which configure
582 event the client really is responding to.
583
584 Sending an ack_configure request consumes the serial number sent with
585 the request, as well as serial numbers sent by all configure events
586 sent on this xdg_surface prior to the configure event referenced by
587 the committed serial.
588
589 It is an error to issue multiple ack_configure requests referencing a
590 serial from the same configure event, or to issue an ack_configure
591 request referencing a serial from a configure event issued before the
592 event identified by the last ack_configure request for the same
593 xdg_surface. Doing so will raise an invalid_serial error.
594 </description>
595 <arg name="serial" type="uint" summary="the serial from the configure event"/>
596 </request>
597
598 <event name="configure">
599 <description summary="suggest a surface change">
600 The configure event marks the end of a configure sequence. A configure
601 sequence is a set of one or more events configuring the state of the
602 xdg_surface, including the final xdg_surface.configure event.
603
604 Where applicable, xdg_surface surface roles will during a configure
605 sequence extend this event as a latched state sent as events before the
606 xdg_surface.configure event. Such events should be considered to make up
607 a set of atomically applied configuration states, where the
608 xdg_surface.configure commits the accumulated state.
609
610 Clients should arrange their surface for the new states, and then send
611 an ack_configure request with the serial sent in this configure event at
612 some point before committing the new surface.
613
614 If the client receives multiple configure events before it can respond
615 to one, it is free to discard all but the last event it received.
616 </description>
617 <arg name="serial" type="uint" summary="serial of the configure event"/>
618 </event>
619
620 </interface>
621
622 <interface name="xdg_toplevel" version="7">
623 <description summary="toplevel surface">
624 This interface defines an xdg_surface role which allows a surface to,
625 among other things, set window-like properties such as maximize,
626 fullscreen, and minimize, set application-specific metadata like title and
627 id, and well as trigger user interactive operations such as interactive
628 resize and move.
629
630 An xdg_toplevel by default is responsible for providing the full intended
631 visual representation of the toplevel, which depending on the window
632 state, may mean things like a title bar, window controls and drop shadow.
633
634 Unmapping an xdg_toplevel means that the surface cannot be shown
635 by the compositor until it is explicitly mapped again.
636 All active operations (e.g., move, resize) are canceled and all
637 attributes (e.g. title, state, stacking, ...) are discarded for
638 an xdg_toplevel surface when it is unmapped. The xdg_toplevel returns to
639 the state it had right after xdg_surface.get_toplevel. The client
640 can re-map the toplevel by performing a commit without any buffer
641 attached, waiting for a configure event and handling it as usual (see
642 xdg_surface description).
643
644 Attaching a null buffer to a toplevel unmaps the surface.
645 </description>
646
647 <request name="destroy" type="destructor">
648 <description summary="destroy the xdg_toplevel">
649 This request destroys the role surface and unmaps the surface;
650 see "Unmapping" behavior in interface section for details.
651 </description>
652 </request>
653
654 <enum name="error">
655 <entry name="invalid_resize_edge" value="0" summary="provided value is
656 not a valid variant of the resize_edge enum"/>
657 <entry name="invalid_parent" value="1"
658 summary="invalid parent toplevel"/>
659 <entry name="invalid_size" value="2"
660 summary="client provided an invalid min or max size"/>
661 </enum>
662
663 <request name="set_parent">
664 <description summary="set the parent of this surface">
665 Set the "parent" of this surface. This surface should be stacked
666 above the parent surface and all other ancestor surfaces.
667
668 Parent surfaces should be set on dialogs, toolboxes, or other
669 "auxiliary" surfaces, so that the parent is raised when the dialog
670 is raised.
671
672 Setting a null parent for a child surface unsets its parent. Setting
673 a null parent for a surface which currently has no parent is a no-op.
674
675 Only mapped surfaces can have child surfaces. Setting a parent which
676 is not mapped is equivalent to setting a null parent. If a surface
677 becomes unmapped, its children's parent is set to the parent of
678 the now-unmapped surface. If the now-unmapped surface has no parent,
679 its children's parent is unset. If the now-unmapped surface becomes
680 mapped again, its parent-child relationship is not restored.
681
682 The parent toplevel must not be one of the child toplevel's
683 descendants, and the parent must be different from the child toplevel,
684 otherwise the invalid_parent protocol error is raised.
685 </description>
686 <arg name="parent" type="object" interface="xdg_toplevel" allow-null="true" summary="parent surface for this surface"/>
687 </request>
688
689 <request name="set_title">
690 <description summary="set surface title">
691 Set a short title for the surface.
692
693 This string may be used to identify the surface in a task bar,
694 window list, or other user interface elements provided by the
695 compositor.
696
697 The string must be encoded in UTF-8.
698 </description>
699 <arg name="title" type="string" summary="title of the surface"/>
700 </request>
701
702 <request name="set_app_id">
703 <description summary="set application ID">
704 Set an application identifier for the surface.
705
706 The app ID identifies the general class of applications to which
707 the surface belongs. The compositor can use this to group multiple
708 surfaces together, or to determine how to launch a new application.
709
710 For D-Bus activatable applications, the app ID is used as the D-Bus
711 service name.
712
713 The compositor shell will try to group application surfaces together
714 by their app ID. As a best practice, it is suggested to select app
715 ID's that match the basename of the application's .desktop file.
716 For example, "org.freedesktop.FooViewer" where the .desktop file is
717 "org.freedesktop.FooViewer.desktop".
718
719 Like other properties, a set_app_id request can be sent after the
720 xdg_toplevel has been mapped to update the property.
721
722 See the desktop-entry specification [0] for more details on
723 application identifiers and how they relate to well-known D-Bus
724 names and .desktop files.
725
726 [0] https://standards.freedesktop.org/desktop-entry-spec/
727 </description>
728 <arg name="app_id" type="string" summary="application identifier surface belongs to"/>
729 </request>
730
731 <request name="show_window_menu">
732 <description summary="show the window menu">
733 Clients implementing client-side decorations might want to show
734 a context menu when right-clicking on the decorations, giving the
735 user a menu that they can use to maximize or minimize the window.
736
737 This request asks the compositor to pop up such a window menu at
738 the given position, relative to the local surface coordinates of
739 the parent surface. There are no guarantees as to what menu items
740 the window menu contains, or even if a window menu will be drawn
741 at all.
742
743 This request must be used in response to some sort of user action
744 like a button press, key press, or touch down event.
745 </description>
746 <arg name="seat" type="object" interface="wl_seat" summary="the wl_seat of the user event"/>
747 <arg name="serial" type="uint" summary="the serial of the user event"/>
748 <arg name="x" type="int" summary="the x position to pop up the window menu at"/>
749 <arg name="y" type="int" summary="the y position to pop up the window menu at"/>
750 </request>
751
752 <request name="move">
753 <description summary="start an interactive move">
754 Start an interactive, user-driven move of the surface.
755
756 This request must be used in response to some sort of user action
757 like a button press, key press, or touch down event. The passed
758 serial is used to determine the type of interactive move (touch,
759 pointer, etc).
760
761 The server may ignore move requests depending on the state of
762 the surface (e.g. fullscreen or maximized), or if the passed serial
763 is no longer valid.
764
765 If triggered, the surface will lose the focus of the device
766 (wl_pointer, wl_touch, etc) used for the move. It is up to the
767 compositor to visually indicate that the move is taking place, such as
768 updating a pointer cursor, during the move. There is no guarantee
769 that the device focus will return when the move is completed.
770 </description>
771 <arg name="seat" type="object" interface="wl_seat" summary="the wl_seat of the user event"/>
772 <arg name="serial" type="uint" summary="the serial of the user event"/>
773 </request>
774
775 <enum name="resize_edge">
776 <description summary="edge values for resizing">
777 These values are used to indicate which edge of a surface
778 is being dragged in a resize operation.
779 </description>
780 <entry name="none" value="0"/>
781 <entry name="top" value="1"/>
782 <entry name="bottom" value="2"/>
783 <entry name="left" value="4"/>
784 <entry name="top_left" value="5"/>
785 <entry name="bottom_left" value="6"/>
786 <entry name="right" value="8"/>
787 <entry name="top_right" value="9"/>
788 <entry name="bottom_right" value="10"/>
789 </enum>
790
791 <request name="resize">
792 <description summary="start an interactive resize">
793 Start a user-driven, interactive resize of the surface.
794
795 This request must be used in response to some sort of user action
796 like a button press, key press, or touch down event. The passed
797 serial is used to determine the type of interactive resize (touch,
798 pointer, etc).
799
800 The server may ignore resize requests depending on the state of
801 the surface (e.g. fullscreen or maximized).
802
803 If triggered, the client will receive configure events with the
804 "resize" state enum value and the expected sizes. See the "resize"
805 enum value for more details about what is required. The client
806 must also acknowledge configure events using "ack_configure". After
807 the resize is completed, the client will receive another "configure"
808 event without the resize state.
809
810 If triggered, the surface also will lose the focus of the device
811 (wl_pointer, wl_touch, etc) used for the resize. It is up to the
812 compositor to visually indicate that the resize is taking place,
813 such as updating a pointer cursor, during the resize. There is no
814 guarantee that the device focus will return when the resize is
815 completed.
816
817 The edges parameter specifies how the surface should be resized, and
818 is one of the values of the resize_edge enum. Values not matching
819 a variant of the enum will cause the invalid_resize_edge protocol error.
820 The compositor may use this information to update the surface position
821 for example when dragging the top left corner. The compositor may also
822 use this information to adapt its behavior, e.g. choose an appropriate
823 cursor image.
824 </description>
825 <arg name="seat" type="object" interface="wl_seat" summary="the wl_seat of the user event"/>
826 <arg name="serial" type="uint" summary="the serial of the user event"/>
827 <arg name="edges" type="uint" enum="resize_edge" summary="which edge or corner is being dragged"/>
828 </request>
829
830 <enum name="state">
831 <description summary="types of state on the surface">
832 The different state values used on the surface. This is designed for
833 state values like maximized, fullscreen. It is paired with the
834 configure event to ensure that both the client and the compositor
835 setting the state can be synchronized.
836
837 States set in this way are double-buffered, see wl_surface.commit.
838 </description>
839 <entry name="maximized" value="1" summary="the surface is maximized">
840 <description summary="the surface is maximized">
841 The surface is maximized. The window geometry specified in the configure
842 event must be obeyed by the client, or the xdg_wm_base.invalid_surface_state
843 error is raised.
844
845 The client should draw without shadow or other
846 decoration outside of the window geometry.
847 </description>
848 </entry>
849 <entry name="fullscreen" value="2" summary="the surface is fullscreen">
850 <description summary="the surface is fullscreen">
851 The surface is fullscreen. The window geometry specified in the
852 configure event is a maximum; the client cannot resize beyond it. For
853 a surface to cover the whole fullscreened area, the geometry
854 dimensions must be obeyed by the client. For more details, see
855 xdg_toplevel.set_fullscreen.
856 </description>
857 </entry>
858 <entry name="resizing" value="3" summary="the surface is being resized">
859 <description summary="the surface is being resized">
860 The surface is being resized. The window geometry specified in the
861 configure event is a maximum; the client cannot resize beyond it.
862 Clients that have aspect ratio or cell sizing configuration can use
863 a smaller size, however.
864 </description>
865 </entry>
866 <entry name="activated" value="4" summary="the surface is now activated">
867 <description summary="the surface is now activated">
868 Client window decorations should be painted as if the window is
869 active. Do not assume this means that the window actually has
870 keyboard or pointer focus.
871 </description>
872 </entry>
873 <entry name="tiled_left" value="5" since="2">
874 <description summary="the surface’s left edge is tiled">
875 The window is currently in a tiled layout and the left edge is
876 considered to be adjacent to another part of the tiling grid.
877
878 The client should draw without shadow or other decoration outside of
879 the window geometry on the left edge.
880 </description>
881 </entry>
882 <entry name="tiled_right" value="6" since="2">
883 <description summary="the surface’s right edge is tiled">
884 The window is currently in a tiled layout and the right edge is
885 considered to be adjacent to another part of the tiling grid.
886
887 The client should draw without shadow or other decoration outside of
888 the window geometry on the right edge.
889 </description>
890 </entry>
891 <entry name="tiled_top" value="7" since="2">
892 <description summary="the surface’s top edge is tiled">
893 The window is currently in a tiled layout and the top edge is
894 considered to be adjacent to another part of the tiling grid.
895
896 The client should draw without shadow or other decoration outside of
897 the window geometry on the top edge.
898 </description>
899 </entry>
900 <entry name="tiled_bottom" value="8" since="2">
901 <description summary="the surface’s bottom edge is tiled">
902 The window is currently in a tiled layout and the bottom edge is
903 considered to be adjacent to another part of the tiling grid.
904
905 The client should draw without shadow or other decoration outside of
906 the window geometry on the bottom edge.
907 </description>
908 </entry>
909 <entry name="suspended" value="9" since="6">
910 <description summary="surface repaint is suspended">
911 The surface is currently not ordinarily being repainted; for
912 example because its content is occluded by another window, or its
913 outputs are switched off due to screen locking.
914 </description>
915 </entry>
916 <entry name="constrained_left" value="10" since="7">
917 <description summary="the surface’s left edge is constrained">
918 The left edge of the window is currently constrained, meaning it
919 shouldn't attempt to resize from that edge. It can for example mean
920 it's tiled next to a monitor edge on the constrained side of the
921 window.
922 </description>
923 </entry>
924 <entry name="constrained_right" value="11" since="7">
925 <description summary="the surface’s right edge is constrained">
926 The right edge of the window is currently constrained, meaning it
927 shouldn't attempt to resize from that edge. It can for example mean
928 it's tiled next to a monitor edge on the constrained side of the
929 window.
930 </description>
931 </entry>
932 <entry name="constrained_top" value="12" since="7">
933 <description summary="the surface’s top edge is constrained">
934 The top edge of the window is currently constrained, meaning it
935 shouldn't attempt to resize from that edge. It can for example mean
936 it's tiled next to a monitor edge on the constrained side of the
937 window.
938 </description>
939 </entry>
940 <entry name="constrained_bottom" value="13" since="7">
941 <description summary="the surface’s bottom edge is constrained">
942 The bottom edge of the window is currently constrained, meaning it
943 shouldn't attempt to resize from that edge. It can for example mean
944 it's tiled next to a monitor edge on the constrained side of the
945 window.
946 </description>
947 </entry>
948 </enum>
949
950 <request name="set_max_size">
951 <description summary="set the maximum size">
952 Set a maximum size for the window.
953
954 The client can specify a maximum size so that the compositor does
955 not try to configure the window beyond this size.
956
957 The width and height arguments are in window geometry coordinates.
958 See xdg_surface.set_window_geometry.
959
960 Values set in this way are double-buffered, see wl_surface.commit.
961
962 The compositor can use this information to allow or disallow
963 different states like maximize or fullscreen and draw accurate
964 animations.
965
966 Similarly, a tiling window manager may use this information to
967 place and resize client windows in a more effective way.
968
969 The client should not rely on the compositor to obey the maximum
970 size. The compositor may decide to ignore the values set by the
971 client and request a larger size.
972
973 If never set, or a value of zero in the request, means that the
974 client has no expected maximum size in the given dimension.
975 As a result, a client wishing to reset the maximum size
976 to an unspecified state can use zero for width and height in the
977 request.
978
979 Requesting a maximum size to be smaller than the minimum size of
980 a surface is illegal and will result in an invalid_size error.
981
982 The width and height must be greater than or equal to zero. Using
983 strictly negative values for width or height will result in an
984 invalid_size error.
985 </description>
986 <arg name="width" type="int" summary="maximum width of the window"/>
987 <arg name="height" type="int" summary="maximum height of the window"/>
988 </request>
989
990 <request name="set_min_size">
991 <description summary="set the minimum size">
992 Set a minimum size for the window.
993
994 The client can specify a minimum size so that the compositor does
995 not try to configure the window below this size.
996
997 The width and height arguments are in window geometry coordinates.
998 See xdg_surface.set_window_geometry.
999
1000 Values set in this way are double-buffered, see wl_surface.commit.
1001
1002 The compositor can use this information to allow or disallow
1003 different states like maximize or fullscreen and draw accurate
1004 animations.
1005
1006 Similarly, a tiling window manager may use this information to
1007 place and resize client windows in a more effective way.
1008
1009 The client should not rely on the compositor to obey the minimum
1010 size. The compositor may decide to ignore the values set by the
1011 client and request a smaller size.
1012
1013 If never set, or a value of zero in the request, means that the
1014 client has no expected minimum size in the given dimension.
1015 As a result, a client wishing to reset the minimum size
1016 to an unspecified state can use zero for width and height in the
1017 request.
1018
1019 Requesting a minimum size to be larger than the maximum size of
1020 a surface is illegal and will result in an invalid_size error.
1021
1022 The width and height must be greater than or equal to zero. Using
1023 strictly negative values for width and height will result in an
1024 invalid_size error.
1025 </description>
1026 <arg name="width" type="int" summary="minimum width of the window"/>
1027 <arg name="height" type="int" summary="minimum height of the window"/>
1028 </request>
1029
1030 <request name="set_maximized">
1031 <description summary="maximize the window">
1032 Maximize the surface.
1033
1034 After requesting that the surface should be maximized, the compositor
1035 will respond by emitting a configure event. Whether this configure
1036 actually sets the window maximized is subject to compositor policies.
1037 The client must then update its content, drawing in the configured
1038 state. The client must also acknowledge the configure when committing
1039 the new content (see ack_configure).
1040
1041 It is up to the compositor to decide how and where to maximize the
1042 surface, for example which output and what region of the screen should
1043 be used.
1044
1045 If the surface was already maximized, the compositor will still emit
1046 a configure event with the "maximized" state.
1047
1048 If the surface is in a fullscreen state, this request has no direct
1049 effect. It may alter the state the surface is returned to when
1050 unmaximized unless overridden by the compositor.
1051 </description>
1052 </request>
1053
1054 <request name="unset_maximized">
1055 <description summary="unmaximize the window">
1056 Unmaximize the surface.
1057
1058 After requesting that the surface should be unmaximized, the compositor
1059 will respond by emitting a configure event. Whether this actually
1060 un-maximizes the window is subject to compositor policies.
1061 If available and applicable, the compositor will include the window
1062 geometry dimensions the window had prior to being maximized in the
1063 configure event. The client must then update its content, drawing it in
1064 the configured state. The client must also acknowledge the configure
1065 when committing the new content (see ack_configure).
1066
1067 It is up to the compositor to position the surface after it was
1068 unmaximized; usually the position the surface had before maximizing, if
1069 applicable.
1070
1071 If the surface was already not maximized, the compositor will still
1072 emit a configure event without the "maximized" state.
1073
1074 If the surface is in a fullscreen state, this request has no direct
1075 effect. It may alter the state the surface is returned to when
1076 unmaximized unless overridden by the compositor.
1077 </description>
1078 </request>
1079
1080 <request name="set_fullscreen">
1081 <description summary="set the window as fullscreen on an output">
1082 Make the surface fullscreen.
1083
1084 After requesting that the surface should be fullscreened, the
1085 compositor will respond by emitting a configure event. Whether the
1086 client is actually put into a fullscreen state is subject to compositor
1087 policies. The client must also acknowledge the configure when
1088 committing the new content (see ack_configure).
1089
1090 The output passed by the request indicates the client's preference as
1091 to which display it should be set fullscreen on. If this value is NULL,
1092 it's up to the compositor to choose which display will be used to map
1093 this surface.
1094
1095 If the surface doesn't cover the whole output, the compositor will
1096 position the surface in the center of the output and compensate with
1097 border fill covering the rest of the output. The content of the
1098 border fill is undefined, but should be assumed to be in some way that
1099 attempts to blend into the surrounding area (e.g. solid black).
1100
1101 If the fullscreened surface is not opaque, the compositor must make
1102 sure that other screen content not part of the same surface tree (made
1103 up of subsurfaces, popups or similarly coupled surfaces) are not
1104 visible below the fullscreened surface.
1105 </description>
1106 <arg name="output" type="object" interface="wl_output" allow-null="true" summary="preferred output to place surface on"/>
1107 </request>
1108
1109 <request name="unset_fullscreen">
1110 <description summary="unset the window as fullscreen">
1111 Make the surface no longer fullscreen.
1112
1113 After requesting that the surface should be unfullscreened, the
1114 compositor will respond by emitting a configure event.
1115 Whether this actually removes the fullscreen state of the client is
1116 subject to compositor policies.
1117
1118 Making a surface unfullscreen sets states for the surface based on the following:
1119 * the state(s) it may have had before becoming fullscreen
1120 * any state(s) decided by the compositor
1121 * any state(s) requested by the client while the surface was fullscreen
1122
1123 The compositor may include the previous window geometry dimensions in
1124 the configure event, if applicable.
1125
1126 The client must also acknowledge the configure when committing the new
1127 content (see ack_configure).
1128 </description>
1129 </request>
1130
1131 <request name="set_minimized">
1132 <description summary="set the window as minimized">
1133 Request that the compositor minimize your surface. There is no
1134 way to know if the surface is currently minimized, nor is there
1135 any way to unset minimization on this surface.
1136
1137 If you are looking to throttle redrawing when minimized, please
1138 instead use the wl_surface.frame event for this, as this will
1139 also work with live previews on windows in Alt-Tab, Expose or
1140 similar compositor features.
1141 </description>
1142 </request>
1143
1144 <event name="configure">
1145 <description summary="suggest a surface change">
1146 This configure event asks the client to resize its toplevel surface or
1147 to change its state. The configured state should not be applied
1148 immediately. See xdg_surface.configure for details.
1149
1150 The width and height arguments specify a hint to the window
1151 about how its surface should be resized in window geometry
1152 coordinates. See set_window_geometry.
1153
1154 If the width or height arguments are zero, it means the client
1155 should decide its own window dimension. This may happen when the
1156 compositor needs to configure the state of the surface but doesn't
1157 have any information about any previous or expected dimension.
1158
1159 The states listed in the event specify how the width/height
1160 arguments should be interpreted, and possibly how it should be
1161 drawn.
1162
1163 The states are sent as an array of 32-bit unsigned integers in
1164 native endianness. State values are defined in the state enum.
1165
1166 Clients must send an ack_configure in response to this event. See
1167 xdg_surface.configure and xdg_surface.ack_configure for details.
1168 </description>
1169 <arg name="width" type="int" summary="suggested width of window"/>
1170 <arg name="height" type="int" summary="suggested height of window"/>
1171 <arg name="states" type="array" summary="suggested states of the window"/>
1172 </event>
1173
1174 <event name="close">
1175 <description summary="surface wants to be closed">
1176 The close event is sent by the compositor when the user
1177 wants the surface to be closed. This should be equivalent to
1178 the user clicking the close button in client-side decorations,
1179 if your application has any.
1180
1181 This is only a request that the user intends to close the
1182 window. The client may choose to ignore this request, or show
1183 a dialog to ask the user to save their data, etc.
1184 </description>
1185 </event>
1186
1187 <!-- Version 4 additions -->
1188
1189 <event name="configure_bounds" since="4">
1190 <description summary="recommended window geometry bounds">
1191 The configure_bounds event may be sent prior to a xdg_toplevel.configure
1192 event to communicate the bounds a window geometry size is recommended
1193 to constrain to.
1194
1195 The passed width and height are in surface coordinate space. If width
1196 and height are 0, it means bounds is unknown and equivalent to as if no
1197 configure_bounds event was ever sent for this surface.
1198
1199 The bounds can for example correspond to the size of a monitor excluding
1200 any panels or other shell components, so that a surface isn't created in
1201 a way that it cannot fit.
1202
1203 The bounds may change at any point, and in such a case, a new
1204 xdg_toplevel.configure_bounds will be sent, followed by
1205 xdg_toplevel.configure and xdg_surface.configure.
1206 </description>
1207 <arg name="width" type="int" summary="suggested maximum width of surface"/>
1208 <arg name="height" type="int" summary="suggested maximum height of surface"/>
1209 </event>
1210
1211 <!-- Version 5 additions -->
1212
1213 <enum name="wm_capabilities" since="5">
1214 <entry name="window_menu" value="1" summary="show_window_menu is available"/>
1215 <entry name="maximize" value="2" summary="set_maximized and unset_maximized are available"/>
1216 <entry name="fullscreen" value="3" summary="set_fullscreen and unset_fullscreen are available"/>
1217 <entry name="minimize" value="4" summary="set_minimized is available"/>
1218 </enum>
1219
1220 <event name="wm_capabilities" since="5">
1221 <description summary="compositor capabilities">
1222 This event advertises the capabilities supported by the compositor. If
1223 a capability isn't supported, clients should hide or disable the UI
1224 elements that expose this functionality. For instance, if the
1225 compositor doesn't advertise support for minimized toplevels, a button
1226 triggering the set_minimized request should not be displayed.
1227
1228 The compositor will ignore requests it doesn't support. For instance,
1229 a compositor which doesn't advertise support for minimized will ignore
1230 set_minimized requests.
1231
1232 Compositors must send this event once before the first
1233 xdg_surface.configure event. When the capabilities change, compositors
1234 must send this event again and then send an xdg_surface.configure
1235 event.
1236
1237 The configured state should not be applied immediately. See
1238 xdg_surface.configure for details.
1239
1240 The capabilities are sent as an array of 32-bit unsigned integers in
1241 native endianness. Capability values are defined in the wm_capabilities enum.
1242 </description>
1243 <arg name="capabilities" type="array" summary="array of 32-bit capabilities"/>
1244 </event>
1245 </interface>
1246
1247 <interface name="xdg_popup" version="7">
1248 <description summary="short-lived, popup surfaces for menus">
1249 A popup surface is a short-lived, temporary surface. It can be used to
1250 implement for example menus, popovers, tooltips and other similar user
1251 interface concepts.
1252
1253 A popup can be made to take an explicit grab. See xdg_popup.grab for
1254 details.
1255
1256 When the popup is dismissed, a popup_done event will be sent out, and at
1257 the same time the surface will be unmapped. See the xdg_popup.popup_done
1258 event for details.
1259
1260 Explicitly destroying the xdg_popup object will also dismiss the popup and
1261 unmap the surface. Clients that want to dismiss the popup when another
1262 surface of their own is clicked should dismiss the popup using the destroy
1263 request.
1264
1265 A newly created xdg_popup will be stacked on top of all previously created
1266 xdg_popup surfaces associated with the same xdg_toplevel.
1267
1268 The parent of an xdg_popup must be mapped (see the xdg_surface
1269 description) before the xdg_popup itself.
1270
1271 The client must call wl_surface.commit on the corresponding wl_surface
1272 for the xdg_popup state to take effect.
1273 </description>
1274
1275 <enum name="error">
1276 <entry name="invalid_grab" value="0"
1277 summary="tried to grab after being mapped"/>
1278 </enum>
1279
1280 <request name="destroy" type="destructor">
1281 <description summary="remove xdg_popup interface">
1282 This destroys the popup. Explicitly destroying the xdg_popup
1283 object will also dismiss the popup, and unmap the surface.
1284
1285 If this xdg_popup is not the "topmost" popup, the
1286 xdg_wm_base.not_the_topmost_popup protocol error will be sent.
1287 </description>
1288 </request>
1289
1290 <request name="grab">
1291 <description summary="make the popup take an explicit grab">
1292 This request makes the created popup take an explicit grab. An explicit
1293 grab will be dismissed when the user dismisses the popup, or when the
1294 client destroys the xdg_popup. This can be done by the user clicking
1295 outside the surface, using the keyboard, or even locking the screen
1296 through closing the lid or a timeout.
1297
1298 If the compositor denies the grab, the popup will be immediately
1299 dismissed.
1300
1301 This request must be used in response to some sort of user action like a
1302 button press, key press, or touch down event. The serial number of the
1303 event should be passed as 'serial'.
1304
1305 The parent of a grabbing popup must either be an xdg_toplevel surface or
1306 another xdg_popup with an explicit grab. If the parent is another
1307 xdg_popup it means that the popups are nested, with this popup now being
1308 the topmost popup.
1309
1310 Nested popups must be destroyed in the reverse order they were created
1311 in, e.g. the only popup you are allowed to destroy at all times is the
1312 topmost one.
1313
1314 When compositors choose to dismiss a popup, they may dismiss every
1315 nested grabbing popup as well. When a compositor dismisses popups, it
1316 will follow the same dismissing order as required from the client.
1317
1318 If the topmost grabbing popup is destroyed, the grab will be returned to
1319 the parent of the popup, if that parent previously had an explicit grab.
1320
1321 If the parent is a grabbing popup which has already been dismissed, this
1322 popup will be immediately dismissed. If the parent is a popup that did
1323 not take an explicit grab, an error will be raised.
1324
1325 During a popup grab, the client owning the grab will receive pointer
1326 and touch events for all their surfaces as normal (similar to an
1327 "owner-events" grab in X11 parlance), while the top most grabbing popup
1328 will always have keyboard focus.
1329 </description>
1330 <arg name="seat" type="object" interface="wl_seat"
1331 summary="the wl_seat of the user event"/>
1332 <arg name="serial" type="uint" summary="the serial of the user event"/>
1333 </request>
1334
1335 <event name="configure">
1336 <description summary="configure the popup surface">
1337 This event asks the popup surface to configure itself given the
1338 configuration. The configured state should not be applied immediately.
1339 See xdg_surface.configure for details.
1340
1341 The x and y arguments represent the position the popup was placed at
1342 given the xdg_positioner rule, relative to the upper left corner of the
1343 window geometry of the parent surface.
1344
1345 For version 2 or older, the configure event for an xdg_popup is only
1346 ever sent once for the initial configuration. Starting with version 3,
1347 it may be sent again if the popup is setup with an xdg_positioner with
1348 set_reactive requested, or in response to xdg_popup.reposition requests.
1349 </description>
1350 <arg name="x" type="int"
1351 summary="x position relative to parent surface window geometry"/>
1352 <arg name="y" type="int"
1353 summary="y position relative to parent surface window geometry"/>
1354 <arg name="width" type="int" summary="window geometry width"/>
1355 <arg name="height" type="int" summary="window geometry height"/>
1356 </event>
1357
1358 <event name="popup_done">
1359 <description summary="popup interaction is done">
1360 The popup_done event is sent out when a popup is dismissed by the
1361 compositor. The client should destroy the xdg_popup object at this
1362 point.
1363 </description>
1364 </event>
1365
1366 <!-- Version 3 additions -->
1367
1368 <request name="reposition" since="3">
1369 <description summary="recalculate the popup's location">
1370 Reposition an already-mapped popup. The popup will be placed given the
1371 details in the passed xdg_positioner object, and a
1372 xdg_popup.repositioned followed by xdg_popup.configure and
1373 xdg_surface.configure will be emitted in response. Any parameters set
1374 by the previous positioner will be discarded.
1375
1376 The passed token will be sent in the corresponding
1377 xdg_popup.repositioned event. The new popup position will not take
1378 effect until the corresponding configure event is acknowledged by the
1379 client. See xdg_popup.repositioned for details. The token itself is
1380 opaque, and has no other special meaning.
1381
1382 If multiple reposition requests are sent, the compositor may skip all
1383 but the last one.
1384
1385 If the popup is repositioned in response to a configure event for its
1386 parent, the client should send an xdg_positioner.set_parent_configure
1387 and possibly an xdg_positioner.set_parent_size request to allow the
1388 compositor to properly constrain the popup.
1389
1390 If the popup is repositioned together with a parent that is being
1391 resized, but not in response to a configure event, the client should
1392 send an xdg_positioner.set_parent_size request.
1393 </description>
1394 <arg name="positioner" type="object" interface="xdg_positioner"/>
1395 <arg name="token" type="uint" summary="reposition request token"/>
1396 </request>
1397
1398 <event name="repositioned" since="3">
1399 <description summary="signal the completion of a repositioned request">
1400 The repositioned event is sent as part of a popup configuration
1401 sequence, together with xdg_popup.configure and lastly
1402 xdg_surface.configure to notify the completion of a reposition request.
1403
1404 The repositioned event is to notify about the completion of a
1405 xdg_popup.reposition request. The token argument is the token passed
1406 in the xdg_popup.reposition request.
1407
1408 Immediately after this event is emitted, xdg_popup.configure and
1409 xdg_surface.configure will be sent with the updated size and position,
1410 as well as a new configure serial.
1411
1412 The client should optionally update the content of the popup, but must
1413 acknowledge the new popup configuration for the new position to take
1414 effect. See xdg_surface.ack_configure for details.
1415 </description>
1416 <arg name="token" type="uint" summary="reposition request token"/>
1417 </event>
1418
1419 </interface>
1420</protocol>