Progress Control: Difference between revisions
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> | ||
<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 | 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="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. | 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. |