Blame uwac/protocols/xdg-shell.xml

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