protocol/ivi-hmi-controller.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <protocol name="ivi_hmi_controller">
   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_hmi_controller" version="1">
  28     <description summary="set up and control IVI style UI"/>
  29
  30     <request name="UI_ready">
  31       <description summary="inform the ready for drawing desktop." />
  32     </request>
  33
  34     <request name="workspace_control">
  35       <description summary="start controlling a surface by server">
  36         Reference protocol to control a surface by server.
  37         To control a surface by server, it gives seat to the server
  38         to e.g. control Home screen. Home screen has several workspaces
  39         to group launchers of wayland application. These workspaces
  40         are drawn on a horizontally long surface to be controlled
  41         by motion of input device. E.g. A motion from right to left
  42         happens, the viewport of surface is controlled in the ivi-shell
  43         by using ivi-layout. client can recognizes the end of controlling
  44         by event "workspace_end_control".
  45       </description>
  46       <arg name="seat" type="object" interface="wl_seat"/>
  47       <arg name="serial" type="uint"/>
  48     </request>
  49
  50     <enum name="layout_mode">
  51       <entry name="tiling" value="0"/>
  52       <entry name="side_by_side" value="1"/>
  53       <entry name="full_screen" value="2"/>
  54       <entry name="random" value="3" />
  55     </enum>
  56
  57     <request name="switch_mode">
  58       <description summary="request mode switch of application layout">
  59         hmi-controller loaded to ivi-shall implements 4 types of layout
  60         as a reference; tiling, side by side, full_screen, and random.
  61       </description>
  62       <arg name="layout_mode" type="uint"/>
  63     </request>
  64
  65     <enum name="home">
  66       <entry name="off" value="0"/>
  67       <entry name="on" value="1"/>
  68     </enum>
  69
  70     <request name="home">
  71       <description summary="request displaying/undisplaying home screen">
  72         home screen is a reference implementation of launcher to launch
  73         wayland applications. The home screen has several workspaces to
  74         group wayland applications. By defining the following keys in
  75         weston.ini, user can add launcher icon to launch a wayland application
  76         to a workspace.
  77         [ivi-launcher]
  78         workspace-id=0
  79                 : id of workspace to add a launcher
  80         icon-id=4001
  81                 : ivi id of ivi_surface to draw a icon
  82         icon=/home/user/review/build-ivi-shell/data/icon_ivi_flower.png
  83                 : path to icon image
  84         path=/home/user/review/build-ivi-shell/weston-dnd
  85                 : path to wayland application
  86       </description>
  87       <arg name="home" type="uint"/>
  88     </request>
  89
  90     <event name="workspace_end_control">
  91       <description summary="notify controlling workspace end"/>
  92       <arg name="is_controlled" type="int"/>
  93     </event>
  94
  95   </interface>
  96
  97 </protocol>