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 copy
   9     of this software and associated documentation files (the "Software"), to deal
  10     in the Software without restriction, including without limitation the rights
  11     to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12     copies of the Software, and to permit persons to whom the Software is
  13     furnished to do so, subject to the following conditions:
  14
  15     The above copyright notice and this permission notice shall be included in
  16     all copies or substantial portions of the Software.
  17
  18     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19     IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20     FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21     AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22     LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23     OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  24     THE 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             </description>
  34         </request>
  35
  36         <event name="visibility">
  37             <description summary="visibility of surface in ivi compositor has changed">
  38                 The new visibility state is provided in argument visibility.
  39                 If visibility is 0, the surface has become invisible.
  40                 If visibility is not 0, the surface has become visible.
  41             </description>
  42             <arg name="visibility" type="int"/>
  43         </event>
  44
  45         <enum name="warning_code">
  46             <description summary="possible warning codes returned by ivi compositor">
  47                 These define all possible warning codes returned by ivi compositor on server-side warnings.
  48                 invalid_wl_surface:
  49                     - wl_surface already has a another role.
  50                     - wl_surface is destroyed before the ivi_surface is destroyed.
  51                 ivi_id_in_use: ivi_id is already assigned by another application.
  52             </description>
  53             <entry name="invalid_wl_surface" value="1" summary="wl_surface is invalid"/>
  54             <entry name="ivi_id_in_use" value="2" summary="ivi_id is in use and can not be shared"/>
  55         </enum>
  56
  57         <event name="warning">
  58             <description summary="server-side warning detected">
  59                 The ivi compositor encountered warning while processing a request by this
  60                 application. The warning is defined by argument warning_code and optional
  61                 warning_text. If the warning is detected, client shall destroy the ivi_surface
  62                 object.
  63
  64                 When a warning event is sent, the compositor turns the ivi_surface object inert.
  65                 The ivi_surface will not deliver further events, all requests on it are ignored
  66                 except 'destroy', and the association to the ivi_id is removed. The client
  67                 should destroy the ivi_surface object. If an inert ivi_surface object is used as
  68                 an argument to any other object's request, that request will [produce a fatal
  69                 error / produce a warning / be ignored].
  70             </description>
  71             <arg name="warning_code" type="int"/>
  72             <arg name="warning_text" type="string" allow-null="true"/>
  73         </event>
  74
  75     </interface>
  76
  77     <interface name="ivi_application" version="1">
  78         <description summary="create ivi-style surfaces">
  79             This interface is implemented by servers that provide desktop-style user interfaces.
  80             It allows clients to associate a ivi_surface with a basic surface.
  81         </description>
  82
  83         <request name="surface_create">
  84             <description summary="create ivi_surface with numeric ID in ivi compositor">
  85                 surface_create will create a interface:ivi_surface with numeric ID; ivi_id in
  86                 ivi compositor. These ivi_ids are defined as unique in the system to identify
  87                 it inside of ivi compositor. The ivi compositor implements business logic how to
  88                 set properties of the surface with ivi_id according to status of the system.
  89                 E.g. a unique ID for Car Navigation application is used for implementing special
  90                 logic of the application about where it shall be located.
  91                 if a wl_surface which already has another role is set, the server regards this as
  92                 error and disconnects the client.
  93             </description>
  94             <arg name="ivi_id" type="uint"/>
  95             <arg name="surface" type="object" interface="wl_surface"/>
  96             <arg name="id" type="new_id" interface="ivi_surface"/>
  97         </request>
  98
  99     </interface>
 100
 101 </protocol>