xbmc/guilib/GUIListGroup.dox

   1 /*!
   2
   3 \page Group_List_Control Group List Control
   4 \brief **Special case of the group control that forms a scrolling list of controls.**
   5
   6 \tableofcontents
   7
   8 The group list control is a special case of the group control. It is used for
   9 placing a set of controls into a list (either horizontally or vertically) and
  10 handles all the navigation within the list and placement within the list for
  11 you. It will be scrollable if the number of items exceeds the size of the
  12 list, and you can assign a scrollbar to it just like you can to any of the
  13 containers (list, panel, etc.).
  14
  15
  16 --------------------------------------------------------------------------------
  17 \section Group_List_Control_sect1 Example
  18
  19 ~~~~~~~~~~~~~
  20 <control type="grouplist" id="17">
  21       <description>My first group list control</description>
  22       <posx>80</posx>
  23       <posy>60</posy>
  24       <width>250</width>
  25       <height>300</height>
  26       <itemgap>10</itemgap>
  27       <pagecontrol>25</pagecontrol>
  28       <scrolltime tween="sine" easing="out">200</scrolltime>
  29       <orientation>vertical</orientation>
  30       <usecontrolcoords>false</usecontrolcoords>
  31       <visible>true</visible>
  32       <onup>2</onup>
  33       <ondown>3</ondown>
  34       <onleft>1</onleft>
  35       <onright>1</onright>
  36       <align>right</align>
  37 </control>
  38 ~~~~~~~~~~~~~
  39
  40
  41 --------------------------------------------------------------------------------
  42 \section Group_List_Control_sect2 Available tags
  43
  44 In addition to the [Default Control Tags](http://kodi.wiki/view/Default_Control_Tags)
  45 the following tags are available. Note that each tag is **lower case** only. This is
  46 important, as `xml` tags are case-sensitive.
  47
  48 | Tag               | Description                                                   |
  49 |------------------:|:--------------------------------------------------------------|
  50 | itemgap           | Specifies the gap (in pixels) between controls in the list. Defaults to 5px.
  51 | orientation       | Specifies whether the list is horizontal or vertical. Defaults to vertical.
  52 | pagecontrol       | Specifies the page control used to scroll up and down the list. Set the page control's id here.
  53 | scrolltime        | The time (in ms) to scroll from one item to another. By default, this is 200ms. The list will scroll smoothly from one item to another as needed. Set it to zero to disable the smooth scrolling. The scroll movement can be further adjusted by selecting one of the available [tween](http://kodi.wiki/view/Tweeners) methods.
  54 | usecontrolcoords  | Specifies whether the list should use the control's coordinates as an offset location from the coordinates it would normally use to draw the control. Defaults to false. Useful for staggering a control in from the edge of the grouplist, or for having more space around a control than <c>`<itemgap>`</c> gives.
  55 | align             | Specifies how to align the grouplist. possible values: left, right, center, justify. defaults to left.
  56
  57
  58 --------------------------------------------------------------------------------
  59 \section Group_List_Control_sect3 See also
  60
  61 #### Development:
  62
  63 - [Add-on development](http://kodi.wiki/view/Add-on_development)
  64 - [Skinning](http://kodi.wiki/view/Skinning)
  65
  66
  67 */