Difference between revisions of "Settings-ui.xml"

From MythTV Official Wiki
Jump to: navigation, search
m
(Added the theme chooser window.)
 
Line 1: Line 1:
−
The settings-ui.xml file governs the layout and behavior of the System Event Editor.  It consists of the following windows and named attributes:
+
The settings-ui.xml file governs the layout and behavior of the Theme Chooser screen and the System Event Editor.  It consists of the following windows and named attributes:
  
−
= System Event Editor Windows =
+
= Settings Windows =
 
<center>
 
<center>
 
{| cellpadding="4" border="1"
 
{| cellpadding="4" border="1"
Line 7: Line 7:
 
| align="center"  |<b>Type</b>  
 
| align="center"  |<b>Type</b>  
 
| align="center"  |<b>Description</b>  
 
| align="center"  |<b>Description</b>  
 +
|-
 +
| style="background:silver" | themechooser
 +
| style="background:silver" align="center" | Window
 +
| style="background:silver" | The Theme Chooser screen.
 
|-  
 
|-  
 
| style="background:silver" | rawsettingseditor
 
| style="background:silver" | rawsettingseditor
Line 13: Line 17:
 
|}
 
|}
  
 +
 +
=== The "themechooser" window ===
 +
 +
{| cellpadding="4" border="1"
 +
| align="center"  |<b>Widget Name</b>
 +
| align="center"  |<b>Widget Type</b>
 +
| align="center"  |<b>Description</b>
 +
| align="center"  |<b>Required?</b>
 +
|-
 +
| style="background:darkturquoise" | themes
 +
| style="background:darkturquoise" align="center" | buttonlist
 +
| style="background:darkturquoise" | A buttonlist containing all the available themes.
 +
| style="background:darkturquoise" align="center" | <b>Yes</b>
 +
|-
 +
| name
 +
| align="center"  | textarea
 +
| The theme's name.
 +
| align="center"  | No
 +
|-
 +
| style="background:darkturquoise" | version
 +
| style="background:darkturquoise" align="center"  | textarea
 +
| style="background:darkturquoise" | The theme's version number.
 +
| style="background:darkturquoise" align="center"  | No
 +
|-
 +
| description
 +
| align="center"  | textarea
 +
| The theme's description.
 +
| align="center"  | No
 +
|-
 +
| style="background:darkturquoise" | resolution
 +
| style="background:darkturquoise" align="center"  | textarea
 +
| style="background:darkturquoise" | The screen resolution for which the theme is designed. For example, 1920x1080.
 +
| style="background:darkturquoise" align="center"  | No
 +
|-
 +
| aspect
 +
| align="center"  | textarea
 +
| The aspect ratio for which the theme is designed. For example, 16:9.
 +
| align="center"  | No
 +
|-
 +
| style="background:darkturquoise" | authorname
 +
| style="background:darkturquoise" align="center"  | textarea
 +
| style="background:darkturquoise" | The theme author's name.
 +
| style="background:darkturquoise" align="center"  | No
 +
|-
 +
| authoremail
 +
| align="center"  | textarea
 +
| The theme author's email address.
 +
| align="center"  | No
 +
|-
 +
| style="background:darkturquoise" | errata
 +
| style="background:darkturquoise" align="center"  | textarea
 +
| style="background:darkturquoise" | The theme's errata.
 +
| style="background:darkturquoise" align="center"  | No
 +
|-
 +
| preview
 +
| align="center"  | imagetype
 +
| An image showing a preview of the theme's appearance.
 +
| align="center"  | No
 +
|-
 +
| style="background:darkturquoise" | downloadprogressbar
 +
| style="background:darkturquoise" align="center"  | progressbar
 +
| style="background:darkturquoise" | A progress bar showing the download progress while a remote theme is being downloaded.
 +
| style="background:darkturquoise" align="center"  | No
 +
|-
 +
| themestatus
 +
| align="center"  | statetype
 +
| A statetype representing whether updates are available for the theme. The available states are <i>uptodate</i> and <i>updateavailable</i>.
 +
| align="center"  | No
 +
|-
 +
| style="background:darkturquoise" | themelocation
 +
| style="background:darkturquoise" align="center"  | statetype
 +
| style="background:darkturquoise" | A statetype representing where the theme is stored. The available states are <i>local</i>, for themes that are installed locally, and <i>remote</i>, for themes that are available on the theme server and must be downloaded.
 +
| style="background:darkturquoise" align="center"  | No
 +
|-
 +
| fullpreviewstate
 +
| align="center"  | statetype
 +
| A statetype representing whether a full screen preview for the theme is being displayed. The available state is <i>fullscreen</i>. When the <i>fullscreen</i> state is present, a new entry is added to the theme chooser menu that allows the user to display a full screen preview of the selected theme. The contents of this state control the appearance of the full screen preview.
 +
| align="center"  | No
 +
|-
 +
| style="background:darkturquoise" | fullscreenname
 +
| style="background:darkturquoise" align="center"  | textarea
 +
| style="background:darkturquoise" | The theme's name, intended to be used within fullpreviewstate.
 +
| style="background:darkturquoise" align="center"  | No
 +
|-
 +
| fullscreenpreview
 +
| align="center"  | imagetype
 +
| An image showing a preview of the theme's appearance, intended to be used within fullpreviewstate.
 +
| align="center"  | No
 +
|}
  
 
=== The "rawsettingseditor" window ===
 
=== The "rawsettingseditor" window ===

Latest revision as of 19:19, 2 September 2013

The settings-ui.xml file governs the layout and behavior of the Theme Chooser screen and the System Event Editor. It consists of the following windows and named attributes:

Settings Windows

Window Name Type Description
themechooser Window The Theme Chooser screen.
rawsettingseditor Window The System Event Editor screen.


The "themechooser" window

Widget Name Widget Type Description Required?
themes buttonlist A buttonlist containing all the available themes. Yes
name textarea The theme's name. No
version textarea The theme's version number. No
description textarea The theme's description. No
resolution textarea The screen resolution for which the theme is designed. For example, 1920x1080. No
aspect textarea The aspect ratio for which the theme is designed. For example, 16:9. No
authorname textarea The theme author's name. No
authoremail textarea The theme author's email address. No
errata textarea The theme's errata. No
preview imagetype An image showing a preview of the theme's appearance. No
downloadprogressbar progressbar A progress bar showing the download progress while a remote theme is being downloaded. No
themestatus statetype A statetype representing whether updates are available for the theme. The available states are uptodate and updateavailable. No
themelocation statetype A statetype representing where the theme is stored. The available states are local, for themes that are installed locally, and remote, for themes that are available on the theme server and must be downloaded. No
fullpreviewstate statetype A statetype representing whether a full screen preview for the theme is being displayed. The available state is fullscreen. When the fullscreen state is present, a new entry is added to the theme chooser menu that allows the user to display a full screen preview of the selected theme. The contents of this state control the appearance of the full screen preview. No
fullscreenname textarea The theme's name, intended to be used within fullpreviewstate. No
fullscreenpreview imagetype An image showing a preview of the theme's appearance, intended to be used within fullpreviewstate. No

The "rawsettingseditor" window

Widget Name Widget Type Description Required?
settings buttonlist A buttonlist containing all the available system events. Yes
label-text textarea A label for the currently selected event item. Yes
settingvalue textedit An editor to change the command invoked for the selected system event. Yes
save button The "Save" button. Yes
cancel button The "Cancel" button. Yes
heading textarea The page title. No
Retrieved from "http://www.mythtv.org/wiki?title=Settings-ui.xml&oldid=58985"