protocol/ico_input_mgr.xml

   1 <protocol name="ico_input_mgr">
   2
   3   <interface name="ico_input_mgr_control" version="1">
   4     <description summary="interface for manager(ex.HomeScreen)">
   5       Order a correspondence charge account to the application of the input switch
   6       to Multi Input Manager from HomeScreen.
   7     </description>
   8
   9     <request name="add_input_app">
  10       <description summary="assign input switch to application">
  11         Assign input switch to application from HomeScreen.
  12       </description>
  13       <arg name="appid" type="string" summary="application Id for input switch"/>
  14       <arg name="device" type="string" summary="input device name"/>
  15       <arg name="input" type="int" summary="input switch number"/>
  16       <arg name="fix" type="int" summary="fixed assign to application"/>
  17       <arg name="keycode" type="int" summary="switch map to keyboard event"/>
  18     </request>
  19
  20     <request name="del_input_app">
  21       <description summary="de-assign input switch to application">
  22         De-assign input switch to application from HomeScreen.
  23       </description>
  24       <arg name="appid" type="string" summary="application Id for input switch, if NULL all applications with out fixed assign"/>
  25       <arg name="device" type="string" summary="input device name, if NULL, all devices with out fixed assign"/>
  26       <arg name="input" type="int" summary="input switch number, if -1, all input with out dixed assign"/>
  27     </request>
  28
  29     <request name="send_input_event">
  30       <description summary="send input event to application">
  31         Mouse, Touch or Keyboard event sent to application.
  32       </description>
  33       <arg name="appid" type="string" summary="application Id for input switch"/>
  34       <arg name="surfaceid" type="uint" summary="event surface Id"/>
  35       <arg name="type" type="int" summary="event device type"/>
  36       <arg name="code" type="int" summary="event code"/>
  37       <arg name="value" type="int" summary="event value"/>
  38     </request>
  39   </interface>
  40
  41   <interface name="ico_exinput" version="1">
  42     <description summary="interface for application">
  43       Inform the switch name and number which there is for application,
  44       and notify application of ON/OFF of the switch.
  45     </description>
  46
  47     <request name="set_input_region">
  48       <arg name="surfaceid" type="uint" summary="target surface"/>
  49       <arg name="x" type="int" summary="input region X coordinate"/>
  50       <arg name="y" type="int" summary="input region Y coordinate"/>
  51       <arg name="width" type="int" summary="input region width"/>
  52       <arg name="height" type="int" summary="input region height"/>
  53       <arg name="attr" type="int"/>
  54     </request>
  55
  56     <request name="reset_input_region">
  57       <arg name="surfaceid" type="uint" summary="target surface"/>
  58       <arg name="x" type="int" summary="input region X coordinate"/>
  59       <arg name="y" type="int" summary="input region Y coordinate"/>
  60       <arg name="width" type="int" summary="input region width"/>
  61       <arg name="height" type="int" summary="input region height"/>
  62     </request>
  63
  64     <event name="capabilities">
  65       <description summary="event to application for input switch information">
  66         Send Input device and switch information to application
  67       </description>
  68       <arg name="device" type="string" summary="input device name"/>
  69       <arg name="type" type="int" summary="input device type (as enum type)"/>
  70       <arg name="swname" type="string" summary="input switch name"/>
  71       <arg name="input" type="int" summary="input switch number"/>
  72       <arg name="codename" type="string" summary="input code name"/>
  73       <arg name="code" type="int" summary="input code number"/>
  74     </event>
  75
  76     <event name="code">
  77       <description summary="event to application for input code information">
  78         Send Input code information to application
  79       </description>
  80       <arg name="device" type="string" summary="input device name"/>
  81       <arg name="input" type="int" summary="input switch number"/>
  82       <arg name="codename" type="string" summary="input code name"/>
  83       <arg name="code" type="int" summary="input code number"/>
  84     </event>
  85
  86     <event name="input">
  87       <description summary="event to application for switch input">
  88         Send Input switch event to application
  89       </description>
  90       <arg name="time" type="uint" summary="input time of miri-sec"/>
  91       <arg name="device" type="string" summary="input device name"/>
  92       <arg name="input" type="int" summary="input switch number"/>
  93       <arg name="code" type="int" summary="input switch code"/>
  94       <arg name="state" type="int" summary="Of/Off status"/>
  95     </event>
  96   </interface>
  97
  98   <interface name="ico_input_mgr_device" version="1">
  99     <description summary="interface for input controller">
 100       An input controller informs attribute of the device and ON/OFF of the switch
 101       to Multi Input Manager.
 102     </description>
 103
 104     <enum name="type">
 105       <description summary="capability bitmask">
 106        Input Controller type mask define.
 107       </description>
 108       <entry name="pointer" value="1" summary="wl_pointer"/>
 109       <entry name="keyboard" value="2" summary="wl_keyboard"/>
 110       <entry name="touch" value="4" summary="wl_touch"/>
 111       <entry name="switch" value="8" summary="exinput switch"/>
 112       <entry name="haptic" value="16" summary="haptic"/>
 113     </enum>
 114
 115     <request name="configure_input">
 116       <description summary="input controller define input switch">
 117         Define input switch from Input Controller
 118       </description>
 119       <arg name="device" type="string" summary="input device name"/>
 120       <arg name="type" type="int" summary="input device type (as enum type)"/>
 121       <arg name="swname" type="string" summary="input switch name"/>
 122       <arg name="input" type="int" summary="input switch number"/>
 123       <arg name="codename" type="string" summary="input code name"/>
 124       <arg name="code" type="int" summary="input code number"/>
 125     </request>
 126
 127     <request name="configure_code">
 128       <description summary="input controller define input code">
 129         Define input code from Input Controller
 130       </description>
 131       <arg name="device" type="string" summary="input device name"/>
 132       <arg name="input" type="int" summary="input switch number"/>
 133       <arg name="codename" type="string" summary="input code name"/>
 134       <arg name="code" type="int" summary="input code number"/>
 135     </request>
 136
 137     <request name="input_event">
 138       <description summary="input controller switch input event">
 139         Event of switch input from Input Controller
 140       </description>
 141       <arg name="time" type="uint" summary="input time of day"/>
 142       <arg name="device" type="string" summary="input device name"/>
 143       <arg name="input" type="int" summary="input switch number"/>
 144       <arg name="code" type="int" summary="input switch code"/>
 145       <arg name="state" type="int" summary="Of/Off status"/>
 146     </request>
 147
 148     <event name="input_region">
 149       <description summary="event to application for change input region">
 150         Send input region to haptic controller.
 151       </description>
 152       <arg name="region" type="array" summary="input regions"/>
 153     </event>
 154   </interface>
 155
 156 </protocol>
 157