protocol/ivi-application.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <protocol name="ivi_application">
   3
   4   <copyright>
   5     Copyright (C) 2013 DENSO CORPORATION
   6     Copyright (c) 2013 BMW Car IT GmbH
   7
   8     Permission is hereby granted, free of charge, to any person obtaining a
   9     copy of this software and associated documentation files (the "Software"),
  10     to deal in the Software without restriction, including without limitation
  11     the rights to use, copy, modify, merge, publish, distribute, sublicense,
  12     and/or sell copies of the Software, and to permit persons to whom the
  13     Software is furnished to do so, subject to the following conditions:
  14
  15     The above copyright notice and this permission notice (including the next
  16     paragraph) shall be included in all copies or substantial portions of the
  17     Software.
  18
  19     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20     IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21     FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  22     THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23     LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  24     FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  25     DEALINGS IN THE SOFTWARE.
  26   </copyright>
  27
  28   <interface name="ivi_surface" version="1">
  29     <description summary="application interface to surface in ivi compositor"/>
  30
  31     <request name="destroy" type="destructor">
  32       <description summary="destroy ivi_surface">
  33         This removes link from ivi_id to wl_surface and destroys ivi_surface.
  34         The ID, ivi_id, is free and can be used for surface_create again.
  35       </description>
  36     </request>
  37
  38     <event name="configure">
  39       <description summary="suggest resize">
  40         The configure event asks the client to resize its surface.
  41
  42         The size is a hint, in the sense that the client is free to
  43         ignore it if it doesn't resize, pick a smaller size (to
  44         satisfy aspect ratio or resize in steps of NxM pixels).
  45
  46         The client is free to dismiss all but the last configure
  47         event it received.
  48
  49         The width and height arguments specify the size of the window
  50         in surface local coordinates.
  51       </description>
  52       <arg name="width" type="int"/>
  53       <arg name="height" type="int"/>
  54     </event>
  55   </interface>
  56
  57   <interface name="ivi_application" version="1">
  58     <description summary="create ivi-style surfaces">
  59       This interface is exposed as a global singleton.
  60       This interface is implemented by servers that provide IVI-style user interfaces.
  61       It allows clients to associate a ivi_surface with wl_surface.
  62     </description>
  63
  64     <enum name="error">
  65       <entry name="role" value="0" summary="given wl_surface has another role"/>
  66       <entry name="ivi_id" value="1" summary="given ivi_id is assigned to another wl_surface"/>
  67     </enum>
  68
  69     <request name="surface_create">
  70       <description summary="create ivi_surface with numeric ID in ivi compositor">
  71         This request gives the wl_surface the role of an IVI Surface. Creating more than
  72         one ivi_surface for a wl_surface is not allowed. Note, that this still allows the
  73         following example:
  74
  75          1. create a wl_surface
  76          2. create ivi_surface for the wl_surface
  77          3. destroy the ivi_surface
  78          4. create ivi_surface for the wl_surface (with the same or another ivi_id as before)
  79
  80         surface_create will create a interface:ivi_surface with numeric ID; ivi_id in
  81         ivi compositor. These ivi_ids are defined as unique in the system to identify
  82         it inside of ivi compositor. The ivi compositor implements business logic how to
  83         set properties of the surface with ivi_id according to status of the system.
  84         E.g. a unique ID for Car Navigation application is used for implementing special
  85         logic of the application about where it shall be located.
  86         The server regards following cases as protocol errors and disconnects the client.
  87          - wl_surface already has an nother role.
  88          - ivi_id is already assigned to an another wl_surface.
  89
  90         If client destroys ivi_surface or wl_surface which is assigne to the ivi_surface,
  91         ivi_id which is assigned to the ivi_surface is free for reuse.
  92       </description>
  93       <arg name="ivi_id" type="uint"/>
  94       <arg name="surface" type="object" interface="wl_surface"/>
  95       <arg name="id" type="new_id" interface="ivi_surface"/>
  96     </request>
  97
  98   </interface>
  99
 100 </protocol>