Static List Content: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
m (formatting)
m (formatting)
Line 59: Line 59:
=== Plugin provided content ===
=== Plugin provided content ===
As of XBMC Gotham, it's also possible to fill list containers with content provided by a plugin:
As of XBMC Gotham, it's also possible to fill list containers with content provided by a plugin:
<source lang="xml">
 
<syntaxhighlight lang="XML" enclose="DIV">
<content target="video">plugin://plugin.test.me?arg1=foo</content>
<content target="video">plugin://plugin.test.me?arg1=foo</content>
</source>
</syntaxhighlight>


== See also ==
== See also ==

Revision as of 09:39, 12 March 2014

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.

Tag Description
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).

Plugin provided content

As of XBMC Gotham, it's also possible to fill list containers with content provided by a plugin:

<content target="video">plugin://plugin.test.me?arg1=foo</content>

See also

Development: