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         <event name="configure">
  46             <arg name="width" type="int"/>
  47             <arg name="height" type="int"/>
  48         </event>
  49
  50     </interface>
  51
  52     <interface name="ivi_application" version="1">
  53         <description summary="create ivi-style surfaces">
  54             This interface is implemented by servers that provide desktop-style user interfaces.
  55             It allows clients to associate a ivi_surface with a basic surface.
  56         </description>
  57
  58         <request name="surface_create">
  59             <description summary="create ivi_surface with numeric ID in ivi compositor">
  60                 surface_create will create a interface:ivi_surface with numeric ID; ivi_id in
  61                 ivi compositor. These ivi_ids are defined as unique in the system to identify
  62                 it inside of ivi compositor. The ivi compositor implements business logic how to
  63                 set properties of the surface with ivi_id according to status of the system.
  64                 E.g. a unique ID for Car Navigation application is used for implementing special
  65                 logic of the application about where it shall be located.
  66                 if a wl_surface which already has another role is set, the server regards this as
  67                 error and disconnects the client.
  68             </description>
  69             <arg name="ivi_id" type="uint"/>
  70             <arg name="surface" type="object" interface="wl_surface"/>
  71             <arg name="id" type="new_id" interface="ivi_surface"/>
  72         </request>
  73
  74         <event name="wl_shell_info">
  75             <arg name="pid" type="int"/>
  76             <arg name="title" type="string" allow-null="true"/>
  77         </event>
  78
  79     </interface>
  80
  81 </protocol>