Progress Control: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
>Martijn
No edit summary
 
(9 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<section begin="main content" />
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">
<syntaxhighlight lang="xml" enclose="div">
<control type="progress" id="12">
<control type="progress" id="12">
       <description>My first progress control</description>
       <description>My first progress control</description>
       <posx>80</posx>
       <left>80</left>
       <posy>60</posy>
       <top>60</top>
       <width>250</width>
       <width>250</width>
       <height>30</height>
       <height>30</height>
Line 17: Line 18:
       <info></info>
       <info></info>
</control>
</control>
</source>
</syntaxhighlight>


=== 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="wikitable"
{| class="prettytable"
! Tag !! Description
|-  
|-  
|  '''reveal'''
|  '''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)
|  If set to true the midtexture will reveal itself instead of stretching to fill the gap (works best when its the same size as texturebg)
|-  
|-  
|  '''texturebg'''
|  '''texturebg'''
Line 45: Line 47:
|  
|  
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.]]
|
|-
|  '''info2'''
|
Specifies the second piece of information that the progress bar is reporting on (PVR only). [[InfoLabels|See here for more information.]]
|}
|}


==See also==
<section end="main content" />
 
== See also ==
'''Development:'''
'''Development:'''
* [[Add-on development]]
* [[Add-on development]]
* [[Skinning]]
* [[Skinning]]


[[Category:Skin Development]]
[[Category:Skin development]]

Latest revision as of 21:57, 8 February 2019

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>
      <left>80</left>
      <top>60</top>
      <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.

Tag Description
reveal If set to true the midtexture will reveal itself instead of stretching to fill 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.

info2

Specifies the second piece of information that the progress bar is reporting on (PVR only). See here for more information.


See also

Development: