Difference between revisions of "Config-ui.xml"

From MythTV Official Wiki
Jump to: navigation, search
(Document new changes)
(Add the guistartup window)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
The config-ui.xml file governs the layout and behavior of multiple screens in various parts of MythTV.  As configuration screens are gradually converted to MythUI, this file will take on more and more importance.  It consists of the following windows and named attributes:
 
The config-ui.xml file governs the layout and behavior of multiple screens in various parts of MythTV.  As configuration screens are gradually converted to MythUI, this file will take on more and more importance.  It consists of the following windows and named attributes:
  
−
= Screen Wizard Windows =
+
== Windows ==
 
<center>
 
<center>
 
{| cellpadding="4" border="1"
 
{| cellpadding="4" border="1"
Line 16: Line 16:
 
|The Channel Editor screen in mythtv-setup.
 
|The Channel Editor screen in mythtv-setup.
 
|-  
 
|-  
−
| style="background:silver" | osdmenueditor
+
| style="background:silver" | languageselection
 
| style="background:silver" align="center" | Window
 
| style="background:silver" align="center" | Window
−
| style="background:silver" | The On Screen Display Menu Editor.
+
| style="background:silver" | Language selection.
 +
|-
 +
|grabbersettings
 +
|Window
 +
|The information and artwork screen in MythFrontend.
 +
|-
 +
| style="background:silver" | generalwizard
 +
| style="background:silver" align="center" | Window
 +
| style="background:silver" | The general wizard screen in MythFrontend.
 +
|-
 +
|audiowizard
 +
|Window
 +
|The audio wizard in MythFrontend.
 +
|-
 +
| style="background:silver" | videowizard
 +
| style="background:silver" align="center" | Window
 +
| style="background:silver" | The video wizard screen in MythFrontend.
 +
|-
 +
|backendselection
 +
|Window
 +
|The backend selection screen.
 +
|-
 +
| style="background:silver" |guistartup
 +
| style="background:silver" |Window
 +
| style="background:silver" |Startup Window in all GUI programs, only displayed if connection to the backend or database cannot be established.
 
|}
 
|}
−
 
  
 
=== The "iconimport" window ===
 
=== The "iconimport" window ===
Line 155: Line 178:
 
|}
 
|}
  
−
=== The "osdmenueditor" window ===
+
=== The "languageselection" window ===
  
 
{| cellpadding="4" border="1"
 
{| cellpadding="4" border="1"
Line 163: Line 186:
 
| align="center"  |<b>Required?</b>
 
| align="center"  |<b>Required?</b>
 
|-  
 
|-  
−
| style="background:darkturquoise" | states
+
| style="background:darkturquoise" | countries
 
| style="background:darkturquoise" align="center" | buttonlist
 
| style="background:darkturquoise" align="center" | buttonlist
−
| style="background:darkturquoise" | A button list of video playback modes.
+
| style="background:darkturquoise" | A list of potential countries.
 +
'''Mapped Items'''
 +
buttontext - the english country name
 +
buttonimage - country flag image loaded from 'locale/country_code.png'
 +
country - the english country name
 +
nativecountry - the native country name
 +
| style="background:darkturquoise" align="center" | <b>Yes</b>
 +
|-
 +
| languages
 +
| align="center"  | textedit
 +
| A list of potential languages.
 +
'''Mapped Items'''
 +
buttontext - the native language name
 +
language - the english language name
 +
nativelanguage - the native language name
 +
| align="center"  | <b>Yes</b>
 +
|-
 +
| style="background:darkturquoise" | save
 +
| style="background:darkturquoise" align="center" | buttom
 +
| style="background:darkturquoise" | "Save" button.
 
| style="background:darkturquoise" align="center" | <b>Yes</b>
 
| style="background:darkturquoise" align="center" | <b>Yes</b>
 
|-  
 
|-  
−
| categories
+
| cancel
 +
| align="center"  | button
 +
| "Cancel" button.
 +
| align="center"  | <b>Yes</b>
 +
|}
 +
 
 +
=== The "grabbersettings" 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" | moviegrabber
 +
| style="background:darkturquoise" align="center" | buttonlist
 +
| style="background:darkturquoise" | A list of potential movie grabbers.
 +
| style="background:darkturquoise" align="center" | <b>Yes</b>
 +
|-
 +
| tvgrabber
 
| align="center"  | buttonlist
 
| align="center"  | buttonlist
−
| A button list to limit menu options in the given playback mode.
+
| A button list of potential tv grabbers.
 
| align="center"  | <b>Yes</b>
 
| align="center"  | <b>Yes</b>
 
|-  
 
|-  
−
| style="background:darkturquoise" | done
+
| style="background:darkturquoise" | gamegrabber
 +
| style="background:darkturquoise" align="center" | buttonlist
 +
| style="background:darkturquoise" | A list of potential video game grabbers.
 +
| style="background:darkturquoise" align="center" | <b>Yes</b>
 +
|-
 +
| dailyupdates
 +
| align="center"  | checkBox
 +
| Enable/disable daily updates of recording artwork.
 +
| align="center"  | <b>Yes</b>
 +
|-
 +
| style="background:darkturquoise" | cancel
 +
| style="background:darkturquoise" align="center" | buttom
 +
| style="background:darkturquoise" | "Cancel" button.
 +
| style="background:darkturquoise" align="center" | <b>Yes</b>
 +
|-
 +
| ok
 +
| align="center"  | button
 +
| "OK" button.
 +
| align="center"  | <b>Yes</b>
 +
|}
 +
 
 +
