Progress Control: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
>DonJ
No edit summary
>Jmarshall
No edit summary
Line 2: Line 2:
===Example===
===Example===
<xml>
<xml>
<control>
<control type="progress" id="12">
       <description>My first progress control</description>
       <description>My first progress control</description>
      <type>progress</type>
      <id>1</id>
       <posx>80</posx>
       <posx>80</posx>
       <posy>60</posy>
       <posy>60</posy>
Line 20: Line 18:
</xml>
</xml>
===Available Tags===
===Available Tags===
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="dtable"
|- class="userrow"
| class="usercell" | '''description'''
| class="usercell" | Only used to make things clear for the skinner. Not read by XBMC at all.
|- class="userrow"
| class="usercell" | '''type'''
| class="usercell" | Should be progress for a progress control.
|- class="userrow"
| class="usercell" | '''id'''
| class="usercell" | Specifies the control's id. The value this takes depends on the control type, and the window that you are using the control on. There are special control id's that must be present in each window. The progress control's id should be unique, except where the <info> tag is used to fill the contents.
|- class="userrow"
| class="usercell" | '''posx'''
| class="usercell" | Specifies where the left edge of the progress control should be drawn. This is offset from the window's coordinates (normally the left edge of the screen, or 0).
|- class="userrow"
| class="usercell" | '''posy'''
| class="usercell" | Specifies where the top edge of the progress control should be drawn. This is offset from the window's coordinates (normally the top edge of the screen, or 0).
|- class="userrow"
| class="usercell" | '''width'''
| class="usercell" | Specifies the width of the progress bar. The <texturebg> image will be scaled to fit this width, and all other images will be scaled by the same amount.
|- class="userrow"
| class="usercell" | '''height'''
| class="usercell" | Specifies the height of the progress bar. The <texturebg> image will be scaled to fit this height, and all other images will be scaled by the same amount.
|- class="userrow"
| class="usercell" | '''visible'''
| class="usercell" |
Specifies a condition as to when this control will be visible. Can be true, false, or a condition. [[Conditional Visibility|See here for more information.]] Defaults to true.
|- class="userrow"
| class="usercell" | '''animation'''
| class="usercell" |
Specifies the animation to be run when the control enters a particular state. [[Animating Your Skin|See here for more information.]]
|- class="userrow"
|- class="userrow"
| class="usercell" | '''texturebg'''
| class="usercell" | '''texturebg'''
| class="usercell" |
| class="usercell" |
Specifies the image file which should be displayed in the background of the progress control. You can use animated gif's, jpgs, pngs, or bmps. This should be the path to the image file from the media/ folder of your skin directory. XBMC will first look inside the compresses Textures.xpr file, and if not found, will look inside the media/ folder for the actual skin file. Compressing textures into Textures.xpr means far faster loading times.
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="userrow"
| class="usercell" | '''textureleft'''
| class="usercell" | '''textureleft'''

Revision as of 07:03, 24 July 2007

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

<xml> <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>
     <texturebg>mybackgroundtexture.png</texturebg>
     <textureleft>mydowntexture.png</textureleft>
     <texturemid>mymidtexture.png</texturemid>
     <textureright>myrighttexture.png</textureright>
     <textureoverlay>myoverlaytexture.png</textureoverlay>
     <info></info>

</control> </xml>

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.

texturebg

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

textureleft 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.
texturemid 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 <textureleft> texture, and fills the gap between the <textureleft> and <textureright> textures, depending on how far progressed the item is.
textureright 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.
textureoverlay 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.

Retrieved from "https://kodi.wiki/index.php?title=Progress_Control&oldid=7090"