Description

A simple progressbar control to show the progress of an operation or item.

Images

Changelog

Change	Date	Version
Progressbar use only middle Texture	2011/01/23	1.1.0 to 1.2.0

Tags

Progress

Element Name	Data Type	Description
label	Float	The length of the progress bar, expressed as a percentage (0.0 to 100.0). Example: <label>#TV.TuningDetails.SignalLevel</label>
texturebg	String	The background image for the progress bar. The position and size of this image are specified by the <posX>, <posY>, <width>, and <height> tags.
onlymidtexture	String	This controls whether <lefttexture> and <righttexture> are ignored ("yes"), or used ("no"). If "yes" is specified, only <midtexture> is used. The default is "no". Example: <onlymidtexture>yes</onlymidtexture>
midheight	Integer	The height of the bar (ignored if <onlymidtexture> is "no").
midwidth	Integer	The width of the bar (ignored if <onlymidtexture> is "no").
midoffsetX	Integer	The x offset of the start of the bar from the start of the background (ignored if <onlymidtexture> is "no").
midoffsetY	Integer	The y offset of the start of the bar from the start of the background (ignored if <onlymidtexture> is "no").
lefttexture	String	The texture that provides the left end of the progress bar. Example: a shaded semicircle that provides a rounded end to the bar, instead of a straight end.
midtexture	String	The texture that provides the main body of the progress bar.
righttexture	String	The texture that provides the right end of the progress bar. Example: a shaded semicircle that provides a rounded end to the bar, instead of a straight end.
innerheight	Integer	The height of the bar within the background. The bar is centered vertically within the background (ignored if <onlymidtexture> is "yes").
offset	Integer	The x offset of the start of the bar from the start of the background (ignored if <onlymidtexture> is "yes").

Inherited by Control

See GUIControl for the full documentation of this control.

Element Name	Data Type	Description
id	Integer	The id of the control. The id will couple the skin file to the code, so if we later on want to check that a user pressed a button, the id will be required and must be unique. For controls that will never be referenced in the code it is safe to set it to "1"
description	String	An optional description of the control for your reference
type	String	The type of the control, for instance "button", "label", "textbox" and all other controls.
posX	Integer	The X-position on the window for this control
posY	Integer	The Y-position on the window for this control
width	Integer	The width of this control
height	Integer	The height of this control
onleft	Integer	The control id to move the focus to when the user moves left. If not specified (or zero) MediaPortal will find the closest control in that direction to move to. As of v1.7.0 Skin Settings and Skin Expressions are also supported.
onright	Integer	The control id to move the focus to when the user moves right. If not specified (or zero) MediaPortal will find the closest control in that direction to move to. As of v1.7.0 Skin Settings and Skin Expressions are also supported.
onup	Integer	The control id to move the focus to when the user moves up. If not specified (or zero) MediaPortal will find the closest control in that direction to move to. As of v1.7.0 Skin Settings and Skin Expressions are also supported.
ondown	Integer	The control id to move the focus to when the user moves down. If not specified (or zero) MediaPortal will find the closest control in that direction to move to. As of v1.7.0 Skin Settings and Skin Expressions are also supported.
colordiffuse	Long	Allows you to mix a color & a graphics texture. E.g. If you have a graphics texture like a blue button you can mix it with a yellow color diffuse and the end result will be green. Defaults to 0xFFFFFFFF
dimColor	Integer	Color for a control when it is not focussed. Defaults to half transparent (0x60ffffff)
onfocus	String	[Since 1.3] Executes a MediaPortal skin function when the control gains focus. See Skin Settings for more information.

XML Examples

Simple example

<control>
  <type>progress</type>
  <id>104</id>
  <posX>533</posX>
  <posY>650</posY>
  <width>622</width>
</control>

Example using <onlymidtexture>

<control>
      <description>Progress Bar</description>
      <type>progress</type>
      <id>20</id>
      <posX>530</posX>
      <posY>45</posY>
      <width>140</width>
      <height>20</height>
      <label>-</label>
      <texturebg>background.png</texturebg>
      <onlymidtexture>yes</onlymidtexture>
      <midwidth>134</midwidth>
      <midheight>14</midheight>
      <midoffsetX>3</midoffsetX>
      <midoffsetY>3</midoffsetY>
      <midtexture>mid.png</midtexture>
      <visible>yes</visible>
</control>

Example not using <onlymidtexture>

<control>
  <description>Signal-level progress bar</description>
  <type>progress</type>
  <id>0</id>
  <posX>550</posX>
  <posY>553</posY>
  <width>550</width>
  <height>20</height>
  <innerheight>16</innerheight>
  <offset>2</offset>
  <texturebg>progress_background.png</texturebg>
  <lefttexture>progress_left.png</lefttexture>
  <midtexture>progress_mid.png</midtexture>
  <righttexture>progress_right.png</righttexture>
  <label>#TV.TuningDetails.SignalLevel</label>
</control>

The example above produces the signal-level progress bar shown in the following screen shot; the other progress bars are produced by similar xml definitions:

Seitenhierarchie