=== The "generalwizard" 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" | submit
 
| style="background:darkturquoise" align="center" | button
 
| style="background:darkturquoise" align="center" | button
−
| style="background:darkturquoise" | Save Changes.
+
| style="background:darkturquoise" | The button used to submit the hardware profile.
 +
| style="background:darkturquoise" align="center" | <b>Yes</b>
 +
|-
 +
| view
 +
| align="center"  | button
 +
| The button used to view the hardware profile.
 +
| align="center"  | <b>Yes</b>
 +
|-
 +
| style="background:darkturquoise" | delete
 +
| style="background:darkturquoise" align="center" | button
 +
| style="background:darkturquoise" | The button used to delete the hardware profile.
 +
| style="background:darkturquoise" align="center" | <b>Yes</b>
 +
|-
 +
| cancel
 +
| align="center"  | button
 +
| "Cancel" button.
 +
| align="center"  | <b>Yes</b>
 +
|-
 +
| style="background:darkturquoise" | next
 +
| style="background:darkturquoise" align="center" | button
 +
| style="background:darkturquoise" | "Next" button.
 +
| style="background:darkturquoise" align="center" | <b>Yes</b>
 +
|}
 +
 
 +
=== The "audiowizard" 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" | audiodevices
 +
| style="background:darkturquoise" align="center" | buttonlist
 +
| style="background:darkturquoise" | A list of potential audio devices.
 
| style="background:darkturquoise" align="center" | <b>Yes</b>
 
| style="background:darkturquoise" align="center" | <b>Yes</b>
 +
|-
 +
| ac3check
 +
| align="center"  | checkBox
 +
| Enable/disable Dolby Digiral.
 +
| align="center"  | <b>Yes</b>
 +
|-
 +
| style="background:darkturquoise" | dtscheck
 +
| style="background:darkturquoise" align="center" | checkBox
 +
| style="background:darkturquoise" | Enable/disable DTS support.
 +
| style="background:darkturquoise" align="center" | <b>Yes</b>
 +
|-
 +
| eac3check
 +
| align="center"  | checkBox
 +
| Enable/disable E-AC-3 support.
 +
| align="center"  | <b>Yes</b>
 +
|-
 +
| style="background:darkturquoise" | truehdcheck
 +
| style="background:darkturquoise" align="center" | checkBox
 +
| style="background:darkturquoise" | Enable/disable TrueHD support.
 +
| style="background:darkturquoise" align="center" | <b>Yes</b>
 +
|-
 +
| dtshdcheck
 +
| align="center"  | checkBox
 +
| Enable/disable DTS-HD support.
 +
| align="center"  | <b>Yes</b>
 +
|-
 +
| style="background:darkturquoise" | speakers
 +
| style="background:darkturquoise" align="center" | buttonlist
 +
| style="background:darkturquoise" | A list of possible speaker configurations.
 +
| style="background:darkturquoise" align="center" | <b>Yes</b>
 +
|-
 +
| testspeakers
 +
| align="center"  | button
 +
| The button used to test the speakers.
 +
| align="center"  | <b>Yes</b>
 +
|-
 +
| style="background:darkturquoise" | previous
 +
| style="background:darkturquoise" align="center" | button
 +
| style="background:darkturquoise" | "Previous" button.
 +
| style="background:darkturquoise" align="center" | <b>Yes</b>
 +
|-
 +
| next
 +
| align="center"  | button
 +
| "Next" button.
 +
| align="center"  | <b>Yes</b>
 +
|}
 +
 +
=== The "videowizard" 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" | playbackprofiles
 +
| style="background:darkturquoise" align="center" | buttonlist
 +
| style="background:darkturquoise" | A list of potential playback profiles.
 +
| style="background:darkturquoise" align="center" | <b>Yes</b>
 +
|-
 +
| testsd
 +
| align="center"  | button
 +
| The button used to do a Standard Definition test.
 +
| align="center"  | <b>Yes</b>
 +
|-
 +
| style="background:darkturquoise" | testhd
 +
