Static List Content: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
>Ronie
No edit summary
>NedBot
m (Wikitable class; cosmetic changes)
Line 1: Line 1:
Container controls (the [[List Container]], [[Fixed List Container]], [[Wrap List Container]], and [[Panel Container]]) can be setup by the skinner with some predefined static content. This is done by including the <content> tag in the control. This allows skinners to have lists (or panels) of buttons wherever they want in the skin. The content below could be made separate in a different file for user editting, allowing users to have control over what goes on their home page for instance. You can use <defaultcontrol [always="true"]>id</defaultcontrol> to control which item in the list gets focssed by default.
Container controls (the [[List Container]], [[Fixed List Container]], [[Wrap List Container]], and [[Panel Container]]) can be setup by the skinner with some predefined static content. This is done by including the <content> tag in the control. This allows skinners to have lists (or panels) of buttons wherever they want in the skin. The content below could be made separate in a different file for user editting, allowing users to have control over what goes on their home page for instance. You can use <defaultcontrol [always="true"]>id</defaultcontrol> to control which item in the list gets focssed by default.


===Example===
=== Example ===
<source lang="xml">
<source lang="xml">
<content>
<content>
Line 26: Line 26:
</source>
</source>


===Available tags===
=== Available tags ===
The available XML tags for each item are as follows. Note that, as always, they're lower-case only, as XML is case-sensitive.
The available XML tags for each item are as follows. Note that, as always, they're lower-case only, as XML is case-sensitive.
{| class="dtable"
{| class="wikitable"
|- class="userrow"
|-  
| class="usercell" | '''id'''
| '''id'''
| class="usercell" | The id of the item.  Useful for external visibility conditions such as Container.HasFocus(3).
| The id of the item.  Useful for external visibility conditions such as Container.HasFocus(3).
|- class="userrow"
|-  
| class="usercell" | '''label'''
| '''label'''
| class="usercell" | The main label of the item.  You can reference this within the [[Container Item Layout|<itemlayout>]] of the list via ListItem.Label.
| The main label of the item.  You can reference this within the [[Container Item Layout|<itemlayout>]] of the list via ListItem.Label.
|- class="userrow"
|-  
| class="usercell" | '''label2'''
| '''label2'''
| class="usercell" | The secondary label of the item.  You can reference this within the [[Container Item Layout|<itemlayout>]] of the list via ListItem.Label2.
| The secondary label of the item.  You can reference this within the [[Container Item Layout|<itemlayout>]] of the list via ListItem.Label2.
|- class="userrow"
|-  
| class="usercell" | '''icon'''
| '''icon'''
| class="usercell" | The icon of the item.  You can reference this within the [[Container Item Layout|<itemlayout>]] of the list via ListItem.Icon, or ListItem.ActualIcon.
| The icon of the item.  You can reference this within the [[Container Item Layout|<itemlayout>]] of the list via ListItem.Icon, or ListItem.ActualIcon.
|- class="userrow"
|-  
| class="usercell" | '''thumb'''
| '''thumb'''
| class="usercell" | The thumbnail image of the item.  You can reference this within the [[Container Item Layout|<itemlayout>]] of the list via ListItem.Thumb.
| The thumbnail image of the item.  You can reference this within the [[Container Item Layout|<itemlayout>]] of the list via ListItem.Thumb.
|- class="userrow"
|-  
| class="usercell" | '''onclick'''
| '''onclick'''
| class="usercell" | The action to be performed when this item is clicked. Should be a built in function. [[Built-in functions available to FTP, Webserver, skins, keymap and to python|See here for more information.]]
| The action to be performed when this item is clicked. Should be a built in function. [[Built-in functions available to FTP, Webserver, skins, keymap and to python|See here for more information.]]
|- class="userrow"
|-  
| class="usercell" | <strong>visible</strong>
| '''visible'''
| class="usercell" | Specifies a condition as to when this item will be visible within the container. Can be true, false, or a condition. [[Conditional Visibility|See here for&nbsp;more information.]]  Defaults to true.
| Specifies a condition as to when this item will be visible within the container. Can be true, false, or a condition. [[Conditional Visibility|See here for&nbsp;more information.]]  Defaults to true.
|- class="userrow"
|-  
| class="usercell" | <strong>property</strong>
| '''property'''
| class="usercell" | Property of the item. You can reference this within the [[Container Item Layout|<itemlayout>]] of the list via ListItem.Property(name).
| Property of the item. You can reference this within the [[Container Item Layout|<itemlayout>]] of the list via ListItem.Property(name).
|}
|}
[[category:Skin Development]]
 
[[Category:Skin Development]]

Revision as of 07:54, 26 November 2011

Container controls (the List Container, Fixed List Container, Wrap List Container, and Panel Container) can be setup by the skinner with some predefined static content. This is done by including the <content> tag in the control. This allows skinners to have lists (or panels) of buttons wherever they want in the skin. The content below could be made separate in a different file for user editting, allowing users to have control over what goes on their home page for instance. You can use <defaultcontrol [always="true"]>id</defaultcontrol> to control which item in the list gets focssed by default.

Example

<content>
  <item id="1">
    <label>My First Item</label>
    <label2>Label 2</label2>
    <icon>icon1.png</icon>
    <thumb>thumb1.png</thumb>
    <onclick>ActivateWindow(Home)</onclick>
    <visible>true</visible>
    <property name="foo">Some1stValueHere</property>
    <property name="foo2">Some2ndValueHere</property>
  </item>
  <item id="2">
    <label>My Second Item</label>
    <label2>Label 2</label2>
    <icon>icon2.png</icon>
    <thumb>thumb2.png</thumb>
    <onclick>ActivateWindow(MyMusicLibrary)</onclick>
    <property name="foo">Some1stValueHere</property>
    <property name="foo2">Some2ndValueHere</property>
  </item>
</content>

Available tags

The available XML tags for each item are as follows. Note that, as always, they're lower-case only, as XML is case-sensitive.

id The id of the item. Useful for external visibility conditions such as Container.HasFocus(3).
label The main label of the item. You can reference this within the <itemlayout> of the list via ListItem.Label.
label2 The secondary label of the item. You can reference this within the <itemlayout> of the list via ListItem.Label2.
icon The icon of the item. You can reference this within the <itemlayout> of the list via ListItem.Icon, or ListItem.ActualIcon.
thumb The thumbnail image of the item. You can reference this within the <itemlayout> of the list via ListItem.Thumb.
onclick The action to be performed when this item is clicked. Should be a built in function. See here for more information.
visible Specifies a condition as to when this item will be visible within the container. Can be true, false, or a condition. See here for more information. Defaults to true.
property Property of the item. You can reference this within the <itemlayout> of the list via ListItem.Property(name).