Lines Matching full:the
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:
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
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,
26 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
29 DEALINGS IN THE SOFTWARE.
34 The xdg_wm_base interface is exposed as a global object enabling clients
36 defines the basic functionality needed for clients and the compositor to
46 summary="the client tried to map or destroy a non-topmost popup"/>
48 summary="the client specified an invalid popup parent surface"/>
50 summary="the client provided an invalid surface state"/>
52 summary="the client provided an invalid positioner"/>
68 surfaces relative to some parent surface. See the interface description
76 This creates an xdg_surface for the given surface. While xdg_surface
77 itself is not a role, the corresponding surface may only be assigned
80 This creates an xdg_surface for the given surface. An xdg_surface is
85 See the documentation of xdg_surface for more details about what an
95 the client may be deemed unresponsive. See xdg_wm_base.ping.
97 <arg name="serial" type="uint" summary="serial of the ping event"/>
101 <description summary="check if the client is alive">
102 The ping event asks the client if it's still alive. Pass the
103 serial specified in the event back to the compositor by sending
104 a "pong" request back with the specified serial. See xdg_wm_base.pong.
106 Compositors can use this to determine if the client is still
107 alive. It's unspecified what will happen if the client doesn't
108 respond to the ping request, or in what timeframe. Clients should
114 <arg name="serial" type="uint" summary="pass this to the pong request"/>
120 The xdg_positioner provides a collection of rules for the placement of a
122 the child surface remains within the visible area's borders, and to
123 specify how the child surface changes its position, such as sliding along
125 constrained by the requirement that a child surface must intersect with or
128 See the various requests for details about possible rules.
130 At the time of the request, the compositor makes a copy of the rules
131 specified by the xdg_positioner. Thus, after the request is complete the
132 xdg_positioner object can be destroyed or reused; further changes to the
146 <description summary="destroy the xdg_positioner object">
147 Notify the compositor that the xdg_positioner will no longer be used.
152 <description summary="set the size of the to-be positioned rectangle">
153 Set the size of the surface that is to be positioned with the positioner
154 object. The size is in surface-local coordinates and corresponds to the
157 If a zero or negative size is set the invalid_input error is raised.
164 <description summary="set the anchor rectangle within the parent surface">
165 Specify the anchor rectangle within the parent surface that the child
166 surface will be placed relative to. The rectangle is relative to the
167 window geometry as defined by xdg_surface.set_window_geometry of the
170 When the xdg_positioner object is used to position a child surface, the
171 anchor rectangle may not extend outside the window geometry of the
174 If a negative size is set the invalid_input error is raised.
196 Defines the anchor point for the anchor rectangle. The specified anchor
197 is used derive an anchor point that the child surface will be
199 'bottom_right'), the anchor point will be at the specified corner;
200 otherwise, the derived anchor point will be centered on the specified
201 edge, or in the center of the anchor rectangle if no edge is specified.
222 the anchor point of the parent surface. If a corner gravity is
223 specified (e.g. 'bottom_right' or 'top_left'), then the child surface
224 will be placed towards the specified gravity; otherwise, the child
225 surface will be centered over the anchor point on any axis that had no
234 The constraint adjustment value define ways the compositor will adjust
235 the position of the surface, if the unadjusted position would result
236 in the surface being partly constrained.
238 Whether a surface is considered 'constrained' is left to the compositor
239 to determine. For example, the surface may be partly outside the
240 compositor's defined 'work area', thus necessitating the child surface's
241 position be adjusted until it is entirely inside the work area.
243 The adjustments can be combined, according to a defined precedence: 1)
247 <description summary="don't move the child surface when constrained">
248 Don't alter the surface position even if it is constrained on some
249 axis, for example partially outside the edge of an output.
253 <description summary="move along the x axis until unconstrained">
254 Slide the surface along the x axis until it is no longer constrained.
256 First try to slide towards the direction of the gravity on the x axis
257 until either the edge in the opposite direction of the gravity is
258 unconstrained or the edge in the direction of the gravity is
261 Then try to slide towards the opposite direction of the gravity on the
262 x axis until either the edge in the direction of the gravity is
263 unconstrained or the edge in the opposite direction of the gravity is
268 <description summary="move along the y axis until unconstrained">
269 Slide the surface along the y axis until it is no longer constrained.
271 First try to slide towards the direction of the gravity on the y axis
272 until either the edge in the opposite direction of the gravity is
273 unconstrained or the edge in the direction of the gravity is
276 Then try to slide towards the opposite direction of the gravity on the
277 y axis until either the edge in the direction of the gravity is
278 unconstrained or the edge in the opposite direction of the gravity is
283 <description summary="invert the anchor and gravity on the x axis">
284 Invert the anchor and gravity on the x axis if the surface is
285 constrained on the x axis. For example, if the left edge of the
286 surface is constrained, the gravity is 'left' and the anchor is
287 'left', change the gravity to 'right' and the anchor to 'right'.
289 If the adjusted position also ends up being constrained, the resulting
290 position of the flip_x adjustment will be the one before the
295 <description summary="invert the anchor and gravity on the y axis">
296 Invert the anchor and gravity on the y axis if the surface is
297 constrained on the y axis. For example, if the bottom edge of the
298 surface is constrained, the gravity is 'bottom' and the anchor is
299 'bottom', change the gravity to 'top' and the anchor to 'top'.
301 The adjusted position is calculated given the original anchor
302 rectangle and offset, but with the new flipped anchor and gravity
305 If the adjusted position also ends up being constrained, the resulting
306 position of the flip_y adjustment will be the one before the
311 <description summary="horizontally resize the surface">
312 Resize the surface horizontally so that it is completely
317 <description summary="vertically resize the surface">
318 Resize the surface vertically so that it is completely unconstrained.
324 <description summary="set the adjustment to be done when constrained">
325 Specify how the window should be positioned if the originally intended
326 position caused the surface to be constrained, meaning at least
327 partially outside positioning boundaries set by the compositor. The
328 adjustment is set by constructing a bitmask describing the adjustment to
329 be made when the surface is constrained on that axis.
331 If no bit for one axis is set, the compositor will assume that the child
334 If more than one bit for one axis is set, the order of how adjustments
335 are applied is specified in the corresponding adjustment descriptions.
337 The default adjustment is none.
345 Specify the surface position offset relative to the position of the
346 anchor on the anchor rectangle and the anchor on the surface. For
347 example if the anchor of the anchor rectangle is at (x, y), the surface
348 has the gravity bottom|right, and the offset is (ox, oy), the calculated
349 surface position will be (x + ox, y + oy). The offset position of the
350 surface is the one used for constraint testing. See
354 element, while aligning the user interface element of the parent surface
355 with some user interface element placed somewhere in the popup surface.
364 <description summary="continuously reconstrain the surface">
365 When set reactive, the surface is reconstrained if the conditions used
366 for constraining changed, e.g. the parent window moved.
368 If the conditions changed and the popup was reconstrained, an
376 Set the parent window geometry the compositor should use when
377 positioning the popup. The compositor may use this information to
378 determine the future state the popup should be constrained using. If
379 this doesn't match the dimension of the parent the popup is eventually
380 positioned against, the behavior is undefined.
382 The arguments are given in the surface-local coordinate space.
392 Set the serial of an xdg_surface.configure event this positioner will be
393 used in response to. The compositor may use this information together
394 with set_parent_size to determine what future state the popup should be
408 interface elements requiring management by the compositor, such as
409 toplevel windows, menus, etc. The types of functionality are split into
412 Creating an xdg_surface does not set the role for a wl_surface. In order
413 to map an xdg_surface, the client must create a role-specific object
414 using, e.g., get_toplevel, get_popup. The wl_surface for any given
418 A role must be assigned before any other requests are made to the
421 The client must call wl_surface.commit on the corresponding wl_surface
422 for the xdg_surface state to take effect.
426 manipulate a buffer prior to the first xdg_surface.configure call must
429 After creating a role-specific object and setting it up, the client must
430 perform an initial commit without any buffer attached. The compositor
431 will reply with an xdg_surface.configure event. The client must
432 acknowledge it and is then allowed to attach a buffer to map the surface.
435 possible for the surface to be shown by the compositor. Note that
438 For an xdg_surface to be mapped by the compositor, the following
440 (1) the client has assigned an xdg_surface-based role to the surface
441 (2) the client has set and committed the xdg_surface state and the
442 role-dependent state to the surface
443 (3) the client has committed a buffer to the surface
446 of the 3 required conditions for mapping a surface if its role surface
457 <description summary="destroy the xdg_surface">
458 Destroy the xdg_surface object. An xdg_surface must only be destroyed
464 <description summary="assign the xdg_toplevel surface role">
465 This creates an xdg_toplevel object for the given xdg_surface and gives
466 the associated wl_surface the xdg_toplevel role.
468 See the documentation of xdg_toplevel for more details about what an
475 <description summary="assign the xdg_popup surface role">
476 This creates an xdg_popup object for the given xdg_surface and gives
477 the associated wl_surface the xdg_popup role.
480 some other protocol, before committing the initial state.
482 See the documentation of xdg_popup for more details about what an
491 <description summary="set the new window geometry">
492 The window geometry of a surface is its "visible bounds" from the
494 portions like drop-shadows which should be ignored for the
497 The window geometry is double buffered, and will be applied at the
498 time wl_surface.commit of the corresponding wl_surface is called.
500 When maintaining a position, the compositor should treat the (x, y)
501 coordinate of the window geometry as the top left corner of the window.
502 A client changing the (x, y) window geometry coordinate should in
503 general not alter the position of the window.
505 Once the window geometry of the surface is set, it is not possible to
506 unset it, and it will remain the same until set_window_geometry is
509 If never set, the value is the full bounds of the surface,
513 The arguments are given in the surface-local coordinate space of
514 the wl_surface associated with this xdg_surface.
516 The width and height must be greater than zero. Setting an invalid size
517 will raise an error. When applied, the effective window geometry will be
518 the set window geometry clamped to the bounding rectangle of the
519 combined geometry of the surface of the xdg_surface and the associated
530 When a configure event is received, if a client commits the
531 surface in response to the configure event, then the client
532 must make an ack_configure request sometime before the commit
533 request, passing along the serial of the configure event.
535 For instance, for toplevel surfaces the compositor might use this
536 information to move a surface to the top left only when the client has
537 drawn itself for the maximized or fullscreen state.
539 If the client receives multiple configure events before it
540 can respond to one, it only has to ack the last configure event.
547 only the last request sent before a commit indicates which configure
548 event the client really is responding to.
550 <arg name="serial" type="uint" summary="the serial from the configure event"/>
555 The configure event marks the end of a configure sequence. A configure
556 sequence is a set of one or more events configuring the state of the
557 xdg_surface, including the final xdg_surface.configure event.
560 sequence extend this event as a latched state sent as events before the
562 a set of atomically applied configuration states, where the
563 xdg_surface.configure commits the accumulated state.
565 Clients should arrange their surface for the new states, and then send
566 an ack_configure request with the serial sent in this configure event at
567 some point before committing the new surface.
569 If the client receives multiple configure events before it can respond
570 to one, it is free to discard all but the last event it received.
572 <arg name="serial" type="uint" summary="serial of the configure event"/>
585 Unmapping an xdg_toplevel means that the surface cannot be shown
586 by the compositor until it is explicitly mapped again.
589 an xdg_toplevel surface when it is unmapped. The xdg_toplevel returns to
590 the state it had right after xdg_surface.get_toplevel. The client
591 can re-map the toplevel by perfoming a commit without any buffer
595 Attaching a null buffer to a toplevel unmaps the surface.
599 <description summary="destroy the xdg_toplevel">
600 This request destroys the role surface and unmaps the surface;
606 <description summary="set the parent of this surface">
607 Set the "parent" of this surface. This surface should be stacked
608 above the parent surface and all other ancestor surfaces.
611 "auxiliary" surfaces, so that the parent is raised when the dialog
615 relationship for the child. Setting a null parent for a window which
618 If the parent is unmapped then its children are managed as
619 though the parent of the now-unmapped parent has become the
620 parent of this surface. If no parent exists for the now-unmapped
621 parent then the children are managed as though they have no
629 Set a short title for the surface.
631 This string may be used to identify the surface in a task bar,
632 window list, or other user interface elements provided by the
635 The string must be encoded in UTF-8.
642 Set an application identifier for the surface.
644 The app ID identifies the general class of applications to which
645 the surface belongs. The compositor can use this to group multiple
648 For D-Bus activatable applications, the app ID is used as the D-Bus
651 The compositor shell will try to group application surfaces together
653 ID's that match the basename of the application's .desktop file.
654 For example, "org.freedesktop.FooViewer" where the .desktop file is
657 Like other properties, a set_app_id request can be sent after the
658 xdg_toplevel has been mapped to update the property.
660 See the desktop-entry specification [0] for more details on
670 <description summary="show the window menu">
672 a context menu when right-clicking on the decorations, giving the
673 user a menu that they can use to maximize or minimize the window.
675 This request asks the compositor to pop up such a window menu at
676 the given position, relative to the local surface coordinates of
677 the parent surface. There are no guarantees as to what menu items
678 the window menu contains.
683 <arg name="seat" type="object" interface="wl_seat" summary="the wl_seat of the user event"/>
684 <arg name="serial" type="uint" summary="the serial of the user event"/>
685 <arg name="x" type="int" summary="the x position to pop up the window menu at"/>
686 <arg name="y" type="int" summary="the y position to pop up the window menu at"/>
691 Start an interactive, user-driven move of the surface.
694 like a button press, key press, or touch down event. The passed
695 serial is used to determine the type of interactive move (touch,
698 The server may ignore move requests depending on the state of
699 the surface (e.g. fullscreen or maximized), or if the passed serial
702 If triggered, the surface will lose the focus of the device
703 (wl_pointer, wl_touch, etc) used for the move. It is up to the
704 compositor to visually indicate that the move is taking place, such as
705 updating a pointer cursor, during the move. There is no guarantee
706 that the device focus will return when the move is completed.
708 <arg name="seat" type="object" interface="wl_seat" summary="the wl_seat of the user event"/>
709 <arg name="serial" type="uint" summary="the serial of the user event"/>
730 Start a user-driven, interactive resize of the surface.
733 like a button press, key press, or touch down event. The passed
734 serial is used to determine the type of interactive resize (touch,
737 The server may ignore resize requests depending on the state of
738 the surface (e.g. fullscreen or maximized).
740 If triggered, the client will receive configure events with the
741 "resize" state enum value and the expected sizes. See the "resize"
742 enum value for more details about what is required. The client
744 the resize is completed, the client will receive another "configure"
745 event without the resize state.
747 If triggered, the surface also will lose the focus of the device
748 (wl_pointer, wl_touch, etc) used for the resize. It is up to the
749 compositor to visually indicate that the resize is taking place,
750 such as updating a pointer cursor, during the resize. There is no
751 guarantee that the device focus will return when the resize is
754 The edges parameter specifies how the surface should be resized,
755 and is one of the values of the resize_edge enum. The compositor
756 may use this information to update the surface position for
757 example when dragging the top left corner. The compositor may also
761 <arg name="seat" type="object" interface="wl_seat" summary="the wl_seat of the user event"/>
762 <arg name="serial" type="uint" summary="the serial of the user event"/>
767 <description summary="types of state on the surface">
768 The different state values used on the surface. This is designed for
769 state values like maximized, fullscreen. It is paired with the
770 configure event to ensure that both the client and the compositor
771 setting the state can be synchronized.
774 the next commit.
776 <entry name="maximized" value="1" summary="the surface is maximized">
777 <description summary="the surface is maximized">
778 The surface is maximized. The window geometry specified in the configure
779 event must be obeyed by the client.
781 The client should draw without shadow or other
782 decoration outside of the window geometry.
785 <entry name="fullscreen" value="2" summary="the surface is fullscreen">
786 <description summary="the surface is fullscreen">
787 The surface is fullscreen. The window geometry specified in the
788 configure event is a maximum; the client cannot resize beyond it. For
789 a surface to cover the whole fullscreened area, the geometry
790 dimensions must be obeyed by the client. For more details, see
794 <entry name="resizing" value="3" summary="the surface is being resized">
795 <description summary="the surface is being resized">
796 The surface is being resized. The window geometry specified in the
797 configure event is a maximum; the client cannot resize beyond it.
802 <entry name="activated" value="4" summary="the surface is now activated">
803 <description summary="the surface is now activated">
804 Client window decorations should be painted as if the window is
805 active. Do not assume this means that the window actually has
810 <description summary="the surface is tiled">
811 The window is currently in a tiled layout and the left edge is
812 considered to be adjacent to another part of the tiling grid.
816 <description summary="the surface is tiled">
817 The window is currently in a tiled layout and the right edge is
818 considered to be adjacent to another part of the tiling grid.
822 <description summary="the surface is tiled">
823 The window is currently in a tiled layout and the top edge is
824 considered to be adjacent to another part of the tiling grid.
828 <description summary="the surface is tiled">
829 The window is currently in a tiled layout and the bottom edge is
830 considered to be adjacent to another part of the tiling grid.
836 <description summary="set the maximum size">
837 Set a maximum size for the window.
839 The client can specify a maximum size so that the compositor does
840 not try to configure the window beyond this size.
842 The width and height arguments are in window geometry coordinates.
846 on the next commit.
848 The compositor can use this information to allow or disallow
855 The client should not rely on the compositor to obey the maximum
856 size. The compositor may decide to ignore the values set by the
859 If never set, or a value of zero in the request, means that the
860 client has no expected maximum size in the given dimension.
861 As a result, a client wishing to reset the maximum size
862 to an unspecified state can use zero for width and height in the
865 Requesting a maximum size to be smaller than the minimum size of
868 The width and height must be greater than or equal to zero. Using
877 <description summary="set the minimum size">
878 Set a minimum size for the window.
880 The client can specify a minimum size so that the compositor does
881 not try to configure the window below this size.
883 The width and height arguments are in window geometry coordinates.
887 on the next commit.
889 The compositor can use this information to allow or disallow
896 The client should not rely on the compositor to obey the minimum
897 size. The compositor may decide to ignore the values set by the
900 If never set, or a value of zero in the request, means that the
901 client has no expected minimum size in the given dimension.
902 As a result, a client wishing to reset the minimum size
903 to an unspecified state can use zero for width and height in the
906 Requesting a minimum size to be larger than the maximum size of
909 The width and height must be greater than or equal to zero. Using
918 <description summary="maximize the window">
919 Maximize the surface.
921 After requesting that the surface should be maximized, the compositor
923 actually sets the window maximized is subject to compositor policies.
924 The client must then update its content, drawing in the configured
925 state. The client must also acknowledge the configure when committing
926 the new content (see ack_configure).
928 It is up to the compositor to decide how and where to maximize the
929 surface, for example which output and what region of the screen should
932 If the surface was already maximized, the compositor will still emit
933 a configure event with the "maximized" state.
935 If the surface is in a fullscreen state, this request has no direct
936 effect. It may alter the state the surface is returned to when
937 unmaximized unless overridden by the compositor.
942 <description summary="unmaximize the window">
943 Unmaximize the surface.
945 After requesting that the surface should be unmaximized, the compositor
947 un-maximizes the window is subject to compositor policies.
948 If available and applicable, the compositor will include the window
949 geometry dimensions the window had prior to being maximized in the
950 configure event. The client must then update its content, drawing it in
951 the configured state. The client must also acknowledge the configure
952 when committing the new content (see ack_configure).
954 It is up to the compositor to position the surface after it was
955 unmaximized; usually the position the surface had before maximizing, if
958 If the surface was already not maximized, the compositor will still
959 emit a configure event without the "maximized" state.
961 If the surface is in a fullscreen state, this request has no direct
962 effect. It may alter the state the surface is returned to when
963 unmaximized unless overridden by the compositor.
968 <description summary="set the window as fullscreen on an output">
969 Make the surface fullscreen.
971 After requesting that the surface should be fullscreened, the
972 compositor will respond by emitting a configure event. Whether the
974 policies. The client must also acknowledge the configure when
975 committing the new content (see ack_configure).
977 The output passed by the request indicates the client's preference as
979 it's up to the compositor to choose which display will be used to map
982 If the surface doesn't cover the whole output, the compositor will
983 position the surface in the center of the output and compensate with
984 with border fill covering the rest of the output. The content of the
986 attempts to blend into the surrounding area (e.g. solid black).
988 If the fullscreened surface is not opaque, the compositor must make
989 sure that other screen content not part of the same surface tree (made
991 visible below the fullscreened surface.
997 <description summary="unset the window as fullscreen">
998 Make the surface no longer fullscreen.
1000 After requesting that the surface should be unfullscreened, the
1002 Whether this actually removes the fullscreen state of the client is
1005 Making a surface unfullscreen sets states for the surface based on the following:
1006 * the state(s) it may have had before becoming fullscreen
1007 * any state(s) decided by the compositor
1008 * any state(s) requested by the client while the surface was fullscreen
1010 The compositor may include the previous window geometry dimensions in
1011 the configure event, if applicable.
1013 The client must also acknowledge the configure when committing the new
1019 <description summary="set the window as minimized">
1020 Request that the compositor minimize your surface. There is no
1021 way to know if the surface is currently minimized, nor is there
1025 instead use the wl_surface.frame event for this, as this will
1033 This configure event asks the client to resize its toplevel surface or
1034 to change its state. The configured state should not be applied
1037 The width and height arguments specify a hint to the window
1041 If the width or height arguments are zero, it means the client
1042 should decide its own window dimension. This may happen when the
1043 compositor needs to configure the state of the surface but doesn't
1046 The states listed in the event specify how the width/height
1060 The close event is sent by the compositor when the user
1061 wants the surface to be closed. This should be equivalent to
1062 the user clicking the close button in client-side decorations,
1065 This is only a request that the user intends to close the
1066 window. The client may choose to ignore this request, or show
1067 a dialog to ask the user to save their data, etc.
1081 When the popup is dismissed, a popup_done event will be sent out, and at
1082 the same time the surface will be unmapped. See the xdg_popup.popup_done
1085 Explicitly destroying the xdg_popup object will also dismiss the popup and
1086 unmap the surface. Clients that want to dismiss the popup when another
1087 surface of their own is clicked should dismiss the popup using the destroy
1091 xdg_popup surfaces associated with the same xdg_toplevel.
1093 The parent of an xdg_popup must be mapped (see the xdg_surface
1094 description) before the xdg_popup itself.
1096 The client must call wl_surface.commit on the corresponding wl_surface
1097 for the xdg_popup state to take effect.
1107 This destroys the popup. Explicitly destroying the xdg_popup
1108 object will also dismiss the popup, and unmap the surface.
1110 If this xdg_popup is not the "topmost" popup, a protocol error
1116 <description summary="make the popup take an explicit grab">
1117 This request makes the created popup take an explicit grab. An explicit
1118 grab will be dismissed when the user dismisses the popup, or when the
1119 client destroys the xdg_popup. This can be done by the user clicking
1120 outside the surface, using the keyboard, or even locking the screen
1121 through closing the lid or a timeout.
1123 If the compositor denies the grab, the popup will be immediately
1127 button press, key press, or touch down event. The serial number of the
1130 The parent of a grabbing popup must either be an xdg_toplevel surface or
1131 another xdg_popup with an explicit grab. If the parent is another
1132 xdg_popup it means that the popups are nested, with this popup now being
1133 the topmost popup.
1135 Nested popups must be destroyed in the reverse order they were created
1136 in, e.g. the only popup you are allowed to destroy at all times is the
1141 will follow the same dismissing order as required from the client.
1143 The parent of a grabbing popup must either be another xdg_popup with an
1147 If the topmost grabbing popup is destroyed, the grab will be returned to
1148 the parent of the popup, if that parent previously had an explicit grab.
1150 If the parent is a grabbing popup which has already been dismissed, this
1151 popup will be immediately dismissed. If the parent is a popup that did
1154 During a popup grab, the client owning the grab will receive pointer
1156 "owner-events" grab in X11 parlance), while the top most grabbing popup
1160 summary="the wl_seat of the user event"/>
1161 <arg name="serial" type="uint" summary="the serial of the user event"/>
1165 <description summary="configure the popup surface">
1166 This event asks the popup surface to configure itself given the
1167 configuration. The configured state should not be applied immediately.
1170 The x and y arguments represent the position the popup was placed at
1171 given the xdg_positioner rule, relative to the upper left corner of the
1172 window geometry of the parent surface.
1174 For version 2 or older, the configure event for an xdg_popup is only
1175 ever sent once for the initial configuration. Starting with version 3,
1176 it may be sent again if the popup is setup with an xdg_positioner with
1189 The popup_done event is sent out when a popup is dismissed by the
1190 compositor. The client should destroy the xdg_popup object at this
1198 <description summary="recalculate the popup's location">
1199 Reposition an already-mapped popup. The popup will be placed given the
1200 details in the passed xdg_positioner object, and a
1203 by the previous positioner will be discarded.
1205 The passed token will be sent in the corresponding
1206 xdg_popup.repositioned event. The new popup position will not take
1207 effect until the corresponding configure event is acknowledged by the
1208 client. See xdg_popup.repositioned for details. The token itself is
1211 If multiple reposition requests are sent, the compositor may skip all
1212 but the last one.
1214 If the popup is repositioned in response to a configure event for its
1215 parent, the client should send an xdg_positioner.set_parent_configure
1216 and possibly an xdg_positioner.set_parent_size request to allow the
1217 compositor to properly constrain the popup.
1219 If the popup is repositioned together with a parent that is being
1220 resized, but not in response to a configure event, the client should
1228 <description summary="signal the completion of a repositioned request">
1229 The repositioned event is sent as part of a popup configuration
1231 xdg_surface.configure to notify the completion of a reposition request.
1233 The repositioned event is to notify about the completion of a
1234 xdg_popup.reposition request. The token argument is the token passed
1235 in the xdg_popup.reposition request.
1238 xdg_surface.configure will be sent with the updated size and position,
1241 The client should optionally update the content of the popup, but must
1242 acknowledge the new popup configuration for the new position to take