| style="background:darkturquoise" align="center" | button
 +
| style="background:darkturquoise" | The button used to do a High Definition test.
 +
| style="background:darkturquoise" align="center" | <b>Yes</b>
 +
|-
 +
| previous
 +
| align="center"  | button
 +
| "Previous" button.
 +
| align="center"  | <b>Yes</b>
 +
|-
 +
| style="background:darkturquoise" | next
 +
| style="background:darkturquoise" align="center" | button
 +
| style="background:darkturquoise" | "Next/Finish" button.
 +
| style="background:darkturquoise" align="center" | <b>Yes</b>
 +
|}
 +
 +
=== The "backendselection" 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" | backends
 +
| style="background:darkturquoise" align="center" | buttonlist
 +
| style="background:darkturquoise" | A list of possible backends.
 +
| style="background:darkturquoise" align="center" | <b>Yes</b>
 +
|-
 +
| save
 +
| align="center"  | button
 +
| "Save" button.
 +
| align="center"  | <b>Yes</b>
 +
|-
 +
| style="background:darkturquoise" | manual
 +
| style="background:darkturquoise" align="center" | button
 +
| style="background:darkturquoise" | "Manual" button.
 +
| style="background:darkturquoise" align="center" | <b>Yes</b>
 +
|-
 +
| cancel
 +
| align="center"  | button
 +
| "Cancel" button.
 +
| align="center"  | <b>Yes</b>
 +
|}
 +
 +
=== The "guistartup" 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" | statusstate
 +
| style="background:darkturquoise" align="center" | statetype
 +
| style="background:darkturquoise" | Current state of the startup.
 +
'''State and meaning'''
 +
start - Waking up Database Machine.
 +
startFail - Database machine failed to wake up.
 +
dbAwake - Waiting for Database to start.
 +
dbAwakeFail - Database failed to start.
 +
dbStarted - Attempting to connect to Database.
 +
dbStartedFail - Unable to connect to Database.
 +
beWOL - Attempting to wake master backend.
 +
beWOLFail - Master backend failed to wake.
 +
beAwake - Attempting to connect to master backend.
 +
beAwakeFail - Unable to connect to master backend.
 +
| style="background:darkturquoise" align="center" | <b>Yes</b>
 +
|-
 +
| messagestate
 +
| align="center"  | statetype
 +
| Action message
 +
'''State and meaning'''
 +
makeselection - Select an option below.
 +
empty - (blank - i.e. not waiting for a selection)
 +
| align="center"  | <b>Yes</b>
 +
|-
 +
| style="background:darkturquoise" | progress
 +
| style="background:darkturquoise" align="center" | progressbar
 +
| style="background:darkturquoise" | Progress of startup.
 +
| style="background:darkturquoise" align="center" | <b>Yes</b>
 +
|-
 +
| dummy
 +
| align="center"  | button
 +
| Invisible button. Set width and height to 0. Startup sets initial focus to this to force the user to explicity select one of the buttons rather than have one being the default.
 +
| align="center"  | <b>Yes</b>
 +
|-
 +
| style="background:darkturquoise" | retry
 +
| style="background:darkturquoise" align="center" | button
 +
| style="background:darkturquoise" | Try again to establish connections.
 +
| style="background:darkturquoise" align="center" | <b>Yes</b>
 +
|-
 +
| search
 +
| align="center"  | button
 +
| Search the local network for the MythTV Backend.
 +
| align="center"  | <b>Yes</b>
 +
|-
 +
| style="background:darkturquoise" | setup
 +
| style="background:darkturquoise" align="center" | button
 +
| style="background:darkturquoise" | Use Database setup to enter database parameters.
 +
| style="background:darkturquoise" align="center" | <b>Yes</b>
 +
|-
 +
| exit
 +
| align="center"  | button
 +
| Exit from MythTV.
 +
| align="center"  | <b>Yes</b>
 
|}
 
|}

Latest revision as of 19:54, 25 November 2017

The config-ui.xml file governs the layout and behavior of multiple screens in various parts of MythTV. As configuration screens are gradually converted to MythUI, this file will take on more and more importance. It consists of the following windows and named attributes:

Windows

Window Name Type Description
iconimport Window The Icon Downloader screen in mythtv-setup.
channeloverview Window The Channel Editor screen in mythtv-setup.
languageselection Window Language selection.
grabbersettings Window The information and artwork screen in MythFrontend.
generalwizard Window The general wizard screen in MythFrontend.
audiowizard Window The audio wizard in MythFrontend.
videowizard Window The video wizard screen in MythFrontend.
backendselection Window The backend selection screen.
guistartup Window Startup Window in all GUI programs, only displayed if connection to the backend or database cannot be established.

The "iconimport" window

