Progress Control

From DevWiki

Jump to: navigation, search

Applications,Boxee GUI API,Controls

Contents


Overview

Progress control is used to show progress of items durations, specifically its mostly used as a time counter. The progress can be customized for position, size and looks. In the future the API will allow control of the progress control from python scripts.


Example

  1. <control type="progress">
  2.    <posx>117</posx>
  3.    <posy>5</posy>
  4.    <width>830</width>
  5.    <height>14</height>
  6.    <info>Player.progresscache</info>
  7.    <texturebg border="7">osd_time_indicator.png</texturebg>
  8.    <lefttexture>time_indicator_buffering_left.png</lefttexture>
  9.    <midtexture>time_indicator_buffering.png</midtexture>
  10.    <righttexture>time_indicator_buffering_right.png</righttexture>
  11.    <overlaytexture>-</overlaytexture>
  12. </control>


Available Tags

In addition to the Default Control Properties the following tags are available. Note that all XML tags are in lower case.

Element Description Required
reveal If set to true the texturemid will reveal itself instead of stretching to file the gap (works best when its the same size as texturebg). No
texturebg Specifies the image file which should be displayed in the background of the progress control. No
textureleft pecifies 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. No
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. No
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. No
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. No
info Specifies the information that the progress bar is reporting on. Yes
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox