0<?xml version="1.0" encoding="UTF-8"?>
1<protocol name="xdg_shell">
3 <copyright>
4 Copyright © 2008-2013 Kristian Høgsberg
5 Copyright © 2013 Rafael Antognolli
6 Copyright © 2013 Jasper St. Pierre
7 Copyright © 2010-2013 Intel Corporation
8 Copyright © 2015-2017 Samsung Electronics Co., Ltd
9 Copyright © 2015-2017 Red Hat Inc.
11 Permission is hereby granted, free of charge, to any person obtaining a
12 copy of this software and associated documentation files (the "Software"),
13 to deal in the Software without restriction, including without limitation
14 the rights to use, copy, modify, merge, publish, distribute, sublicense,
15 and/or sell copies of the Software, and to permit persons to whom the
16 Software is furnished to do so, subject to the following conditions:
18 The above copyright notice and this permission notice (including the next
19 paragraph) shall be included in all copies or substantial portions of the
20 Software.
22 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
25 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
27 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
28 DEALINGS IN THE SOFTWARE.
29 </copyright>
31 <interface name="xdg_wm_base" version="6">
32 <description summary="create desktop-style surfaces">
33 The xdg_wm_base interface is exposed as a global object enabling clients
34 to turn their wl_surfaces into windows in a desktop environment. It
35 defines the basic functionality needed for clients and the compositor to
36 create windows that can be dragged, resized, maximized, etc, as well as
37 creating transient windows such as popup menus.
38 </description>
40 <enum name="error">
41 <entry name="role" value="0" summary="given wl_surface has another role"/>
42 <entry name="defunct_surfaces" value="1"
43 summary="xdg_wm_base was destroyed before children"/>
44 <entry name="not_the_topmost_popup" value="2"
45 summary="the client tried to map or destroy a non-topmost popup"/>
46 <entry name="invalid_popup_parent" value="3"
47 summary="the client specified an invalid popup parent surface"/>
48 <entry name="invalid_surface_state" value="4"
49 summary="the client provided an invalid surface state"/>
50 <entry name="invalid_positioner" value="5"
51 summary="the client provided an invalid positioner"/>
52 <entry name="unresponsive" value="6"
53 summary="the client didn’t respond to a ping event in time"/>
54 </enum>
56 <request name="destroy" type="destructor">
57 <description summary="destroy xdg_wm_base">
58 Destroy this xdg_wm_base object.
60 Destroying a bound xdg_wm_base object while there are surfaces
61 still alive created by this xdg_wm_base object instance is illegal
62 and will result in a defunct_surfaces error.
63 </description>
64 </request>
66 <request name="create_positioner">
67 <description summary="create a positioner object">
68 Create a positioner object. A positioner object is used to position
69 surfaces relative to some parent surface. See the interface description
70 and xdg_surface.get_popup for details.
71 </description>
72 <arg name="id" type="new_id" interface="xdg_positioner"/>
73 </request>
75 <request name="get_xdg_surface">
76 <description summary="create a shell surface from a surface">
77 This creates an xdg_surface for the given surface. While xdg_surface
78 itself is not a role, the corresponding surface may only be assigned
79 a role extending xdg_surface, such as xdg_toplevel or xdg_popup. It is
80 illegal to create an xdg_surface for a wl_surface which already has an
81 assigned role and this will result in a role error.
83 This creates an xdg_surface for the given surface. An xdg_surface is
84 used as basis to define a role to a given surface, such as xdg_toplevel
85 or xdg_popup. It also manages functionality shared between xdg_surface
86 based surface roles.
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>
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>
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.
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.
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>
124 <interface name="xdg_positioner" version="6">
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.
134 See the various requests for details about possible rules.
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.
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>
147 <enum name="error">
148 <entry name="invalid_input" value="0" summary="invalid input provided"/>
149 </enum>
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>
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.
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>
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.
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.
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>
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>
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 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"/>
211 </request>
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>
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>
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.
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.
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.
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.
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.
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.
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'.
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'.
308 The adjusted position is calculated given the original anchor
309 rectangle and offset, but with the new flipped anchor and gravity
310 values.
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>
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.
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.
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.
344 The default adjustment is none.
345 </description>
346 <arg name="constraint_adjustment" type="uint"
347 summary="bit mask of constraint adjustments"/>
348 </request>
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.
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>
368 <!-- Version 3 additions -->
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.
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>
381 <request name="set_parent_size" since="3">
382 <description summary="">
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.
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>
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>
409 <interface name="xdg_surface" version="6">
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.
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.
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.
425 A role must be assigned before any other requests are made to the
426 xdg_surface object.
428 The client must call wl_surface.commit on the corresponding wl_surface
429 for the xdg_surface state to take effect.
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.
436 After creating a role-specific object and setting it up, the client must
437 perform an initial commit without any buffer attached. The compositor
438 will reply with initial wl_surface state such as
439 wl_surface.preferred_buffer_scale followed by an xdg_surface.configure
440 event. The client must acknowledge it and is then allowed to attach a
441 buffer to map the surface.
443 Mapping an xdg_surface-based role surface is defined as making it
444 possible for the surface to be shown by the compositor. Note that
445 a mapped surface is not guaranteed to be visible once it is mapped.
447 For an xdg_surface to be mapped by the compositor, the following
448 conditions must be met:
449 (1) the client has assigned an xdg_surface-based role to the surface
450 (2) the client has set and committed the xdg_surface state and the
451 role-dependent state to the surface
452 (3) the client has committed a buffer to the surface
454 A newly-unmapped surface is considered to have met condition (1) out
455 of the 3 required conditions for mapping a surface if its role surface
456 has not been destroyed, i.e. the client must perform the initial commit
457 again before attaching a buffer.
458 </description>
460 <enum name="error">
461 <entry name="not_constructed" value="1"
462 summary="Surface was not fully constructed"/>
463 <entry name="already_constructed" value="2"
464 summary="Surface was already constructed"/>
465 <entry name="unconfigured_buffer" value="3"
466 summary="Attaching a buffer to an unconfigured surface"/>
467 <entry name="invalid_serial" value="4"
468 summary="Invalid serial number when acking a configure event"/>
469 <entry name="invalid_size" value="5"
470 summary="Width or height was zero or negative"/>
471 <entry name="defunct_role_object" value="6"
472 summary="Surface was destroyed before its role object"/>
473 </enum>
475 <request name="destroy" type="destructor">
476 <description summary="destroy the xdg_surface">
477 Destroy the xdg_surface object. An xdg_surface must only be destroyed
478 after its role object has been destroyed, otherwise
479 a defunct_role_object error is raised.
480 </description>
481 </request>
483 <request name="get_toplevel">
484 <description summary="assign the xdg_toplevel surface role">
485 This creates an xdg_toplevel object for the given xdg_surface and gives
486 the associated wl_surface the xdg_toplevel role.
488 See the documentation of xdg_toplevel for more details about what an
489 xdg_toplevel is and how it is used.
490 </description>
491 <arg name="id" type="new_id" interface="xdg_toplevel"/>
492 </request>
494 <request name="get_popup">
495 <description summary="assign the xdg_popup surface role">
496 This creates an xdg_popup object for the given xdg_surface and gives
497 the associated wl_surface the xdg_popup role.
499 If null is passed as a parent, a parent surface must be specified using
500 some other protocol, before committing the initial state.
502 See the documentation of xdg_popup for more details about what an
503 xdg_popup is and how it is used.
504 </description>
505 <arg name="id" type="new_id" interface="xdg_popup"/>
506 <arg name="parent" type="object" interface="xdg_surface" allow-null="true"/>
507 <arg name="positioner" type="object" interface="xdg_positioner"/>
508 </request>
510 <request name="set_window_geometry">
511 <description summary="set the new window geometry">
512 The window geometry of a surface is its "visible bounds" from the
513 user's perspective. Client-side decorations often have invisible
514 portions like drop-shadows which should be ignored for the
515 purposes of aligning, placing and constraining windows.
517 The window geometry is double buffered, and will be applied at the
518 time wl_surface.commit of the corresponding wl_surface is called.
520 When maintaining a position, the compositor should treat the (x, y)
521 coordinate of the window geometry as the top left corner of the window.
522 A client changing the (x, y) window geometry coordinate should in
523 general not alter the position of the window.
525 Once the window geometry of the surface is set, it is not possible to
526 unset it, and it will remain the same until set_window_geometry is
527 called again, even if a new subsurface or buffer is attached.
529 If never set, the value is the full bounds of the surface,
530 including any subsurfaces. This updates dynamically on every
531 commit. This unset is meant for extremely simple clients.
533 The arguments are given in the surface-local coordinate space of
534 the wl_surface associated with this xdg_surface, and may extend outside
535 of the wl_surface itself to mark parts of the subsurface tree as part of
536 the window geometry.
538 When applied, the effective window geometry will be the set window
539 geometry clamped to the bounding rectangle of the combined
540 geometry of the surface of the xdg_surface and the associated
541 subsurfaces.
543 The effective geometry will not be recalculated unless a new call to
544 set_window_geometry is done and the new pending surface state is
545 subsequently applied.
547 The width and height of the effective window geometry must be
548 greater than zero. Setting an invalid size will raise an
549 invalid_size error.
550 </description>
551 <arg name="x" type="int"/>
552 <arg name="y" type="int"/>
553 <arg name="width" type="int"/>
554 <arg name="height" type="int"/>
555 </request>
557 <request name="ack_configure">
558 <description summary="ack a configure event">
559 When a configure event is received, if a client commits the
560 surface in response to the configure event, then the client
561 must make an ack_configure request sometime before the commit
562 request, passing along the serial of the configure event.
564 For instance, for toplevel surfaces the compositor might use this
565 information to move a surface to the top left only when the client has
566 drawn itself for the maximized or fullscreen state.
568 If the client receives multiple configure events before it
569 can respond to one, it only has to ack the last configure event.
570 Acking a configure event that was never sent raises an invalid_serial
571 error.
573 A client is not required to commit immediately after sending
574 an ack_configure request - it may even ack_configure several times
575 before its next surface commit.
577 A client may send multiple ack_configure requests before committing, but
578 only the last request sent before a commit indicates which configure
579 event the client really is responding to.
581 Sending an ack_configure request consumes the serial number sent with
582 the request, as well as serial numbers sent by all configure events
583 sent on this xdg_surface prior to the configure event referenced by
584 the committed serial.
586 It is an error to issue multiple ack_configure requests referencing a
587 serial from the same configure event, or to issue an ack_configure
588 request referencing a serial from a configure event issued before the
589 event identified by the last ack_configure request for the same
590 xdg_surface. Doing so will raise an invalid_serial error.
591 </description>
592 <arg name="serial" type="uint" summary="the serial from the configure event"/>
593 </request>
595 <event name="configure">
596 <description summary="suggest a surface change">
597 The configure event marks the end of a configure sequence. A configure
598 sequence is a set of one or more events configuring the state of the
599 xdg_surface, including the final xdg_surface.configure event.
601 Where applicable, xdg_surface surface roles will during a configure
602 sequence extend this event as a latched state sent as events before the
603 xdg_surface.configure event. Such events should be considered to make up
604 a set of atomically applied configuration states, where the
605 xdg_surface.configure commits the accumulated state.
607 Clients should arrange their surface for the new states, and then send
608 an ack_configure request with the serial sent in this configure event at
609 some point before committing the new surface.
611 If the client receives multiple configure events before it can respond
612 to one, it is free to discard all but the last event it received.
613 </description>
614 <arg name="serial" type="uint" summary="serial of the configure event"/>
615 </event>
617 </interface>
619 <interface name="xdg_toplevel" version="6">
620 <description summary="toplevel surface">
621 This interface defines an xdg_surface role which allows a surface to,
622 among other things, set window-like properties such as maximize,
623 fullscreen, and minimize, set application-specific metadata like title and
624 id, and well as trigger user interactive operations such as interactive
625 resize and move.
627 Unmapping an xdg_toplevel means that the surface cannot be shown
628 by the compositor until it is explicitly mapped again.
629 All active operations (e.g., move, resize) are canceled and all
630 attributes (e.g. title, state, stacking, ...) are discarded for
631 an xdg_toplevel surface when it is unmapped. The xdg_toplevel returns to
632 the state it had right after xdg_surface.get_toplevel. The client
633 can re-map the toplevel by perfoming a commit without any buffer
634 attached, waiting for a configure event and handling it as usual (see
635 xdg_surface description).
637 Attaching a null buffer to a toplevel unmaps the surface.
638 </description>
640 <request name="destroy" type="destructor">
641 <description summary="destroy the xdg_toplevel">
642 This request destroys the role surface and unmaps the surface;
643 see "Unmapping" behavior in interface section for details.
644 </description>
645 </request>
647 <enum name="error">
648 <entry name="invalid_resize_edge" value="0" summary="provided value is
649 not a valid variant of the resize_edge enum"/>
650 <entry name="invalid_parent" value="1"
651 summary="invalid parent toplevel"/>
652 <entry name="invalid_size" value="2"
653 summary="client provided an invalid min or max size"/>
654 </enum>
656 <request name="set_parent">
657 <description summary="set the parent of this surface">
658 Set the "parent" of this surface. This surface should be stacked
659 above the parent surface and all other ancestor surfaces.
661 Parent surfaces should be set on dialogs, toolboxes, or other
662 "auxiliary" surfaces, so that the parent is raised when the dialog
663 is raised.
665 Setting a null parent for a child surface unsets its parent. Setting
666 a null parent for a surface which currently has no parent is a no-op.
668 Only mapped surfaces can have child surfaces. Setting a parent which
669 is not mapped is equivalent to setting a null parent. If a surface
670 becomes unmapped, its children's parent is set to the parent of
671 the now-unmapped surface. If the now-unmapped surface has no parent,
672 its children's parent is unset. If the now-unmapped surface becomes
673 mapped again, its parent-child relationship is not restored.
675 The parent toplevel must not be one of the child toplevel's
676 descendants, and the parent must be different from the child toplevel,
677 otherwise the invalid_parent protocol error is raised.
678 </description>
679 <arg name="parent" type="object" interface="xdg_toplevel" allow-null="true"/>
680 </request>
682 <request name="set_title">
683 <description summary="set surface title">
684 Set a short title for the surface.
686 This string may be used to identify the surface in a task bar,
687 window list, or other user interface elements provided by the
688 compositor.
690 The string must be encoded in UTF-8.
691 </description>
692 <arg name="title" type="string"/>
693 </request>
695 <request name="set_app_id">
696 <description summary="set application ID">
697 Set an application identifier for the surface.
699 The app ID identifies the general class of applications to which
700 the surface belongs. The compositor can use this to group multiple
701 surfaces together, or to determine how to launch a new application.
703 For D-Bus activatable applications, the app ID is used as the D-Bus
704 service name.
706 The compositor shell will try to group application surfaces together
707 by their app ID. As a best practice, it is suggested to select app
708 ID's that match the basename of the application's .desktop file.
709 For example, "org.freedesktop.FooViewer" where the .desktop file is
710 "org.freedesktop.FooViewer.desktop".
712 Like other properties, a set_app_id request can be sent after the
713 xdg_toplevel has been mapped to update the property.
715 See the desktop-entry specification [0] for more details on
716 application identifiers and how they relate to well-known D-Bus
717 names and .desktop files.
719 [0] https://standards.freedesktop.org/desktop-entry-spec/
720 </description>
721 <arg name="app_id" type="string"/>
722 </request>
724 <request name="show_window_menu">
725 <description summary="show the window menu">
726 Clients implementing client-side decorations might want to show
727 a context menu when right-clicking on the decorations, giving the
728 user a menu that they can use to maximize or minimize the window.
730 This request asks the compositor to pop up such a window menu at
731 the given position, relative to the local surface coordinates of
732 the parent surface. There are no guarantees as to what menu items
733 the window menu contains, or even if a window menu will be drawn
734 at all.
736 This request must be used in response to some sort of user action
737 like a button press, key press, or touch down event.
738 </description>
739 <arg name="seat" type="object" interface="wl_seat" summary="the wl_seat of the user event"/>
740 <arg name="serial" type="uint" summary="the serial of the user event"/>
741 <arg name="x" type="int" summary="the x position to pop up the window menu at"/>
742 <arg name="y" type="int" summary="the y position to pop up the window menu at"/>
743 </request>
745 <request name="move">
746 <description summary="start an interactive move">
747 Start an interactive, user-driven move of the surface.
749 This request must be used in response to some sort of user action
750 like a button press, key press, or touch down event. The passed
751 serial is used to determine the type of interactive move (touch,
752 pointer, etc).
754 The server may ignore move requests depending on the state of
755 the surface (e.g. fullscreen or maximized), or if the passed serial
756 is no longer valid.
758 If triggered, the surface will lose the focus of the device
759 (wl_pointer, wl_touch, etc) used for the move. It is up to the
760 compositor to visually indicate that the move is taking place, such as
761 updating a pointer cursor, during the move. There is no guarantee
762 that the device focus will return when the move is completed.
763 </description>
764 <arg name="seat" type="object" interface="wl_seat" summary="the wl_seat of the user event"/>
765 <arg name="serial" type="uint" summary="the serial of the user event"/>
766 </request>
768 <enum name="resize_edge">
769 <description summary="edge values for resizing">
770 These values are used to indicate which edge of a surface
771 is being dragged in a resize operation.
772 </description>
773 <entry name="none" value="0"/>
774 <entry name="top" value="1"/>
775 <entry name="bottom" value="2"/>
776 <entry name="left" value="4"/>
777 <entry name="top_left" value="5"/>
778 <entry name="bottom_left" value="6"/>
779 <entry name="right" value="8"/>
780 <entry name="top_right" value="9"/>
781 <entry name="bottom_right" value="10"/>
782 </enum>
784 <request name="resize">
785 <description summary="start an interactive resize">
786 Start a user-driven, interactive resize of the surface.
788 This request must be used in response to some sort of user action
789 like a button press, key press, or touch down event. The passed
790 serial is used to determine the type of interactive resize (touch,
791 pointer, etc).
793 The server may ignore resize requests depending on the state of
794 the surface (e.g. fullscreen or maximized).
796 If triggered, the client will receive configure events with the
797 "resize" state enum value and the expected sizes. See the "resize"
798 enum value for more details about what is required. The client
799 must also acknowledge configure events using "ack_configure". After
800 the resize is completed, the client will receive another "configure"
801 event without the resize state.
803 If triggered, the surface also will lose the focus of the device
804 (wl_pointer, wl_touch, etc) used for the resize. It is up to the
805 compositor to visually indicate that the resize is taking place,
806 such as updating a pointer cursor, during the resize. There is no
807 guarantee that the device focus will return when the resize is
808 completed.
810 The edges parameter specifies how the surface should be resized, and
811 is one of the values of the resize_edge enum. Values not matching
812 a variant of the enum will cause the invalid_resize_edge protocol error.
813 The compositor may use this information to update the surface position
814 for example when dragging the top left corner. The compositor may also
815 use this information to adapt its behavior, e.g. choose an appropriate
816 cursor image.
817 </description>
818 <arg name="seat" type="object" interface="wl_seat" summary="the wl_seat of the user event"/>
819 <arg name="serial" type="uint" summary="the serial of the user event"/>
820 <arg name="edges" type="uint" enum="resize_edge" summary="which edge or corner is being dragged"/>
821 </request>
823 <enum name="state">
824 <description summary="types of state on the surface">
825 The different state values used on the surface. This is designed for
826 state values like maximized, fullscreen. It is paired with the
827 configure event to ensure that both the client and the compositor
828 setting the state can be synchronized.
830 States set in this way are double-buffered. They will get applied on
831 the next commit.
832 </description>
833 <entry name="maximized" value="1" summary="the surface is maximized">
834 <description summary="the surface is maximized">
835 The surface is maximized. The window geometry specified in the configure
836 event must be obeyed by the client, or the xdg_wm_base.invalid_surface_state
837 error is raised.
839 The client should draw without shadow or other
840 decoration outside of the window geometry.
841 </description>
842 </entry>
843 <entry name="fullscreen" value="2" summary="the surface is fullscreen">
844 <description summary="the surface is fullscreen">
845 The surface is fullscreen. The window geometry specified in the
846 configure event is a maximum; the client cannot resize beyond it. For
847 a surface to cover the whole fullscreened area, the geometry
848 dimensions must be obeyed by the client. For more details, see
849 xdg_toplevel.set_fullscreen.
850 </description>
851 </entry>
852 <entry name="resizing" value="3" summary="the surface is being resized">
853 <description summary="the surface is being resized">
854 The surface is being resized. The window geometry specified in the
855 configure event is a maximum; the client cannot resize beyond it.
856 Clients that have aspect ratio or cell sizing configuration can use
857 a smaller size, however.
858 </description>
859 </entry>
860 <entry name="activated" value="4" summary="the surface is now activated">
861 <description summary="the surface is now activated">
862 Client window decorations should be painted as if the window is
863 active. Do not assume this means that the window actually has
864 keyboard or pointer focus.
865 </description>
866 </entry>
867 <entry name="tiled_left" value="5" since="2">
868 <description summary="the surface’s left edge is tiled">
869 The window is currently in a tiled layout and the left edge is
870 considered to be adjacent to another part of the tiling grid.
871 </description>
872 </entry>
873 <entry name="tiled_right" value="6" since="2">
874 <description summary="the surface’s right edge is tiled">
875 The window is currently in a tiled layout and the right edge is
876 considered to be adjacent to another part of the tiling grid.
877 </description>
878 </entry>
879 <entry name="tiled_top" value="7" since="2">
880 <description summary="the surface’s top edge is tiled">
881 The window is currently in a tiled layout and the top edge is
882 considered to be adjacent to another part of the tiling grid.
883 </description>
884 </entry>
885 <entry name="tiled_bottom" value="8" since="2">
886 <description summary="the surface’s bottom edge is tiled">
887 The window is currently in a tiled layout and the bottom edge is
888 considered to be adjacent to another part of the tiling grid.
889 </description>
890 </entry>
891 <entry name="suspended" value="9" since="6">
892 <description summary="surface repaint is suspended">
893 The surface is currently not ordinarily being repainted; for
894 example because its content is occluded by another window, or its
895 outputs are switched off due to screen locking.
896 </description>
897 </entry>
898 </enum>
900 <request name="set_max_size">
901 <description summary="set the maximum size">
902 Set a maximum size for the window.
904 The client can specify a maximum size so that the compositor does
905 not try to configure the window beyond this size.
907 The width and height arguments are in window geometry coordinates.
908 See xdg_surface.set_window_geometry.
910 Values set in this way are double-buffered. They will get applied
911 on the next commit.
913 The compositor can use this information to allow or disallow
914 different states like maximize or fullscreen and draw accurate
915 animations.
917 Similarly, a tiling window manager may use this information to
918 place and resize client windows in a more effective way.
920 The client should not rely on the compositor to obey the maximum
921 size. The compositor may decide to ignore the values set by the
922 client and request a larger size.
924 If never set, or a value of zero in the request, means that the
925 client has no expected maximum size in the given dimension.
926 As a result, a client wishing to reset the maximum size
927 to an unspecified state can use zero for width and height in the
928 request.
930 Requesting a maximum size to be smaller than the minimum size of
931 a surface is illegal and will result in an invalid_size error.
933 The width and height must be greater than or equal to zero. Using
934 strictly negative values for width or height will result in a
935 invalid_size error.
936 </description>
937 <arg name="width" type="int"/>
938 <arg name="height" type="int"/>
939 </request>
941 <request name="set_min_size">
942 <description summary="set the minimum size">
943 Set a minimum size for the window.
945 The client can specify a minimum size so that the compositor does
946 not try to configure the window below this size.
948 The width and height arguments are in window geometry coordinates.
949 See xdg_surface.set_window_geometry.
951 Values set in this way are double-buffered. They will get applied
952 on the next commit.
954 The compositor can use this information to allow or disallow
955 different states like maximize or fullscreen and draw accurate
956 animations.
958 Similarly, a tiling window manager may use this information to
959 place and resize client windows in a more effective way.
961 The client should not rely on the compositor to obey the minimum
962 size. The compositor may decide to ignore the values set by the
963 client and request a smaller size.
965 If never set, or a value of zero in the request, means that the
966 client has no expected minimum size in the given dimension.
967 As a result, a client wishing to reset the minimum size
968 to an unspecified state can use zero for width and height in the
969 request.
971 Requesting a minimum size to be larger than the maximum size of
972 a surface is illegal and will result in an invalid_size error.
974 The width and height must be greater than or equal to zero. Using
975 strictly negative values for width and height will result in a
976 invalid_size error.
977 </description>
978 <arg name="width" type="int"/>
979 <arg name="height" type="int"/>
980 </request>
982 <request name="set_maximized">
983 <description summary="maximize the window">
984 Maximize the surface.
986 After requesting that the surface should be maximized, the compositor
987 will respond by emitting a configure event. Whether this configure
988 actually sets the window maximized is subject to compositor policies.
989 The client must then update its content, drawing in the configured
990 state. The client must also acknowledge the configure when committing
991 the new content (see ack_configure).
993 It is up to the compositor to decide how and where to maximize the
994 surface, for example which output and what region of the screen should
995 be used.
997 If the surface was already maximized, the compositor will still emit
998 a configure event with the "maximized" state.
1000 If the surface is in a fullscreen state, this request has no direct
1001 effect. It may alter the state the surface is returned to when
1002 unmaximized unless overridden by the compositor.
1003 </description>
1004 </request>
1006 <request name="unset_maximized">
1007 <description summary="unmaximize the window">
1008 Unmaximize the surface.
1010 After requesting that the surface should be unmaximized, the compositor
1011 will respond by emitting a configure event. Whether this actually
1012 un-maximizes the window is subject to compositor policies.
1013 If available and applicable, the compositor will include the window
1014 geometry dimensions the window had prior to being maximized in the
1015 configure event. The client must then update its content, drawing it in
1016 the configured state. The client must also acknowledge the configure
1017 when committing the new content (see ack_configure).
1019 It is up to the compositor to position the surface after it was
1020 unmaximized; usually the position the surface had before maximizing, if
1021 applicable.
1023 If the surface was already not maximized, the compositor will still
1024 emit a configure event without the "maximized" state.
1026 If the surface is in a fullscreen state, this request has no direct
1027 effect. It may alter the state the surface is returned to when
1028 unmaximized unless overridden by the compositor.
1029 </description>
1030 </request>
1032 <request name="set_fullscreen">
1033 <description summary="set the window as fullscreen on an output">
1034 Make the surface fullscreen.
1036 After requesting that the surface should be fullscreened, the
1037 compositor will respond by emitting a configure event. Whether the
1038 client is actually put into a fullscreen state is subject to compositor
1039 policies. The client must also acknowledge the configure when
1040 committing the new content (see ack_configure).
1042 The output passed by the request indicates the client's preference as
1043 to which display it should be set fullscreen on. If this value is NULL,
1044 it's up to the compositor to choose which display will be used to map
1045 this surface.
1047 If the surface doesn't cover the whole output, the compositor will
1048 position the surface in the center of the output and compensate with
1049 with border fill covering the rest of the output. The content of the
1050 border fill is undefined, but should be assumed to be in some way that
1051 attempts to blend into the surrounding area (e.g. solid black).
1053 If the fullscreened surface is not opaque, the compositor must make
1054 sure that other screen content not part of the same surface tree (made
1055 up of subsurfaces, popups or similarly coupled surfaces) are not
1056 visible below the fullscreened surface.
1057 </description>
1058 <arg name="output" type="object" interface="wl_output" allow-null="true"/>
1059 </request>
1061 <request name="unset_fullscreen">
1062 <description summary="unset the window as fullscreen">
1063 Make the surface no longer fullscreen.
1065 After requesting that the surface should be unfullscreened, the
1066 compositor will respond by emitting a configure event.
1067 Whether this actually removes the fullscreen state of the client is
1068 subject to compositor policies.
1070 Making a surface unfullscreen sets states for the surface based on the following:
1071 * the state(s) it may have had before becoming fullscreen
1072 * any state(s) decided by the compositor
1073 * any state(s) requested by the client while the surface was fullscreen
1075 The compositor may include the previous window geometry dimensions in
1076 the configure event, if applicable.
1078 The client must also acknowledge the configure when committing the new
1079 content (see ack_configure).
1080 </description>
1081 </request>
1083 <request name="set_minimized">
1084 <description summary="set the window as minimized">
1085 Request that the compositor minimize your surface. There is no
1086 way to know if the surface is currently minimized, nor is there
1087 any way to unset minimization on this surface.
1089 If you are looking to throttle redrawing when minimized, please
1090 instead use the wl_surface.frame event for this, as this will
1091 also work with live previews on windows in Alt-Tab, Expose or
1092 similar compositor features.
1093 </description>
1094 </request>
1096 <event name="configure">
1097 <description summary="suggest a surface change">
1098 This configure event asks the client to resize its toplevel surface or
1099 to change its state. The configured state should not be applied
1100 immediately. See xdg_surface.configure for details.
1102 The width and height arguments specify a hint to the window
1103 about how its surface should be resized in window geometry
1104 coordinates. See set_window_geometry.
1106 If the width or height arguments are zero, it means the client
1107 should decide its own window dimension. This may happen when the
1108 compositor needs to configure the state of the surface but doesn't
1109 have any information about any previous or expected dimension.
1111 The states listed in the event specify how the width/height
1112 arguments should be interpreted, and possibly how it should be
1113 drawn.
1115 Clients must send an ack_configure in response to this event. See
1116 xdg_surface.configure and xdg_surface.ack_configure for details.
1117 </description>
1118 <arg name="width" type="int"/>
1119 <arg name="height" type="int"/>
1120 <arg name="states" type="array"/>
1121 </event>
1123 <event name="close">
1124 <description summary="surface wants to be closed">
1125 The close event is sent by the compositor when the user
1126 wants the surface to be closed. This should be equivalent to
1127 the user clicking the close button in client-side decorations,
1128 if your application has any.
1130 This is only a request that the user intends to close the
1131 window. The client may choose to ignore this request, or show
1132 a dialog to ask the user to save their data, etc.
1133 </description>
1134 </event>
1136 <!-- Version 4 additions -->
1138 <event name="configure_bounds" since="4">
1139 <description summary="recommended window geometry bounds">
1140 The configure_bounds event may be sent prior to a xdg_toplevel.configure
1141 event to communicate the bounds a window geometry size is recommended
1142 to constrain to.
1144 The passed width and height are in surface coordinate space. If width
1145 and height are 0, it means bounds is unknown and equivalent to as if no
1146 configure_bounds event was ever sent for this surface.
1148 The bounds can for example correspond to the size of a monitor excluding
1149 any panels or other shell components, so that a surface isn't created in
1150 a way that it cannot fit.
1152 The bounds may change at any point, and in such a case, a new
1153 xdg_toplevel.configure_bounds will be sent, followed by
1154 xdg_toplevel.configure and xdg_surface.configure.
1155 </description>
1156 <arg name="width" type="int"/>
1157 <arg name="height" type="int"/>
1158 </event>
1160 <!-- Version 5 additions -->
1162 <enum name="wm_capabilities" since="5">
1163 <entry name="window_menu" value="1" summary="show_window_menu is available"/>
1164 <entry name="maximize" value="2" summary="set_maximized and unset_maximized are available"/>
1165 <entry name="fullscreen" value="3" summary="set_fullscreen and unset_fullscreen are available"/>
1166 <entry name="minimize" value="4" summary="set_minimized is available"/>
1167 </enum>
1169 <event name="wm_capabilities" since="5">
1170 <description summary="compositor capabilities">
1171 This event advertises the capabilities supported by the compositor. If
1172 a capability isn't supported, clients should hide or disable the UI
1173 elements that expose this functionality. For instance, if the
1174 compositor doesn't advertise support for minimized toplevels, a button
1175 triggering the set_minimized request should not be displayed.
1177 The compositor will ignore requests it doesn't support. For instance,
1178 a compositor which doesn't advertise support for minimized will ignore
1179 set_minimized requests.
1181 Compositors must send this event once before the first
1182 xdg_surface.configure event. When the capabilities change, compositors
1183 must send this event again and then send an xdg_surface.configure
1184 event.
1186 The configured state should not be applied immediately. See
1187 xdg_surface.configure for details.
1189 The capabilities are sent as an array of 32-bit unsigned integers in
1190 native endianness.
1191 </description>
1192 <arg name="capabilities" type="array" summary="array of 32-bit capabilities"/>
1193 </event>
1194 </interface>
1196 <interface name="xdg_popup" version="6">
1197 <description summary="short-lived, popup surfaces for menus">
1198 A popup surface is a short-lived, temporary surface. It can be used to
1199 implement for example menus, popovers, tooltips and other similar user
1200 interface concepts.
1202 A popup can be made to take an explicit grab. See xdg_popup.grab for
1203 details.
1205 When the popup is dismissed, a popup_done event will be sent out, and at
1206 the same time the surface will be unmapped. See the xdg_popup.popup_done
1207 event for details.
1209 Explicitly destroying the xdg_popup object will also dismiss the popup and
1210 unmap the surface. Clients that want to dismiss the popup when another
1211 surface of their own is clicked should dismiss the popup using the destroy
1212 request.
1214 A newly created xdg_popup will be stacked on top of all previously created
1215 xdg_popup surfaces associated with the same xdg_toplevel.
1217 The parent of an xdg_popup must be mapped (see the xdg_surface
1218 description) before the xdg_popup itself.
1220 The client must call wl_surface.commit on the corresponding wl_surface
1221 for the xdg_popup state to take effect.
1222 </description>
1224 <enum name="error">
1225 <entry name="invalid_grab" value="0"
1226 summary="tried to grab after being mapped"/>
1227 </enum>
1229 <request name="destroy" type="destructor">
1230 <description summary="remove xdg_popup interface">
1231 This destroys the popup. Explicitly destroying the xdg_popup
1232 object will also dismiss the popup, and unmap the surface.
1234 If this xdg_popup is not the "topmost" popup, the
1235 xdg_wm_base.not_the_topmost_popup protocol error will be sent.
1236 </description>
1237 </request>
1239 <request name="grab">
1240 <description summary="make the popup take an explicit grab">
1241 This request makes the created popup take an explicit grab. An explicit
1242 grab will be dismissed when the user dismisses the popup, or when the
1243 client destroys the xdg_popup. This can be done by the user clicking
1244 outside the surface, using the keyboard, or even locking the screen
1245 through closing the lid or a timeout.
1247 If the compositor denies the grab, the popup will be immediately
1248 dismissed.
1250 This request must be used in response to some sort of user action like a
1251 button press, key press, or touch down event. The serial number of the
1252 event should be passed as 'serial'.
1254 The parent of a grabbing popup must either be an xdg_toplevel surface or
1255 another xdg_popup with an explicit grab. If the parent is another
1256 xdg_popup it means that the popups are nested, with this popup now being
1257 the topmost popup.
1259 Nested popups must be destroyed in the reverse order they were created
1260 in, e.g. the only popup you are allowed to destroy at all times is the
1261 topmost one.
1263 When compositors choose to dismiss a popup, they may dismiss every
1264 nested grabbing popup as well. When a compositor dismisses popups, it
1265 will follow the same dismissing order as required from the client.
1267 If the topmost grabbing popup is destroyed, the grab will be returned to
1268 the parent of the popup, if that parent previously had an explicit grab.
1270 If the parent is a grabbing popup which has already been dismissed, this
1271 popup will be immediately dismissed. If the parent is a popup that did
1272 not take an explicit grab, an error will be raised.
1274 During a popup grab, the client owning the grab will receive pointer
1275 and touch events for all their surfaces as normal (similar to an
1276 "owner-events" grab in X11 parlance), while the top most grabbing popup
1277 will always have keyboard focus.
1278 </description>
1279 <arg name="seat" type="object" interface="wl_seat"
1280 summary="the wl_seat of the user event"/>
1281 <arg name="serial" type="uint" summary="the serial of the user event"/>
1282 </request>
1284 <event name="configure">
1285 <description summary="configure the popup surface">
1286 This event asks the popup surface to configure itself given the
1287 configuration. The configured state should not be applied immediately.
1288 See xdg_surface.configure for details.
1290 The x and y arguments represent the position the popup was placed at
1291 given the xdg_positioner rule, relative to the upper left corner of the
1292 window geometry of the parent surface.
1294 For version 2 or older, the configure event for an xdg_popup is only
1295 ever sent once for the initial configuration. Starting with version 3,
1296 it may be sent again if the popup is setup with an xdg_positioner with
1297 set_reactive requested, or in response to xdg_popup.reposition requests.
1298 </description>
1299 <arg name="x" type="int"
1300 summary="x position relative to parent surface window geometry"/>
1301 <arg name="y" type="int"
1302 summary="y position relative to parent surface window geometry"/>
1303 <arg name="width" type="int" summary="window geometry width"/>
1304 <arg name="height" type="int" summary="window geometry height"/>
1305 </event>
1307 <event name="popup_done">
1308 <description summary="popup interaction is done">
1309 The popup_done event is sent out when a popup is dismissed by the
1310 compositor. The client should destroy the xdg_popup object at this
1311 point.
1312 </description>
1313 </event>
1315 <!-- Version 3 additions -->
1317 <request name="reposition" since="3">
1318 <description summary="recalculate the popup's location">
1319 Reposition an already-mapped popup. The popup will be placed given the
1320 details in the passed xdg_positioner object, and a
1321 xdg_popup.repositioned followed by xdg_popup.configure and
1322 xdg_surface.configure will be emitted in response. Any parameters set
1323 by the previous positioner will be discarded.
1325 The passed token will be sent in the corresponding
1326 xdg_popup.repositioned event. The new popup position will not take
1327 effect until the corresponding configure event is acknowledged by the
1328 client. See xdg_popup.repositioned for details. The token itself is
1329 opaque, and has no other special meaning.
1331 If multiple reposition requests are sent, the compositor may skip all
1332 but the last one.
1334 If the popup is repositioned in response to a configure event for its
1335 parent, the client should send an xdg_positioner.set_parent_configure
1336 and possibly an xdg_positioner.set_parent_size request to allow the
1337 compositor to properly constrain the popup.
1339 If the popup is repositioned together with a parent that is being
1340 resized, but not in response to a configure event, the client should
1341 send an xdg_positioner.set_parent_size request.
1342 </description>
1343 <arg name="positioner" type="object" interface="xdg_positioner"/>
1344 <arg name="token" type="uint" summary="reposition request token"/>
1345 </request>
1347 <event name="repositioned" since="3">
1348 <description summary="signal the completion of a repositioned request">
1349 The repositioned event is sent as part of a popup configuration
1350 sequence, together with xdg_popup.configure and lastly
1351 xdg_surface.configure to notify the completion of a reposition request.
1353 The repositioned event is to notify about the completion of a
1354 xdg_popup.reposition request. The token argument is the token passed
1355 in the xdg_popup.reposition request.
1357 Immediately after this event is emitted, xdg_popup.configure and
1358 xdg_surface.configure will be sent with the updated size and position,
1359 as well as a new configure serial.
1361 The client should optionally update the content of the popup, but must
1362 acknowledge the new popup configuration for the new position to take
1363 effect. See xdg_surface.ack_configure for details.
1364 </description>
1365 <arg name="token" type="uint" summary="reposition request token"/>
1366 </event>
1368 </interface>
1369</protocol>
index : raylib-jai
---