Widget Name Widget Type Description Required?
icons buttonlist A button list of potential icon choices for a given channel. Yes
manualsearch textedit A search field to perform a manual station lookup. Yes
name textarea The name of the channel being looked up. Yes
search button Button to activate manual search. Yes
skip button Button to skip current lookup. Yes
status textarea Status information on current lookup. Yes
preview imagetype Icon of the currently selected title in the returned button list. No
previewtitle textarea Title of the currently selected title in the returned button list. No

The "channeloverview" window

Widget Name Widget Type Description Required?
sorting buttonlist A button list of sort options for the channel list. Yes
source buttonlist A button list to limit the channel list to a given source. Yes
channels buttonlist The list of channels, as filtered by source or sort. Yes
delete button Delete the selected channel. Yes
scan button Activate channel scanner. Yes
importicons button Download icons for channels. Yes
edittransport button Edit transport information for selected channel. Yes
nochannum checkbox Toggle hiding/showing of channels without channel numbers. Yes
name textarea Display the name of the selected channel. No
channum textarea Display the number of the selected channel. No
chanid textarea Display the ID of the selected channel. No
callsign textarea Display the callsign of the selected channel. No
sourcename textarea Display the source of the selected channel. No
compoundname textarea Display the internally formatted name of the selected channel. No
preview imagetype Display the icon of the selected channel. No

The "languageselection" window

Widget Name Widget Type Description Required?
countries buttonlist A list of potential countries. 
Mapped Items
buttontext - the english country name
buttonimage - country flag image loaded from 'locale/country_code.png'
country - the english country name
nativecountry - the native country name
Yes
languages textedit A list of potential languages. 
Mapped Items
buttontext - the native language name
language - the english language name
nativelanguage - the native language name
Yes
save buttom "Save" button. Yes
cancel button "Cancel" button. Yes

The "grabbersettings" window

Widget Name Widget Type Description Required?
moviegrabber buttonlist A list of potential movie grabbers. Yes
tvgrabber buttonlist A button list of potential tv grabbers. Yes
gamegrabber buttonlist A list of potential video game grabbers. Yes
dailyupdates checkBox Enable/disable daily updates of recording artwork. Yes
cancel buttom "Cancel" button. Yes
ok button "OK" button. Yes

The "generalwizard" window

Widget Name Widget Type Description Required?
submit button The button used to submit the hardware profile. Yes
view button The button used to view the hardware profile. Yes
delete button The button used to delete the hardware profile. Yes
cancel button "Cancel" button. Yes
next button "Next" button. Yes

The "audiowizard" window

Widget Name Widget Type Description Required?
audiodevices buttonlist A list of potential audio devices. Yes
ac3check checkBox Enable/disable Dolby Digiral. Yes
dtscheck checkBox Enable/disable DTS support. Yes
eac3check checkBox Enable/disable E-AC-3 support. Yes
truehdcheck checkBox Enable/disable TrueHD support. Yes
dtshdcheck checkBox Enable/disable DTS-HD support. Yes
speakers buttonlist A list of possible speaker configurations. Yes
testspeakers button The button used to test the speakers. Yes
previous button "Previous" button. Yes
next button "Next" button. Yes

The "videowizard" window

Widget Name Widget Type Description Required?
playbackprofiles buttonlist A list of potential playback profiles. Yes
testsd button The button used to do a Standard Definition test. Yes
testhd button The button used to do a High Definition test. Yes
previous button "Previous" button. Yes
next button "Next/Finish" button. Yes

The "backendselection" window

Widget Name Widget Type Description Required?
backends buttonlist A list of possible backends. Yes
save button "Save" button. Yes
manual button "Manual" button. Yes
cancel button "Cancel" button. Yes

The "guistartup" window

Widget Name Widget Type Description Required?
statusstate statetype Current state of the startup.

State and meaning 

start - Waking up Database Machine.
startFail - Database machine failed to wake up.
dbAwake - Waiting for Database to start.
dbAwakeFail - Database failed to start.
dbStarted - Attempting to connect to Database.
dbStartedFail - Unable to connect to Database.
beWOL - Attempting to wake master backend.
beWOLFail - Master backend failed to wake.
beAwake - Attempting to connect to master backend.
beAwakeFail - Unable to connect to master backend.
Yes
messagestate statetype Action message

State and meaning 

makeselection - Select an option below.
empty - (blank - i.e. not waiting for a selection)
Yes
progress progressbar Progress of startup. Yes
dummy button Invisible button. Set width and height to 0. Startup sets initial focus to this to force the user to explicity select one of the buttons rather than have one being the default. Yes
retry button Try again to establish connections. Yes
search button Search the local network for the MythTV Backend. Yes
setup button Use Database setup to enter database parameters. Yes
exit button Exit from MythTV. Yes
Retrieved from "http://www.mythtv.org/wiki?title=Config-ui.xml&oldid=64382"