protocol/ico_window_mgr.xml

   1 <protocol name="ico_window_mgr">
   2
   3   <interface name="ico_window_mgr" version="1">
   4     <description summary="interface for SystemController Window Management">
   5       for IVI SystemController interface.
   6     </description>
   7
   8     <enum name="v">
   9       <description summary="general fixed value for ico_window_mgr">
  10        General values for ico_window_mgr.
  11       </description>
  12       <entry name="nochange" value="0x8000" summary="no change value"/>
  13       <entry name="mainsurface" value="0x8000" summary="main serface id"/>
  14       <entry name="layer_input" value="0x2000" summary="cursor layer id"/>
  15       <entry name="layer_cursor" value="0x3000" summary="cursor layer id"/>
  16       <entry name="layer_startup" value="0x4000" summary="startup layer id"/>
  17     </enum>
  18
  19     <enum name="declare_manager">
  20       <description summary="declare manager">
  21        Declare manager application(ex. SystemController).
  22       </description>
  23       <entry name="application" value="0" summary="declare application"/>
  24       <entry name="manager" value="1" summary="declare manager"/>
  25     </enum>
  26
  27     <enum name="visible">
  28       <description summary="visiblity control">
  29        Surface show/hide control define.
  30       </description>
  31       <entry name="hide" value="0" summary="surface hide"/>
  32       <entry name="show" value="1" summary="surface show"/>
  33     </enum>
  34
  35     <enum name="raise">
  36       <description summary="raise control">
  37        Surface raise/lower control define.
  38       </description>
  39       <entry name="lower" value="0" summary="surface lower"/>
  40       <entry name="raise" value="1" summary="surface raise"/>
  41     </enum>
  42
  43     <enum name="flags">
  44       <description summary="flags for positionsize and visible API">
  45        Flags for ico_window_mgr_set_positionsize and ico_window_mgr_set_visible API.
  46       </description>
  47       <entry name="animation" value="0x0001" summary="with animation"/>
  48       <entry name="no_configure" value="0x0010" summary="no configure event to client"/>
  49     </enum>
  50
  51     <enum name="attr">
  52       <description summary="flags for surface attributes">
  53        Flags for surface attributes.
  54       </description>
  55       <entry name="fixed_aspect" value="0x0010" summary="fixed aspect rate"/>
  56       <entry name="align_left" value="0x0001" summary="align left side"/>
  57       <entry name="align_right" value="0x0002" summary="align right side"/>
  58       <entry name="align_top" value="0x0004" summary="align top side"/>
  59       <entry name="align_bottom" value="0x0008" summary="align bottom side"/>
  60     </enum>
  61
  62     <enum name="animation_type">
  63       <description summary="type of the cutaway for animation">
  64        Type of the cutaway for surface animation.
  65       </description>
  66       <entry name="hide" value="1" summary="animation for hide surface"/>
  67       <entry name="show" value="2" summary="animation for shwo surface"/>
  68       <entry name="move" value="4" summary="animation for move surface"/>
  69       <entry name="resize" value="8" summary="animation for resize surface"/>
  70     </enum>
  71
  72     <enum name="map_type">
  73       <description summary="map buffer type of mapped surface">
  74        Buffer type of mapped surface.
  75       </description>
  76       <entry name="egl" value="1" summary="EGL buffer"/>
  77       <entry name="shm" value="2" summary="wl_shm_buffer"/>
  78     </enum>
  79
  80     <enum name="map_surface_event">
  81       <description summary="event type of mapped surface change">
  82        Event type of mapped surface change.
  83       </description>
  84       <entry name="contents" value="1" summary="change drawing contents"/>
  85       <entry name="resize" value="2" summary="resize surface"/>
  86       <entry name="map" value="4" summary="shared surface"/>
  87       <entry name="unmap" value="8" summary="unshared surface"/>
  88       <entry name="error" value="16" summary="error"/>
  89     </enum>
  90
  91     <enum name="active">
  92       <description summary="surface active target device">
  93        Set surface active target device.
  94       </description>
  95       <entry name="none" value="0" summary="no active window"/>
  96       <entry name="pointer" value="1" summary="wl_pointer"/>
  97       <entry name="keyboard" value="2" summary="wl_keyboard"/>
  98       <entry name="selected" value="4" summary="selected_window_by_operation"/>
  99     </enum>
 100
 101     <enum name="hint">
 102       <description summary="event hint information">
 103        Surafce change hint information.
 104       </description>
 105       <entry name="change" value="0" summary="real change"/>
 106       <entry name="hint" value="1" summary="hint, not change"/>
 107     </enum>
 108
 109     <request name="declare_manager">
 110       <description summary="declare manager application">
 111        Set manager application(ex.SystemController).
 112       </description>
 113       <arg name="manager" type="int"/>
 114     </request>
 115
 116     <request name="set_window_layer">
 117       <description summary="set surface layer">
 118        Surface belong to a layer.
 119       </description>
 120       <arg name="surfaceid" type="uint"/>
 121       <arg name="layer" type="uint"/>
 122     </request>
 123
 124     <request name="set_positionsize">
 125       <description summary="set surface display position and surface size">
 126        Set surface display position and surface size.
 127       </description>
 128       <arg name="surfaceid" type="uint"/>
 129       <arg name="node" type="uint"/>
 130       <arg name="x" type="int"/>
 131       <arg name="y" type="int"/>
 132       <arg name="width" type="int"/>
 133       <arg name="height" type="int"/>
 134       <arg name="flags" type="int"/>
 135     </request>
 136
 137     <request name="set_visible">
 138       <description summary="surface visibility control">
 139        Show/Hide and Raise/Lower surface.
 140       </description>
 141       <arg name="surfaceid" type="uint"/>
 142       <arg name="visible" type="int"/>
 143       <arg name="raise" type="int"/>
 144       <arg name="flags" type="int"/>
 145     </request>
 146
 147     <request name="set_animation">
 148       <description summary="set surface animation type">
 149        Set surface animation type.
 150       </description>
 151       <arg name="surfaceid" type="uint"/>
 152       <arg name="type" type="int"/>
 153       <arg name="animation" type="string"/>
 154       <arg name="time" type="int"/>
 155     </request>
 156
 157     <request name="set_attributes">
 158       <description summary="set surface attributes">
 159        Set surface attributes.
 160       </description>
 161       <arg name="surfaceid" type="uint"/>
 162       <arg name="attributes" type="uint"/>
 163     </request>
 164
 165     <request name="visible_animation">
 166       <description summary="surface visibility control with animation">
 167        Show/Hide surface with Animation.
 168       </description>
 169       <arg name="surfaceid" type="uint"/>
 170       <arg name="visible" type="int"/>
 171       <arg name="x" type="int"/>
 172       <arg name="y" type="int"/>
 173       <arg name="width" type="int"/>
 174       <arg name="height" type="int"/>
 175     </request>
 176
 177     <request name="set_active">
 178       <description summary="set active surface">
 179        Set active surface.
 180       </description>
 181       <arg name="surfaceid" type="uint"/>
 182       <arg name="active" type="int"/>
 183     </request>
 184
 185     <request name="set_layer_visible">
 186       <description summary="layer visibility control">
 187        Show/Hide layer.
 188       </description>
 189       <arg name="layer" type="uint"/>
 190       <arg name="visible" type="int"/>
 191     </request>
 192
 193     <request name="get_surfaces">
 194       <description summary="get surfaces of the application">
 195        Get surfaces of the application.
 196       </description>
 197       <arg name="appid" type="string"/>
 198     </request>
 199
 200     <request name="map_surface">
 201       <description summary="shared surfaces to system application">
 202        Shared surfaces to system application(ex.HomeScreen).
 203       </description>
 204       <arg name="surfaceid" type="uint"/>
 205       <arg name="framerate" type="int"/>
 206     </request>
 207
 208     <request name="unmap_surface">
 209       <description summary="unshared surfaces">
 210        Unshared surfaces.
 211       </description>
 212       <arg name="surfaceid" type="uint"/>
 213     </request>
 214
 215     <event name="window_created">
 216       <description summary="event of surface created">
 217        Surface create event to manager.
 218       </description>
 219       <arg name="surfaceid" type="uint"/>
 220       <arg name="winname" type="string"/>
 221       <arg name="pid" type="int"/>
 222       <arg name="appid" type="string"/>
 223     </event>
 224
 225     <event name="window_name">
 226       <description summary="event of surface name">
 227        Surface name event to manager.
 228       </description>
 229       <arg name="surfaceid" type="uint"/>
 230       <arg name="winname" type="string"/>
 231     </event>
 232
 233     <event name="window_destroyed">
 234       <description summary="event of surface destoryed">
 235        Surface destory event to manager.
 236       </description>
 237       <arg name="surfaceid" type="uint"/>
 238     </event>
 239
 240     <event name="window_visible">
 241       <description summary="event of change surface visibility">
 242        Surface visibility change event to manager.
 243       </description>
 244       <arg name="surfaceid" type="uint"/>
 245       <arg name="visible" type="int"/>
 246       <arg name="raise" type="int"/>
 247       <arg name="hint" type="int"/>
 248     </event>
 249
 250     <event name="window_configure">
 251       <description summary="event of change surface attributes">
 252        Surface attribute change event to manager.
 253       </description>
 254       <arg name="surfaceid" type="uint"/>
 255       <arg name="node" type="uint"/>
 256       <arg name="layer" type="uint"/>
 257       <arg name="x" type="int"/>
 258       <arg name="y" type="int"/>
 259       <arg name="width" type="int"/>
 260       <arg name="height" type="int"/>
 261       <arg name="hint" type="int"/>
 262     </event>
 263
 264     <event name="window_active">
 265       <description summary="event of change surface active">
 266        Surface active change event to manager.
 267       </description>
 268       <arg name="surfaceid" type="uint"/>
 269       <arg name="active" type="int"/>
 270     </event>
 271
 272     <event name="layer_visible">
 273       <description summary="event of change layer visibility">
 274        Layer visibility change event to manager.
 275       </description>
 276       <arg name="layer" type="uint"/>
 277       <arg name="visible" type="int"/>
 278     </event>
 279
 280     <event name="app_surfaces">
 281       <description summary="event of reply of app_surfaces request">
 282        Reply of app_surfaces request.
 283       </description>
 284       <arg name="appid" type="string"/>
 285       <arg name="surfaces" type="array"/>
 286     </event>
 287
 288     <event name="map_surface">
 289       <description summary="event of shared surface">
 290        Event of shared surface.
 291       </description>
 292       <arg name="event" type="int"/>
 293       <arg name="surfaceid" type="uint"/>
 294       <arg name="type" type="uint"/>
 295       <arg name="target" type="uint"/>
 296       <arg name="width" type="int"/>
 297       <arg name="height" type="int"/>
 298       <arg name="stride" type="int"/>
 299       <arg name="format" type="uint"/>
 300     </event>
 301   </interface>
 302
 303 </protocol>
 304