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 to use, copy, modify, distribute, and sell this software and
   9     its documentation for any purpose is hereby granted without fee, provided
  10     that the above copyright notice appear in all copies and that both that
  11     copyright notice and this permission notice appear in supporting
  12     documentation, and that the name of the copyright holders not be used in
  13     advertising or publicity pertaining to distribution of the software
  14     without specific, written prior permission.  The copyright holders make
  15     no representations about the suitability of this software for any
  16     purpose.  It is provided "as is" without express or implied warranty.
  17
  18     THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
  19     SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
  20     FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
  21     SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
  22     RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
  23     CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  24     CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  25   </copyright>
  26
  27   <interface name="ivi_surface" version="1">
  28     <description summary="application interface to surface in ivi compositor"/>
  29
  30     <request name="destroy" type="destructor">
  31       <description summary="destroy ivi_surface">
  32         This removes link from ivi_id to wl_surface and destroys ivi_surface.
  33         The ID, ivi_id, is free and can be used for surface_create again.
  34       </description>
  35     </request>
  36
  37     <event name="configure">
  38       <description summary="suggest resize">
  39         The configure event asks the client to resize its surface.
  40
  41         The size is a hint, in the sense that the client is free to
  42         ignore it if it doesn't resize, pick a smaller size (to
  43         satisfy aspect ratio or resize in steps of NxM pixels).
  44
  45         The client is free to dismiss all but the last configure
  46         event it received.
  47
  48         The width and height arguments specify the size of the window
  49         in surface local coordinates.
  50       </description>
  51       <arg name="width" type="int"/>
  52       <arg name="height" type="int"/>
  53     </event>
  54   </interface>
  55
  56   <interface name="ivi_application" version="1">
  57     <description summary="create ivi-style surfaces">
  58       This interface is exposed as a global singleton.
  59       This interface is implemented by servers that provide IVI-style user interfaces.
  60       It allows clients to associate a ivi_surface with wl_surface.
  61     </description>
  62
  63     <enum name="error">
  64       <entry name="role" value="0" summary="given wl_surface has another role"/>
  65       <entry name="ivi_id" value="1" summary="given ivi_id is assigned to another wl_surface"/>
  66     </enum>
  67
  68     <request name="surface_create">
  69       <description summary="create ivi_surface with numeric ID in ivi compositor">
  70         This request gives the wl_surface the role of an IVI Surface. Creating more than
  71         one ivi_surface for a wl_surface is not allowed. Note, that this still allows the
  72         following example:
  73
  74          1. create a wl_surface
  75          2. create ivi_surface for the wl_surface
  76          3. destroy the ivi_surface
  77          4. create ivi_surface for the wl_surface (with the same or another ivi_id as before)
  78
  79         surface_create will create a interface:ivi_surface with numeric ID; ivi_id in
  80         ivi compositor. These ivi_ids are defined as unique in the system to identify
  81         it inside of ivi compositor. The ivi compositor implements business logic how to
  82         set properties of the surface with ivi_id according to status of the system.
  83         E.g. a unique ID for Car Navigation application is used for implementing special
  84         logic of the application about where it shall be located.
  85         The server regards following cases as protocol errors and disconnects the client.
  86          - wl_surface already has an nother role.
  87          - ivi_id is already assigned to an another wl_surface.
  88
  89         If client destroys ivi_surface or wl_surface which is assigne to the ivi_surface,
  90         ivi_id which is assigned to the ivi_surface is free for reuse.
  91       </description>
  92       <arg name="ivi_id" type="uint"/>
  93       <arg name="surface" type="object" interface="wl_surface"/>
  94       <arg name="id" type="new_id" interface="ivi_surface"/>
  95     </request>
  96
  97     <event name="wl_shell_info">
  98       <arg name="pid" type="int"/>
  99       <arg name="title" type="string" allow-null="true"/>
 100       <arg name="id_surface" type="uint"/>
 101     </event>
 102
 103   </interface>
 104
 105 </protocol>