xbmc/pvr/guilib/GUIEPGGridContainer.dox

   1 /*!
   2
   3 \page EPGGrid_control EPGGrid control
   4 \brief **Used to display the EPG guide in the PVR section.**
   5
   6 \tableofcontents
   7
   8 The epggrid control is used for creating an epg timeline in Kodi. You can choose
   9 the position, size, and look of the grid and it's contents.
  10
  11
  12 --------------------------------------------------------------------------------
  13 \section EPGGrid_control_sect1 Example
  14
  15 ~~~~~~~~~~~~~
  16 <control type="epggrid" id="10">
  17     <description>EPG Grid</description>
  18     <posx>80</posx>
  19     <posy>81</posy>
  20     <width>1120</width>
  21     <height>555</height>
  22     <pagecontrol>10</pagecontrol>
  23     <scrolltime>350</scrolltime>
  24     <timeblocks>40</timeblocks>
  25     <rulerunit>6</rulerunit>
  26     <progresstexture border="5">PVR-EpgProgressIndicator.png</progresstexture>
  27     <orienttation>vertical</orientation>
  28     <onleft>31</onleft>
  29     <onright>31</onright>
  30     <onup>10</onup>
  31     <ondown>10</ondown>
  32     <rulerlayout height="35" width="40">
  33         <control type="image" id="1">
  34             <width>40</width>
  35             <height>29</height>
  36             <posx>0</posx>
  37             <posy>0</posy>
  38             <texture border="5">button-nofocus.png</texture>
  39         </control>
  40         <control type="label" id="2">
  41             <posx>10</posx>
  42             <posy>0</posy>
  43             <width>34</width>
  44             <height>29</height>
  45             <font>font12</font>
  46             <aligny>center</aligny>
  47             <selectedcolor>selected</selectedcolor>
  48             <align>left</align>
  49             <label>$INFO[ListItem.Label]</label>
  50         </control>
  51     </rulerlayout>
  52     <channellayout height="52" width="280">
  53         <animation effect="fade" start="110" time="200">UnFocus</animation>
  54         <control type="image" id="1">
  55             <posx>0</posx>
  56             <posy>0</posy>
  57             <width>270</width>
  58             <height>52</height>
  59             <texture border="5">button-nofocus.png</texture>
  60         </control>
  61         <control type="label">
  62             <posx>5</posx>
  63             <posy>5</posy>
  64             <width>40</width>
  65             <height>35</height>
  66             <font>font12</font>
  67             <align>left</align>
  68             <aligny>center</aligny>
  69             <textcolor>grey</textcolor>
  70             <selectedcolor>grey</selectedcolor>
  71             <info>ListItem.ChannelNumber</info>
  72         </control>
  73         <control type="image">
  74             <posx>45</posx>
  75             <posy>4</posy>
  76             <width>45</width>
  77             <height>44</height>
  78             <texture>$INFO[ListItem.Icon]</texture>
  79         </control>
  80         <control type="label" id="1">
  81             <posx>94</posx>
  82             <posy>0</posy>
  83             <width>160</width>
  84             <height>52</height>
  85             <font>special12</font>
  86             <aligny>center</aligny>
  87             <selectedcolor>selected</selectedcolor>
  88             <align>left</align>
  89             <label>$INFO[ListItem.ChannelName]</label>
  90         </control>
  91     </channellayout>
  92     <focusedchannellayout height="52" width="280">
  93         <animation effect="fade" start="110" time="200">OnFocus</animation>
  94         <control type="image" id="1">
  95             <posx>0</posx>
  96             <posy>0</posy>
  97             <width>270</width>
  98             <height>52</height>
  99             <texture border="5">button-focus.png</texture>
 100         </control>
 101         <control type="label">
 102             <posx>5</posx>
 103             <posy>5</posy>
 104             <width>40</width>
 105             <height>35</height>
 106             <font>font12</font>
 107             <align>left</align>
 108             <aligny>center</aligny>
 109             <textcolor>grey</textcolor>
 110             <selectedcolor>grey</selectedcolor>
 111             <info>ListItem.ChannelNumber</info>
 112         </control>
 113         <control type="image">
 114             <posx>45</posx>
 115             <posy>4</posy>
 116             <width>45</width>
 117             <height>44</height>
 118             <texture>$INFO[ListItem.Icon]</texture>
 119         </control>
 120         <control type="label" id="1">
 121             <posx>94</posx>
 122             <posy>0</posy>
 123             <width>160</width>
 124             <height>52</height>
 125             <font>special12</font>
 126             <aligny>center</aligny>
 127             <selectedcolor>selected</selectedcolor>
 128             <align>left</align>
 129             <label>$INFO[ListItem.ChannelName]</label>
 130         </control>
 131     </focusedchannellayout>
 132     <itemlayout height="52" width="40">
 133         <control type="image" id="2">
 134             <width>40</width>
 135             <height>52</height>
 136             <posx>0</posx>
 137             <posy>0</posy>
 138             <aspectratio>stretch</aspectratio>
 139             <texture border="3">epg-genres/$INFO[ListItem.Property(GenreType)].png</texture>
 140         </control>
 141         <control type="label" id="1">
 142             <posx>6</posx>
 143             <posy>3</posy>
 144             <width>30</width>
 145             <height>25</height>
 146             <font>font12</font>
 147             <aligny>center</aligny>
 148             <selectedcolor>selected</selectedcolor>
 149             <align>left</align>
 150             <info>ListItem.Label</info>
 151         </control>
 152         <control type="image">
 153             <posx>5</posx>
 154             <posy>28</posy>
 155             <width>30</width>
 156             <height>20</height>
 157             <texture>PVR-IsRecording.png</texture>
 158             <visible>ListItem.IsRecording</visible>
 159         </control>
 160         <control type="image">
 161             <posx>5</posx>
 162             <posy>28</posy>
 163             <width>20</width>
 164             <height>20</height>
 165             <texture>PVR-HasTimer.png</texture>
 166             <visible>ListItem.HasTimer + !ListItem.IsRecording</visible>
 167         </control>
 168     </itemlayout>
 169     <focusedlayout height="52" width="40">
 170         <control type="image" id="14">
 171             <width>40</width>
 172             <height>52</height>
 173             <posx>0</posx>
 174             <posy>0</posy>
 175             <texture border="5">folder-focus.png</texture>
 176         </control>
 177         <control type="image" id="2">
 178             <width>40</width>
 179             <height>52</height>
 180             <posx>0</posx>
 181             <posy>0</posy>
 182             <aspectratio>stretch</aspectratio>
 183             <texture border="3">epg-genres/$INFO[ListItem.Property(GenreType)].png</texture>
 184         </control>
 185         <control type="label" id="1">
 186             <posx>6</posx>
 187             <posy>3</posy>
 188             <width>30</width>
 189             <height>25</height>
 190             <font>font12</font>
 191             <aligny>center</aligny>
 192             <selectedcolor>selected</selectedcolor>
 193             <align>left</align>
 194             <info>ListItem.Label</info>
 195         </control>
 196         <control type="image">
 197             <posx>5</posx>
 198             <posy>28</posy>
 199             <width>30</width>
 200             <height>20</height>
 201             <texture>PVR-IsRecording.png</texture>
 202             <visible>ListItem.IsRecording</visible>
 203         </control>
 204         <control type="image">
 205             <posx>5</posx>
 206             <posy>28</posy>
 207             <width>20</width>
 208             <height>20</height>
 209             <texture>PVR-HasTimer.png</texture>
 210             <visible>ListItem.HasTimer + !ListItem.IsRecording</visible>
 211         </control>
 212     </focusedlayout>
 213 </control>
 214 ~~~~~~~~~~~~~
 215
 216
 217 --------------------------------------------------------------------------------
 218 \section EPGGrid_control_sect2 Available tags
 219
 220 In addition to the [Default Control Tags](http://kodi.wiki/view/Default_Control_Tags)
 221 the following tags are available. Note that each tag is **lower case** only. This is
 222 important, as `xml` tags are case-sensitive.
 223
 224 | Tag                   | Description                                                   |
 225 |----------------------:|:--------------------------------------------------------------|
 226 | timeblocks            | The number of timeframes on the ruler.
 227 | rulerunit             | Timeframe of each unit on ruler. 1 unit equals 5 minutes.
 228 | rulerdatelayout       | The layout of a ruler date item (usually used to display the start date of current epg page).
 229 | rulerlayout           | The layout of a ruler item.
 230 | progresstexture       | A texture which indicates the current progress time
 231 | channellayout         | The layout of a channel item.
 232 | focusedchannellayout  | The focused layout of a channel item.
 233 | itemlayout            | The layout of the grid
 234 | focusedlayout         | The focused layout of the grid
 235
 236
 237 --------------------------------------------------------------------------------
 238 \section EPGGrid_control_sect3 See also
 239
 240 #### Development:
 241
 242 - [Add-on development](http://kodi.wiki/view/Add-on_development)
 243 - [Skinning](http://kodi.wiki/view/Skinning)
 244
 245 */