| <?xml version="1.0" encoding="UTF-8"?> |
| <protocol name="xdg_shell"> |
| |
| <copyright> |
| Copyright © 2008-2013 Kristian Høgsberg |
| Copyright © 2013 Rafael Antognolli |
| Copyright © 2013 Jasper St. Pierre |
| Copyright © 2010-2013 Intel Corporation |
| Copyright © 2015-2017 Samsung Electronics Co., Ltd |
| Copyright © 2015-2017 Red Hat Inc. |
| |
| Permission is hereby granted, free of charge, to any person obtaining a |
| copy of this software and associated documentation files (the "Software"), |
| to deal in the Software without restriction, including without limitation |
| the rights to use, copy, modify, merge, publish, distribute, sublicense, |
| and/or sell copies of the Software, and to permit persons to whom the |
| Software is furnished to do so, subject to the following conditions: |
| |
| The above copyright notice and this permission notice (including the next |
| paragraph) shall be included in all copies or substantial portions of the |
| Software. |
| |
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
| THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
| FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
| DEALINGS IN THE SOFTWARE. |
| </copyright> |
| |
| <interface name="xdg_wm_base" version="1"> |
| <description summary="create desktop-style surfaces"> |
| The xdg_wm_base interface is exposed as a global object enabling clients |
| to turn their wl_surfaces into windows in a desktop environment. It |
| defines the basic functionality needed for clients and the compositor to |
| create windows that can be dragged, resized, maximized, etc, as well as |
| creating transient windows such as popup menus. |
| </description> |
| |
| <enum name="error"> |
| <entry name="role" value="0" summary="given wl_surface has another role"/> |
| <entry name="defunct_surfaces" value="1" |
| summary="xdg_wm_base was destroyed before children"/> |
| <entry name="not_the_topmost_popup" value="2" |
| summary="the client tried to map or destroy a non-topmost popup"/> |
| <entry name="invalid_popup_parent" value="3" |
| summary="the client specified an invalid popup parent surface"/> |
| <entry name="invalid_surface_state" value="4" |
| summary="the client provided an invalid surface state"/> |
| <entry name="invalid_positioner" value="5" |
| summary="the client provided an invalid positioner"/> |
| </enum> |
| |
| <request name="destroy" type="destructor"> |
| <description summary="destroy xdg_wm_base"> |
| Destroy this xdg_wm_base object. |
| |
| Destroying a bound xdg_wm_base object while there are surfaces |
| still alive created by this xdg_wm_base object instance is illegal |
| and will result in a protocol error. |
| </description> |
| </request> |
| |
| <request name="create_positioner"> |
| <description summary="create a positioner object"> |
| Create a positioner object. A positioner object is used to position |
| surfaces relative to some parent surface. See the interface description |
| and xdg_surface.get_popup for details. |
| </description> |
| <arg name="id" type="new_id" interface="xdg_positioner"/> |
| </request> |
| |
| <request name="get_xdg_surface"> |
| <description summary="create a shell surface from a surface"> |
| This creates an xdg_surface for the given surface. While xdg_surface |
| itself is not a role, the corresponding surface may only be assigned |
| a role extending xdg_surface, such as xdg_toplevel or xdg_popup. |
| |
| This creates an xdg_surface for the given surface. An xdg_surface is |
| used as basis to define a role to a given surface, such as xdg_toplevel |
| or xdg_popup. It also manages functionality shared between xdg_surface |
| based surface roles. |
| |
| See the documentation of xdg_surface for more details about what an |
| xdg_surface is and how it is used. |
| </description> |
| <arg name="id" type="new_id" interface="xdg_surface"/> |
| <arg name="surface" type="object" interface="wl_surface"/> |
| </request> |
| |
| <request name="pong"> |
| <description summary="respond to a ping event"> |
| A client must respond to a ping event with a pong request or |
| the client may be deemed unresponsive. See xdg_wm_base.ping. |
| </description> |
| <arg name="serial" type="uint" summary="serial of the ping event"/> |
| </request> |
| |
| <event name="ping"> |
| <description summary="check if the client is alive"> |
| The ping event asks the client if it's still alive. Pass the |
| serial specified in the event back to the compositor by sending |
| a "pong" request back with the specified serial. See xdg_wm_base.ping. |
| |
| Compositors can use this to determine if the client is still |
| alive. It's unspecified what will happen if the client doesn't |
| respond to the ping request, or in what timeframe. Clients should |
| try to respond in a reasonable amount of time. |
| |
| A compositor is free to ping in any way it wants, but a client must |
| always respond to any xdg_wm_base object it created. |
| </description> |
| <arg name="serial" type="uint" summary="pass this to the pong request"/> |
| </event> |
| </interface> |
| |
| <interface name="xdg_positioner" version="1"> |
| <description summary="child surface positioner"> |
| The xdg_positioner provides a collection of rules for the placement of a |
| child surface relative to a parent surface. Rules can be defined to ensure |
| the child surface remains within the visible area's borders, and to |
| specify how the child surface changes its position, such as sliding along |
| an axis, or flipping around a rectangle. These positioner-created rules are |
| constrained by the requirement that a child surface must intersect with or |
| be at least partially adjacent to its parent surface. |
| |
| See the various requests for details about possible rules. |
| |
| At the time of the request, the compositor makes a copy of the rules |
| specified by the xdg_positioner. Thus, after the request is complete the |
| xdg_positioner object can be destroyed or reused; further changes to the |
| object will have no effect on previous usages. |
| |
| For an xdg_positioner object to be considered complete, it must have a |
| non-zero size set by set_size, and a non-zero anchor rectangle set by |
| set_anchor_rect. Passing an incomplete xdg_positioner object when |
| positioning a surface raises an error. |
| </description> |
| |
| <enum name="error"> |
| <entry name="invalid_input" value="0" summary="invalid input provided"/> |
| </enum> |
| |
| <request name="destroy" type="destructor"> |
| <description summary="destroy the xdg_positioner object"> |
| Notify the compositor that the xdg_positioner will no longer be used. |
| </description> |
| </request> |
| |
| <request name="set_size"> |
| <description summary="set the size of the to-be positioned rectangle"> |
| Set the size of the surface that is to be positioned with the positioner |
| object. The size is in surface-local coordinates and corresponds to the |
| window geometry. See xdg_surface.set_window_geometry. |
| |
| If a zero or negative size is set the invalid_input error is raised. |
| </description> |
| <arg name="width" type="int" summary="width of positioned rectangle"/> |
| <arg name="height" type="int" summary="height of positioned rectangle"/> |
| </request> |
| |
| <request name="set_anchor_rect"> |
| <description summary="set the anchor rectangle within the parent surface"> |
| Specify the anchor rectangle within the parent surface that the child |
| surface will be placed relative to. The rectangle is relative to the |
| window geometry as defined by xdg_surface.set_window_geometry of the |
| parent surface. |
| |
| When the xdg_positioner object is used to position a child surface, the |
| anchor rectangle may not extend outside the window geometry of the |
| positioned child's parent surface. |
| |
| If a negative size is set the invalid_input error is raised. |
| </description> |
| <arg name="x" type="int" summary="x position of anchor rectangle"/> |
| <arg name="y" type="int" summary="y position of anchor rectangle"/> |
| <arg name="width" type="int" summary="width of anchor rectangle"/> |
| <arg name="height" type="int" summary="height of anchor rectangle"/> |
| </request> |
| |
| <enum name="anchor"> |
| <entry name="none" value="0"/> |
| <entry name="top" value="1"/> |
| <entry name="bottom" value="2"/> |
| <entry name="left" value="3"/> |
| <entry name="right" value="4"/> |
| <entry name="top_left" value="5"/> |
| <entry name="bottom_left" value="6"/> |
| <entry name="top_right" value="7"/> |
| <entry name="bottom_right" value="8"/> |
| </enum> |
| |
| <request name="set_anchor"> |
| <description summary="set anchor rectangle anchor"> |
| Defines the anchor point for the anchor rectangle. The specified anchor |
| is used derive an anchor point that the child surface will be |
| positioned relative to. If a corner anchor is set (e.g. 'top_left' or |
| 'bottom_right'), the anchor point will be at the specified corner; |
| otherwise, the derived anchor point will be centered on the specified |
| edge, or in the center of the anchor rectangle if no edge is specified. |
| </description> |
| <arg name="anchor" type="uint" enum="anchor" |
| summary="anchor"/> |
| </request> |
| |
| <enum name="gravity"> |
| <entry name="none" value="0"/> |
| <entry name="top" value="1"/> |
| <entry name="bottom" value="2"/> |
| <entry name="left" value="3"/> |
| <entry name="right" value="4"/> |
| <entry name="top_left" value="5"/> |
| <entry name="bottom_left" value="6"/> |
| <entry name="top_right" value="7"/> |
| <entry name="bottom_right" value="8"/> |
| </enum> |
| |
| <request name="set_gravity"> |
| <description summary="set child surface gravity"> |
| Defines in what direction a surface should be positioned, relative to |
| the anchor point of the parent surface. If a corner gravity is |
| specified (e.g. 'bottom_right' or 'top_left'), then the child surface |
| will be placed towards the specified gravity; otherwise, the child |
| surface will be centered over the anchor point on any axis that had no |
| gravity specified. |
| </description> |
| <arg name="gravity" type="uint" enum="gravity" |
| summary="gravity direction"/> |
| </request> |
| |
| <enum name="constraint_adjustment" bitfield="true"> |
| <description summary="constraint adjustments"> |
| The constraint adjustment value define ways the compositor will adjust |
| the position of the surface, if the unadjusted position would result |
| in the surface being partly constrained. |
| |
| Whether a surface is considered 'constrained' is left to the compositor |
| to determine. For example, the surface may be partly outside the |
| compositor's defined 'work area', thus necessitating the child surface's |
| position be adjusted until it is entirely inside the work area. |
| |
| The adjustments can be combined, according to a defined precedence: 1) |
| Flip, 2) Slide, 3) Resize. |
| </description> |
| <entry name="none" value="0"> |
| <description summary="don't move the child surface when constrained"> |
| Don't alter the surface position even if it is constrained on some |
| axis, for example partially outside the edge of an output. |
| </description> |
| </entry> |
| <entry name="slide_x" value="1"> |
| <description summary="move along the x axis until unconstrained"> |
| Slide the surface along the x axis until it is no longer constrained. |
| |
| First try to slide towards the direction of the gravity on the x axis |
| until either the edge in the opposite direction of the gravity is |
| unconstrained or the edge in the direction of the gravity is |
| constrained. |
| |
| Then try to slide towards the opposite direction of the gravity on the |
| x axis until either the edge in the direction of the gravity is |
| unconstrained or the edge in the opposite direction of the gravity is |
| constrained. |
| </description> |
| </entry> |
| <entry name="slide_y" value="2"> |
| <description summary="move along the y axis until unconstrained"> |
| Slide the surface along the y axis until it is no longer constrained. |
| |
| First try to slide towards the direction of the gravity on the y axis |
| until either the edge in the opposite direction of the gravity is |
| unconstrained or the edge in the direction of the gravity is |
| constrained. |
| |
| Then try to slide towards the opposite direction of the gravity on the |
| y axis until either the edge in the direction of the gravity is |
| unconstrained or the edge in the opposite direction of the gravity is |
| constrained. |
| </description> |
| </entry> |
| <entry name="flip_x" value="4"> |
| <description summary="invert the anchor and gravity on the x axis"> |
| Invert the anchor and gravity on the x axis if the surface is |
| constrained on the x axis. For example, if the left edge of the |
| surface is constrained, the gravity is 'left' and the anchor is |
| 'left', change the gravity to 'right' and the anchor to 'right'. |
| |
| If the adjusted position also ends up being constrained, the resulting |
| position of the flip_x adjustment will be the one before the |
| adjustment. |
| </description> |
| </entry> |
| <entry name="flip_y" value="8"> |
| <description summary="invert the anchor and gravity on the y axis"> |
| Invert the anchor and gravity on the y axis if the surface is |
| constrained on the y axis. For example, if the bottom edge of the |
| surface is constrained, the gravity is 'bottom' and the anchor is |
| 'bottom', change the gravity to 'top' and the anchor to 'top'. |
| |
| The adjusted position is calculated given the original anchor |
| rectangle and offset, but with the new flipped anchor and gravity |
| values. |
| |
| If the adjusted position also ends up being constrained, the resulting |
| position of the flip_y adjustment will be the one before the |
| adjustment. |
| </description> |
| </entry> |
| <entry name="resize_x" value="16"> |
| <description summary="horizontally resize the surface"> |
| Resize the surface horizontally so that it is completely |
| unconstrained. |
| </description> |
| </entry> |
| <entry name="resize_y" value="32"> |
| <description summary="vertically resize the surface"> |
| Resize the surface vertically so that it is completely unconstrained. |
| </description> |
| </entry> |
| </enum> |
| |
| <request name="set_constraint_adjustment"> |
| <description summary="set the adjustment to be done when constrained"> |
| Specify how the window should be positioned if the originally intended |
| position caused the surface to be constrained, meaning at least |
| partially outside positioning boundaries set by the compositor. The |
| adjustment is set by constructing a bitmask describing the adjustment to |
| be made when the surface is constrained on that axis. |
| |
| If no bit for one axis is set, the compositor will assume that the child |
| surface should not change its position on that axis when constrained. |
| |
| If more than one bit for one axis is set, the order of how adjustments |
| are applied is specified in the corresponding adjustment descriptions. |
| |
| The default adjustment is none. |
| </description> |
| <arg name="constraint_adjustment" type="uint" |
| summary="bit mask of constraint adjustments"/> |
| </request> |
| |
| <request name="set_offset"> |
| <description summary="set surface position offset"> |
| Specify the surface position offset relative to the position of the |
| anchor on the anchor rectangle and the anchor on the surface. For |
| example if the anchor of the anchor rectangle is at (x, y), the surface |
| has the gravity bottom|right, and the offset is (ox, oy), the calculated |
| surface position will be (x + ox, y + oy). The offset position of the |
| surface is the one used for constraint testing. See |
| set_constraint_adjustment. |
| |
| An example use case is placing a popup menu on top of a user interface |
| element, while aligning the user interface element of the parent surface |
| with some user interface element placed somewhere in the popup surface. |
| </description> |
| <arg name="x" type="int" summary="surface position x offset"/> |
| <arg name="y" type="int" summary="surface position y offset"/> |
| </request> |
| </interface> |
| |
| <interface name="xdg_surface" version="1"> |
| <description summary="desktop user interface surface base interface"> |
| An interface that may be implemented by a wl_surface, for |
| implementations that provide a desktop-style user interface. |
| |
| It provides a base set of functionality required to construct user |
| interface elements requiring management by the compositor, such as |
| toplevel windows, menus, etc. The types of functionality are split into |
| xdg_surface roles. |
| |
| Creating an xdg_surface does not set the role for a wl_surface. In order |
| to map an xdg_surface, the client must create a role-specific object |
| using, e.g., get_toplevel, get_popup. The wl_surface for any given |
| xdg_surface can have at most one role, and may not be assigned any role |
| not based on xdg_surface. |
| |
| A role must be assigned before any other requests are made to the |
| xdg_surface object. |
| |
| The client must call wl_surface.commit on the corresponding wl_surface |
| for the xdg_surface state to take effect. |
| |
| Creating an xdg_surface from a wl_surface which has a buffer attached or |
| committed is a client error, and any attempts by a client to attach or |
| manipulate a buffer prior to the first xdg_surface.configure call must |
| also be treated as errors. |
| |
| Mapping an xdg_surface-based role surface is defined as making it |
| possible for the surface to be shown by the compositor. Note that |
| a mapped surface is not guaranteed to be visible once it is mapped. |
| |
| For an xdg_surface to be mapped by the compositor, the following |
| conditions must be met: |
| (1) the client has assigned an xdg_surface-based role to the surface |
| (2) the client has set and committed the xdg_surface state and the |
| role-dependent state to the surface |
| (3) the client has committed a buffer to the surface |
| |
| A newly-unmapped surface is considered to have met condition (1) out |
| of the 3 required conditions for mapping a surface if its role surface |
| has not been destroyed. |
| </description> |
| |
| <enum name="error"> |
| <entry name="not_constructed" value="1"/> |
| <entry name="already_constructed" value="2"/> |
| <entry name="unconfigured_buffer" value="3"/> |
| </enum> |
| |
| <request name="destroy" type="destructor"> |
| <description summary="destroy the xdg_surface"> |
| Destroy the xdg_surface object. An xdg_surface must only be destroyed |
| after its role object has been destroyed. |
| </description> |
| </request> |
| |
| <request name="get_toplevel"> |
| <description summary="assign the xdg_toplevel surface role"> |
| This creates an xdg_toplevel object for the given xdg_surface and gives |
| the associated wl_surface the xdg_toplevel role. |
| |
| See the documentation of xdg_toplevel for more details about what an |
| xdg_toplevel is and how it is used. |
| </description> |
| <arg name="id" type="new_id" interface="xdg_toplevel"/> |
| </request> |
| |
| <request name="get_popup"> |
| <description summary="assign the xdg_popup surface role"> |
| This creates an xdg_popup object for the given xdg_surface and gives |
| the associated wl_surface the xdg_popup role. |
| |
| If null is passed as a parent, a parent surface must be specified using |
| some other protocol, before committing the initial state. |
| |
| See the documentation of xdg_popup for more details about what an |
| xdg_popup is and how it is used. |
| </description> |
| <arg name="id" type="new_id" interface="xdg_popup"/> |
| <arg name="parent" type="object" interface="xdg_surface" allow-null="true"/> |
| <arg name="positioner" type="object" interface="xdg_positioner"/> |
| </request> |
| |
| <request name="set_window_geometry"> |
| <description summary="set the new window geometry"> |
| The window geometry of a surface is its "visible bounds" from the |
| user's perspective. Client-side decorations often have invisible |
| portions like drop-shadows which should be ignored for the |
| purposes of aligning, placing and constraining windows. |
| |
| The window geometry is double buffered, and will be applied at the |
| time wl_surface.commit of the corresponding wl_surface is called. |
| |
| When maintaining a position, the compositor should treat the (x, y) |
| coordinate of the window geometry as the top left corner of the window. |
| A client changing the (x, y) window geometry coordinate should in |
| general not alter the position of the window. |
| |
| Once the window geometry of the surface is set, it is not possible to |
| unset it, and it will remain the same until set_window_geometry is |
| called again, even if a new subsurface or buffer is attached. |
| |
| If never set, the value is the full bounds of the surface, |
| including any subsurfaces. This updates dynamically on every |
| commit. This unset is meant for extremely simple clients. |
| |
| The arguments are given in the surface-local coordinate space of |
| the wl_surface associated with this xdg_surface. |
| |
| The width and height must be greater than zero. Setting an invalid size |
| will raise an error. When applied, the effective window geometry will be |
| the set window geometry clamped to the bounding rectangle of the |
| combined geometry of the surface of the xdg_surface and the associated |
| subsurfaces. |
| </description> |
| <arg name="x" type="int"/> |
| <arg name="y" type="int"/> |
| <arg name="width" type="int"/> |
| <arg name="height" type="int"/> |
| </request> |
| |
| <request name="ack_configure"> |
| <description summary="ack a configure event"> |
| When a configure event is received, if a client commits the |
| surface in response to the configure event, then the client |
| must make an ack_configure request sometime before the commit |
| request, passing along the serial of the configure event. |
| |
| For instance, for toplevel surfaces the compositor might use this |
| information to move a surface to the top left only when the client has |
| drawn itself for the maximized or fullscreen state. |
| |
| If the client receives multiple configure events before it |
| can respond to one, it only has to ack the last configure event. |
| |
| A client is not required to commit immediately after sending |
| an ack_configure request - it may even ack_configure several times |
| before its next surface commit. |
| |
| A client may send multiple ack_configure requests before committing, but |
| only the last request sent before a commit indicates which configure |
| event the client really is responding to. |
| </description> |
| <arg name="serial" type="uint" summary="the serial from the configure event"/> |
| </request> |
| |
| <event name="configure"> |
| <description summary="suggest a surface change"> |
| The configure event marks the end of a configure sequence. A configure |
| sequence is a set of one or more events configuring the state of the |
| xdg_surface, including the final xdg_surface.configure event. |
| |
| Where applicable, xdg_surface surface roles will during a configure |
| sequence extend this event as a latched state sent as events before the |
| xdg_surface.configure event. Such events should be considered to make up |
| a set of atomically applied configuration states, where the |
| xdg_surface.configure commits the accumulated state. |
| |
| Clients should arrange their surface for the new states, and then send |
| an ack_configure request with the serial sent in this configure event at |
| some point before committing the new surface. |
| |
| If the client receives multiple configure events before it can respond |
| to one, it is free to discard all but the last event it received. |
| </description> |
| <arg name="serial" type="uint" summary="serial of the configure event"/> |
| </event> |
| </interface> |
| |
| <interface name="xdg_toplevel" version="1"> |
| <description summary="toplevel surface"> |
| This interface defines an xdg_surface role which allows a surface to, |
| among other things, set window-like properties such as maximize, |
| fullscreen, and minimize, set application-specific metadata like title and |
| id, and well as trigger user interactive operations such as interactive |
| resize and move. |
| |
| Unmapping an xdg_toplevel means that the surface cannot be shown |
| by the compositor until it is explicitly mapped again. |
| All active operations (e.g., move, resize) are canceled and all |
| attributes (e.g. title, state, stacking, ...) are discarded for |
| an xdg_toplevel surface when it is unmapped. |
| |
| Attaching a null buffer to a toplevel unmaps the surface. |
| </description> |
| |
| <request name="destroy" type="destructor"> |
| <description summary="destroy the xdg_toplevel"> |
| This request destroys the role surface and unmaps the surface; |
| see "Unmapping" behavior in interface section for details. |
| </description> |
| </request> |
| |
| <request name="set_parent"> |
| <description summary="set the parent of this surface"> |
| Set the "parent" of this surface. This surface should be stacked |
| this above the parent surface and all other ancestor surfaces. |
| |
| Parent windows should be set on dialogs, toolboxes, or other |
| "auxiliary" surfaces, so that the parent is raised when the dialog |
| is raised. |
| |
| Setting a null parent for a child window removes any parent-child |
| relationship for the child. Setting a null parent for a window which |
| currently has no parent is a no-op. |
| |
| If the parent is unmapped then its children are managed as |
| though the parent of the now-unmapped parent has become the |
| parent of this surface. If no parent exists for the now-unmapped |
| parent then the children are managed as though they have no |
| parent surface. |
| </description> |
| <arg name="parent" type="object" interface="xdg_toplevel" allow-null="true"/> |
| </request> |
| |
| <request name="set_title"> |
| <description summary="set surface title"> |
| Set a short title for the surface. |
| |
| This string may be used to identify the surface in a task bar, |
| window list, or other user interface elements provided by the |
| compositor. |
| |
| The string must be encoded in UTF-8. |
| </description> |
| <arg name="title" type="string"/> |
| </request> |
| |
| <request name="set_app_id"> |
| <description summary="set application ID"> |
| Set an application identifier for the surface. |
| |
| The app ID identifies the general class of applications to which |
| the surface belongs. The compositor can use this to group multiple |
| surfaces together, or to determine how to launch a new application. |
| |
| For D-Bus activatable applications, the app ID is used as the D-Bus |
| service name. |
| |
| The compositor shell will try to group application surfaces together |
| by their app ID. As a best practice, it is suggested to select app |
| ID's that match the basename of the application's .desktop file. |
| For example, "org.freedesktop.FooViewer" where the .desktop file is |
| "org.freedesktop.FooViewer.desktop". |
| |
| See the desktop-entry specification [0] for more details on |
| application identifiers and how they relate to well-known D-Bus |
| names and .desktop files. |
| |
| [0] http://standards.freedesktop.org/desktop-entry-spec/ |
| </description> |
| <arg name="app_id" type="string"/> |
| </request> |
| |
| <request name="show_window_menu"> |
| <description summary="show the window menu"> |
| Clients implementing client-side decorations might want to show |
| a context menu when right-clicking on the decorations, giving the |
| user a menu that they can use to maximize or minimize the window. |
| |
| This request asks the compositor to pop up such a window menu at |
| the given position, relative to the local surface coordinates of |
| the parent surface. There are no guarantees as to what menu items |
| the window menu contains. |
| |
| This request must be used in response to some sort of user action |
| like a button press, key press, or touch down event. |
| </description> |
| <arg name="seat" type="object" interface="wl_seat" summary="the wl_seat of the user event"/> |
| <arg name="serial" type="uint" summary="the serial of the user event"/> |
| <arg name="x" type="int" summary="the x position to pop up the window menu at"/> |
| <arg name="y" type="int" summary="the y position to pop up the window menu at"/> |
| </request> |
| |
| <request name="move"> |
| <description summary="start an interactive move"> |
| Start an interactive, user-driven move of the surface. |
| |
| This request must be used in response to some sort of user action |
| like a button press, key press, or touch down event. The passed |
| serial is used to determine the type of interactive move (touch, |
| pointer, etc). |
| |
| The server may ignore move requests depending on the state of |
| the surface (e.g. fullscreen or maximized), or if the passed serial |
| is no longer valid. |
| |
| If triggered, the surface will lose the focus of the device |
| (wl_pointer, wl_touch, etc) used for the move. It is up to the |
| compositor to visually indicate that the move is taking place, such as |
| updating a pointer cursor, during the move. There is no guarantee |
| that the device focus will return when the move is completed. |
| </description> |
| <arg name="seat" type="object" interface="wl_seat" summary="the wl_seat of the user event"/> |
| <arg name="serial" type="uint" summary="the serial of the user event"/> |
| </request> |
| |
| <enum name="resize_edge"> |
| <description summary="edge values for resizing"> |
| These values are used to indicate which edge of a surface |
| is being dragged in a resize operation. |
| </description> |
| <entry name="none" value="0"/> |
| <entry name="top" value="1"/> |
| <entry name="bottom" value="2"/> |
| <entry name="left" value="4"/> |
| <entry name="top_left" value="5"/> |
| <entry name="bottom_left" value="6"/> |
| <entry name="right" value="8"/> |
| <entry name="top_right" value="9"/> |
| <entry name="bottom_right" value="10"/> |
| </enum> |
| |
| <request name="resize"> |
| <description summary="start an interactive resize"> |
| Start a user-driven, interactive resize of the surface. |
| |
| This request must be used in response to some sort of user action |
| like a button press, key press, or touch down event. The passed |
| serial is used to determine the type of interactive resize (touch, |
| pointer, etc). |
| |
| The server may ignore resize requests depending on the state of |
| the surface (e.g. fullscreen or maximized). |
| |
| If triggered, the client will receive configure events with the |
| "resize" state enum value and the expected sizes. See the "resize" |
| enum value for more details about what is required. The client |
| must also acknowledge configure events using "ack_configure". After |
| the resize is completed, the client will receive another "configure" |
| event without the resize state. |
| |
| If triggered, the surface also will lose the focus of the device |
| (wl_pointer, wl_touch, etc) used for the resize. It is up to the |
| compositor to visually indicate that the resize is taking place, |
| such as updating a pointer cursor, during the resize. There is no |
| guarantee that the device focus will return when the resize is |
| completed. |
| |
| The edges parameter specifies how the surface should be resized, |
| and is one of the values of the resize_edge enum. The compositor |
| may use this information to update the surface position for |
| example when dragging the top left corner. The compositor may also |
| use this information to adapt its behavior, e.g. choose an |
| appropriate cursor image. |
| </description> |
| <arg name="seat" type="object" interface="wl_seat" summary="the wl_seat of the user event"/> |
| <arg name="serial" type="uint" summary="the serial of the user event"/> |
| <arg name="edges" type="uint" summary="which edge or corner is being dragged"/> |
| </request> |
| |
| <enum name="state"> |
| <description summary="types of state on the surface"> |
| The different state values used on the surface. This is designed for |
| state values like maximized, fullscreen. It is paired with the |
| configure event to ensure that both the client and the compositor |
| setting the state can be synchronized. |
| |
| States set in this way are double-buffered. They will get applied on |
| the next commit. |
| </description> |
| <entry name="maximized" value="1" summary="the surface is maximized"> |
| <description summary="the surface is maximized"> |
| The surface is maximized. The window geometry specified in the configure |
| event must be obeyed by the client. |
| </description> |
| </entry> |
| <entry name="fullscreen" value="2" summary="the surface is fullscreen"> |
| <description summary="the surface is fullscreen"> |
| The surface is fullscreen. The window geometry specified in the |
| configure event is a maximum; the client cannot resize beyond it. For |
| a surface to cover the whole fullscreened area, the geometry |
| dimensions must be obeyed by the client. For more details, see |
| xdg_toplevel.set_fullscreen. |
| </description> |
| </entry> |
| <entry name="resizing" value="3" summary="the surface is being resized"> |
| <description summary="the surface is being resized"> |
| The surface is being resized. The window geometry specified in the |
| configure event is a maximum; the client cannot resize beyond it. |
| Clients that have aspect ratio or cell sizing configuration can use |
| a smaller size, however. |
| </description> |
| </entry> |
| <entry name="activated" value="4" summary="the surface is now activated"> |
| <description summary="the surface is now activated"> |
| Client window decorations should be painted as if the window is |
| active. Do not assume this means that the window actually has |
| keyboard or pointer focus. |
| </description> |
| </entry> |
| </enum> |
| |
| <request name="set_max_size"> |
| <description summary="set the maximum size"> |
| Set a maximum size for the window. |
| |
| The client can specify a maximum size so that the compositor does |
| not try to configure the window beyond this size. |
| |
| The width and height arguments are in window geometry coordinates. |
| See xdg_surface.set_window_geometry. |
| |
| Values set in this way are double-buffered. They will get applied |
| on the next commit. |
| |
| The compositor can use this information to allow or disallow |
| different states like maximize or fullscreen and draw accurate |
| animations. |
| |
| Similarly, a tiling window manager may use this information to |
| place and resize client windows in a more effective way. |
| |
| The client should not rely on the compositor to obey the maximum |
| size. The compositor may decide to ignore the values set by the |
| client and request a larger size. |
| |
| If never set, or a value of zero in the request, means that the |
| client has no expected maximum size in the given dimension. |
| As a result, a client wishing to reset the maximum size |
| to an unspecified state can use zero for width and height in the |
| request. |
| |
| Requesting a maximum size to be smaller than the minimum size of |
| a surface is illegal and will result in a protocol error. |
| |
| The width and height must be greater than or equal to zero. Using |
| strictly negative values for width and height will result in a |
| protocol error. |
| </description> |
| <arg name="width" type="int"/> |
| <arg name="height" type="int"/> |
| </request> |
| |
| <request name="set_min_size"> |
| <description summary="set the minimum size"> |
| Set a minimum size for the window. |
| |
| The client can specify a minimum size so that the compositor does |
| not try to configure the window below this size. |
| |
| The width and height arguments are in window geometry coordinates. |
| See xdg_surface.set_window_geometry. |
| |
| Values set in this way are double-buffered. They will get applied |
| on the next commit. |
| |
| The compositor can use this information to allow or disallow |
| different states like maximize or fullscreen and draw accurate |
| animations. |
| |
| Similarly, a tiling window manager may use this information to |
| place and resize client windows in a more effective way. |
| |
| The client should not rely on the compositor to obey the minimum |
| size. The compositor may decide to ignore the values set by the |
| client and request a smaller size. |
| |
| If never set, or a value of zero in the request, means that the |
| client has no expected minimum size in the given dimension. |
| As a result, a client wishing to reset the minimum size |
| to an unspecified state can use zero for width and height in the |
| request. |
| |
| Requesting a minimum size to be larger than the maximum size of |
| a surface is illegal and will result in a protocol error. |
| |
| The width and height must be greater than or equal to zero. Using |
| strictly negative values for width and height will result in a |
| protocol error. |
| </description> |
| <arg name="width" type="int"/> |
| <arg name="height" type="int"/> |
| </request> |
| |
| <request name="set_maximized"> |
| <description summary="maximize the window"> |
| Maximize the surface. |
| |
| After requesting that the surface should be maximized, the compositor |
| will respond by emitting a configure event with the "maximized" state |
| and the required window geometry. The client should then update its |
| content, drawing it in a maximized state, i.e. without shadow or other |
| decoration outside of the window geometry. The client must also |
| acknowledge the configure when committing the new content (see |
| ack_configure). |
| |
| It is up to the compositor to decide how and where to maximize the |
| surface, for example which output and what region of the screen should |
| be used. |
| |
| If the surface was already maximized, the compositor will still emit |
| a configure event with the "maximized" state. |
| |
| If the surface is in a fullscreen state, this request has no direct |
| effect. It will alter the state the surface is returned to when |
| unmaximized if not overridden by the compositor. |
| </description> |
| </request> |
| |
| <request name="unset_maximized"> |
| <description summary="unmaximize the window"> |
| Unmaximize the surface. |
| |
| After requesting that the surface should be unmaximized, the compositor |
| will respond by emitting a configure event without the "maximized" |
| state. If available, the compositor will include the window geometry |
| dimensions the window had prior to being maximized in the configure |
| event. The client must then update its content, drawing it in a |
| regular state, i.e. potentially with shadow, etc. The client must also |
| acknowledge the configure when committing the new content (see |
| ack_configure). |
| |
| It is up to the compositor to position the surface after it was |
| unmaximized; usually the position the surface had before maximizing, if |
| applicable. |
| |
| If the surface was already not maximized, the compositor will still |
| emit a configure event without the "maximized" state. |
| |
| If the surface is in a fullscreen state, this request has no direct |
| effect. It will alter the state the surface is returned to when |
| unmaximized if not overridden by the compositor. |
| </description> |
| </request> |
| |
| <request name="set_fullscreen"> |
| <description summary="set the window as fullscreen on an output"> |
| Make the surface fullscreen. |
| |
| After requesting that the surface should be fullscreened, the |
| compositor will respond by emitting a configure event with the |
| "fullscreen" state and the fullscreen window geometry. The client must |
| also acknowledge the configure when committing the new content (see |
| ack_configure). |
| |
| The output passed by the request indicates the client's preference as |
| to which display it should be set fullscreen on. If this value is NULL, |
| it's up to the compositor to choose which display will be used to map |
| this surface. |
| |
| If the surface doesn't cover the whole output, the compositor will |
| position the surface in the center of the output and compensate with |
| with border fill covering the rest of the output. The content of the |
| border fill is undefined, but should be assumed to be in some way that |
| attempts to blend into the surrounding area (e.g. solid black). |
| |
| If the fullscreened surface is not opaque, the compositor must make |
| sure that other screen content not part of the same surface tree (made |
| up of subsurfaces, popups or similarly coupled surfaces) are not |
| visible below the fullscreened surface. |
| </description> |
| <arg name="output" type="object" interface="wl_output" allow-null="true"/> |
| </request> |
| |
| <request name="unset_fullscreen"> |
| <description summary="unset the window as fullscreen"> |
| Make the surface no longer fullscreen. |
| |
| After requesting that the surface should be unfullscreened, the |
| compositor will respond by emitting a configure event without the |
| "fullscreen" state. |
| |
| Making a surface unfullscreen sets states for the surface based on the following: |
| * the state(s) it may have had before becoming fullscreen |
| * any state(s) decided by the compositor |
| * any state(s) requested by the client while the surface was fullscreen |
| |
| The compositor may include the previous window geometry dimensions in |
| the configure event, if applicable. |
| |
| The client must also acknowledge the configure when committing the new |
| content (see ack_configure). |
| </description> |
| </request> |
| |
| <request name="set_minimized"> |
| <description summary="set the window as minimized"> |
| Request that the compositor minimize your surface. There is no |
| way to know if the surface is currently minimized, nor is there |
| any way to unset minimization on this surface. |
| |
| If you are looking to throttle redrawing when minimized, please |
| instead use the wl_surface.frame event for this, as this will |
| also work with live previews on windows in Alt-Tab, Expose or |
| similar compositor features. |
| </description> |
| </request> |
| |
| <event name="configure"> |
| <description summary="suggest a surface change"> |
| This configure event asks the client to resize its toplevel surface or |
| to change its state. The configured state should not be applied |
| immediately. See xdg_surface.configure for details. |
| |
| The width and height arguments specify a hint to the window |
| about how its surface should be resized in window geometry |
| coordinates. See set_window_geometry. |
| |
| If the width or height arguments are zero, it means the client |
| should decide its own window dimension. This may happen when the |
| compositor needs to configure the state of the surface but doesn't |
| have any information about any previous or expected dimension. |
| |
| The states listed in the event specify how the width/height |
| arguments should be interpreted, and possibly how it should be |
| drawn. |
| |
| Clients must send an ack_configure in response to this event. See |
| xdg_surface.configure and xdg_surface.ack_configure for details. |
| </description> |
| <arg name="width" type="int"/> |
| <arg name="height" type="int"/> |
| <arg name="states" type="array"/> |
| </event> |
| |
| <event name="close"> |
| <description summary="surface wants to be closed"> |
| The close event is sent by the compositor when the user |
| wants the surface to be closed. This should be equivalent to |
| the user clicking the close button in client-side decorations, |
| if your application has any. |
| |
| This is only a request that the user intends to close the |
| window. The client may choose to ignore this request, or show |
| a dialog to ask the user to save their data, etc. |
| </description> |
| </event> |
| </interface> |
| |
| <interface name="xdg_popup" version="1"> |
| <description summary="short-lived, popup surfaces for menus"> |
| A popup surface is a short-lived, temporary surface. It can be used to |
| implement for example menus, popovers, tooltips and other similar user |
| interface concepts. |
| |
| A popup can be made to take an explicit grab. See xdg_popup.grab for |
| details. |
| |
| When the popup is dismissed, a popup_done event will be sent out, and at |
| the same time the surface will be unmapped. See the xdg_popup.popup_done |
| event for details. |
| |
| Explicitly destroying the xdg_popup object will also dismiss the popup and |
| unmap the surface. Clients that want to dismiss the popup when another |
| surface of their own is clicked should dismiss the popup using the destroy |
| request. |
| |
| The parent surface must have either the xdg_toplevel or xdg_popup surface |
| role. |
| |
| A newly created xdg_popup will be stacked on top of all previously created |
| xdg_popup surfaces associated with the same xdg_toplevel. |
| |
| The parent of an xdg_popup must be mapped (see the xdg_surface |
| description) before the xdg_popup itself. |
| |
| The x and y arguments passed when creating the popup object specify |
| where the top left of the popup should be placed, relative to the |
| local surface coordinates of the parent surface. See |
| xdg_surface.get_popup. An xdg_popup must intersect with or be at least |
| partially adjacent to its parent surface. |
| |
| The client must call wl_surface.commit on the corresponding wl_surface |
| for the xdg_popup state to take effect. |
| </description> |
| |
| <enum name="error"> |
| <entry name="invalid_grab" value="0" |
| summary="tried to grab after being mapped"/> |
| </enum> |
| |
| <request name="destroy" type="destructor"> |
| <description summary="remove xdg_popup interface"> |
| This destroys the popup. Explicitly destroying the xdg_popup |
| object will also dismiss the popup, and unmap the surface. |
| |
| If this xdg_popup is not the "topmost" popup, a protocol error |
| will be sent. |
| </description> |
| </request> |
| |
| <request name="grab"> |
| <description summary="make the popup take an explicit grab"> |
| This request makes the created popup take an explicit grab. An explicit |
| grab will be dismissed when the user dismisses the popup, or when the |
| client destroys the xdg_popup. This can be done by the user clicking |
| outside the surface, using the keyboard, or even locking the screen |
| through closing the lid or a timeout. |
| |
| If the compositor denies the grab, the popup will be immediately |
| dismissed. |
| |
| This request must be used in response to some sort of user action like a |
| button press, key press, or touch down event. The serial number of the |
| event should be passed as 'serial'. |
| |
| The parent of a grabbing popup must either be an xdg_toplevel surface or |
| another xdg_popup with an explicit grab. If the parent is another |
| xdg_popup it means that the popups are nested, with this popup now being |
| the topmost popup. |
| |
| Nested popups must be destroyed in the reverse order they were created |
| in, e.g. the only popup you are allowed to destroy at all times is the |
| topmost one. |
| |
| When compositors choose to dismiss a popup, they may dismiss every |
| nested grabbing popup as well. When a compositor dismisses popups, it |
| will follow the same dismissing order as required from the client. |
| |
| The parent of a grabbing popup must either be another xdg_popup with an |
| active explicit grab, or an xdg_popup or xdg_toplevel, if there are no |
| explicit grabs already taken. |
| |
| If the topmost grabbing popup is destroyed, the grab will be returned to |
| the parent of the popup, if that parent previously had an explicit grab. |
| |
| If the parent is a grabbing popup which has already been dismissed, this |
| popup will be immediately dismissed. If the parent is a popup that did |
| not take an explicit grab, an error will be raised. |
| |
| During a popup grab, the client owning the grab will receive pointer |
| and touch events for all their surfaces as normal (similar to an |
| "owner-events" grab in X11 parlance), while the top most grabbing popup |
| will always have keyboard focus. |
| </description> |
| <arg name="seat" type="object" interface="wl_seat" |
| summary="the wl_seat of the user event"/> |
| <arg name="serial" type="uint" summary="the serial of the user event"/> |
| </request> |
| |
| <event name="configure"> |
| <description summary="configure the popup surface"> |
| This event asks the popup surface to configure itself given the |
| configuration. The configured state should not be applied immediately. |
| See xdg_surface.configure for details. |
| |
| The x and y arguments represent the position the popup was placed at |
| given the xdg_positioner rule, relative to the upper left corner of the |
| window geometry of the parent surface. |
| </description> |
| <arg name="x" type="int" |
| summary="x position relative to parent surface window geometry"/> |
| <arg name="y" type="int" |
| summary="y position relative to parent surface window geometry"/> |
| <arg name="width" type="int" summary="window geometry width"/> |
| <arg name="height" type="int" summary="window geometry height"/> |
| </event> |
| |
| <event name="popup_done"> |
| <description summary="popup interaction is done"> |
| The popup_done event is sent out when a popup is dismissed by the |
| compositor. The client should destroy the xdg_popup object at this |
| point. |
| </description> |
| </event> |
| |
| </interface> |
| </protocol> |