Progress Control: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
>Hitcher
>NedBot
m (Wikitable class; cosmetic changes)
Line 1: Line 1:
The progress control is used to show the progress of an item that may take a long time, or to show how far through a movie you are. You can choose the position, size, and look of the progress control.
The progress control is used to show the progress of an item that may take a long time, or to show how far through a movie you are. You can choose the position, size, and look of the progress control.
===Example===
=== Example ===
<source lang="xml">
<source lang="xml">
<control type="progress" id="12">
<control type="progress" id="12">
Line 19: Line 19:
</source>
</source>


===Available Tags===
=== Available Tags ===
In addition to the [[Default Control Tags]] the following tags are available. Note that each tag is '''lower case''' only. This is important, as xml tags are case-sensitive.
In addition to the [[Default Control Tags]] the following tags are available. Note that each tag is '''lower case''' only. This is important, as xml tags are case-sensitive.
{| class="dtable"
{| class="wikitable"
|- class="userrow"
|-  
| class="usercell" | '''reveal'''
| '''reveal'''
| class="usercell" | If set to true the midtexture will reveal itself instead of stretching to file the gap (works best when its the same size as texturebg)
| If set to true the midtexture will reveal itself instead of stretching to file the gap (works best when its the same size as texturebg)
|- class="userrow"
|-  
| class="usercell" | '''texturebg'''
| '''texturebg'''
| class="usercell" |
|  
Specifies the image file which should be displayed in the background of the progress control. [[Texture Attributes|See here for additional information about textures.]]
Specifies the image file which should be displayed in the background of the progress control. [[Texture Attributes|See here for additional information about textures.]]
|- class="userrow"
|-  
| class="usercell" | '''lefttexture'''
| '''lefttexture'''
| class="usercell" | Specifies the image file which should be displayed for the left side of the progress bar. This is rendered on the left side of the bar.
| Specifies the image file which should be displayed for the left side of the progress bar. This is rendered on the left side of the bar.
|- class="userrow"
|-  
| class="usercell" | '''midtexture'''
| '''midtexture'''
| class="usercell" | Specifies the image file which should be displayed for the middle portion of the progress bar. This is the “fill” texture used to fill up the bar. It's positioned on the right of the <lefttexture> texture, and fills the gap between the <lefttexture> and <righttexture> textures, depending on how far progressed the item is.
| Specifies the image file which should be displayed for the middle portion of the progress bar. This is the “fill” texture used to fill up the bar. It's positioned on the right of the <lefttexture> texture, and fills the gap between the <lefttexture> and <righttexture> textures, depending on how far progressed the item is.
|- class="userrow"
|-  
| class="usercell" | '''righttexture'''
| '''righttexture'''
| class="usercell" | Specifies the image file which should be displayed for the right side of the progress bar. This is rendered on the right side of the bar.
| Specifies the image file which should be displayed for the right side of the progress bar. This is rendered on the right side of the bar.
|- class="userrow"
|-  
| class="usercell" | '''overlaytexture'''
| '''overlaytexture'''
| class="usercell" | Specifies the image file which should be displayed over the top of all other images in the progress bar. It is centered vertically and horizontally within the space taken up by the background image.
| Specifies the image file which should be displayed over the top of all other images in the progress bar. It is centered vertically and horizontally within the space taken up by the background image.
|- class="userrow"
|-  
| class="usercell" | '''info'''
| '''info'''
| class="usercell" |
|  
Specifies the information that the progress bar is reporting on. [[InfoLabels|See here for more information.]]
Specifies the information that the progress bar is reporting on. [[InfoLabels|See here for more information.]]
|}
|}
[[category:Skin Development]]
 
[[Category:Skin Development]]

Revision as of 07:53, 26 November 2011

The progress control is used to show the progress of an item that may take a long time, or to show how far through a movie you are. You can choose the position, size, and look of the progress control.

Example

<control type="progress" id="12">
      <description>My first progress control</description>
      <posx>80</posx>
      <posy>60</posy>
      <width>250</width>
      <height>30</height>
      <visible>true</visible>
      <reveal>false</reveal>
      <texturebg>mybackgroundtexture.png</texturebg>
      <lefttexture>mydowntexture.png</lefttexture>
      <midtexture>mymidtexture.png</midtexture>
      <righttexture>myrighttexture.png</righttexture>
      <overlaytexture>myoverlaytexture.png</overlaytexture>
      <info></info>
</control>

Available Tags

In addition to the Default Control Tags the following tags are available. Note that each tag is lower case only. This is important, as xml tags are case-sensitive.

reveal If set to true the midtexture will reveal itself instead of stretching to file the gap (works best when its the same size as texturebg)
texturebg

Specifies the image file which should be displayed in the background of the progress control. See here for additional information about textures.

lefttexture Specifies the image file which should be displayed for the left side of the progress bar. This is rendered on the left side of the bar.
midtexture Specifies the image file which should be displayed for the middle portion of the progress bar. This is the “fill” texture used to fill up the bar. It's positioned on the right of the <lefttexture> texture, and fills the gap between the <lefttexture> and <righttexture> textures, depending on how far progressed the item is.
righttexture Specifies the image file which should be displayed for the right side of the progress bar. This is rendered on the right side of the bar.
overlaytexture Specifies the image file which should be displayed over the top of all other images in the progress bar. It is centered vertically and horizontally within the space taken up by the background image.
info

Specifies the information that the progress bar is reporting on. See here for more information.