Difference between revisions of "Base.xml"

From MythTV Official Wiki
Jump to: navigation, search
(added SpinBoxEntryDialog)
 
(5 intermediate revisions by 3 users not shown)
Line 43: Line 43:
 
| style="background:silver" align="center" | Window
 
| style="background:silver" align="center" | Window
 
| style="background:silver" | A "Please Wait" screen preceding video playback.
 
| style="background:silver" | A "Please Wait" screen preceding video playback.
 +
|-
 +
| MythSearchListDialog
 +
| align="center" | Window
 +
| A dialog used to search buttonlists. NEW in 0.25-pre
 +
|-
 +
| style="background:silver" | MythMetadataResults
 +
| style="background:silver" align="center" | Window
 +
| style="background:silver" | The results of a metadata search for videos, recordings, etc..
 +
|-
 +
| MythArtworkResults
 +
| align="center" | Window
 +
| The results of a search for video, recording, etc. Artwork.
 +
|-
 +
| style="background:silver" | MythTimeInputDialog
 +
| style="background:silver" align="center" | Window
 +
| style="background:silver" | Template screen type for screens using a date and time buttonlist.
 +
|-
 +
| SpinBoxEntryDialog
 +
| align="center" | Window
 +
| A convenience dialog to allow entry of a Spinbox value.
 
|}
 
|}
  
Line 275: Line 295:
 
|}
 
|}
  
 +
 
=== The "videowindow" window ===
 
=== The "videowindow" window ===
  
Line 287: Line 308:
 
| style="background:darkturquoise" | This window has no required elements.
 
| style="background:darkturquoise" | This window has no required elements.
 
| style="background:darkturquoise" align="center" | No
 
| style="background:darkturquoise" align="center" | No
 +
|}
 +
 +
 +
=== The "MythSearchListDialog" 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" | searchedit
 +
| style="background:darkturquoise" align="center" | textedit
 +
| style="background:darkturquoise" | The search text input box.
 +
| style="background:darkturquoise" align="center" | <b>Yes</b>
 +
|-
 +
| prevbutton
 +
| align="center" | button
 +
| A find previous button.
 +
| align="center" | <b>Yes</b>
 +
|-
 +
| style="background:darkturquoise" | nextbutton
 +
| style="background:darkturquoise" align="center" | button
 +
| style="background:darkturquoise" | A find next button.
 +
| style="background:darkturquoise" align="center" | <b>Yes</b>
 +
|-
 +
| searchstate
 +
| align="center" | statetype
 +
| Indicates whether the search text has been found. States are 'found' and 'notfound'.
 +
| align="center" | <b>No</b>
 +
|}
 +
 +
 +
=== The "MythMetadataResults" 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" | results
 +
| style="background:darkturquoise" align="center" | buttonlist
 +
| style="background:darkturquoise" | A list of returned values from a grabber script, for user selection.
 +
| style="background:darkturquoise" align="center" | <b>Yes</b>
 +
|}
 +
 +
 +
=== The "MythArtworkResults" 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" | results
 +
| style="background:darkturquoise" align="center" | buttonlist
 +
| style="background:darkturquoise" | A list of returned artwork items, for user selection.
 +
| style="background:darkturquoise" align="center" | <b>Yes</b>
 +
|}
 +
 +
 +
==== Usable items in the MythArtworkResults buttonlist ====
 +
 +
{| 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" | buttonimage
 +
| style="background:darkturquoise" align="center" | imagetype
 +
| style="background:darkturquoise" | The thumbnail of the returned artwork item.
 +
| style="background:darkturquoise" align="center" | N
 +
|-
 +
| url
 +
| align="center"  | textarea
 +
| The URL of the full sized item.
 +
| align="center"  | N
 +
|-
 +
| style="background:darkturquoise" | resolution
 +
| style="background:darkturquoise" align="center" | textarea
 +
| style="background:darkturquoise" | The resolution of the final download.
 +
| style="background:darkturquoise" align="center" | N
 +
|-
 +
| width
 +
| align="center"  | textarea
 +
| The width of the full sized item.
 +
| align="center"  | N
 +
|-
 +
| style="background:darkturquoise" | height
 +
| style="background:darkturquoise" align="center" | textarea
 +
| style="background:darkturquoise" | The height of the full sized item.
 +
| style="background:darkturquoise" align="center" | N
 +
|}
 +
 +
 +
=== The "MythTimeInputDialog" 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" | dates
 +
| style="background:darkturquoise" align="center" | buttonlist
 +
| style="background:darkturquoise" | A list of dates.
 +
| style="background:darkturquoise" align="center" | <b>Yes</b>
 +
|-
 +
| times
 +
| align="center" | buttonlist
 +
| A list of times.
 +
| align="center" | <b>Yes</b>
 +
|-
 +
| style="background:darkturquoise" | ok
 +
| style="background:darkturquoise" align="center" | button
 +
| style="background:darkturquoise" | An "OK" button.
 +
| style="background:darkturquoise" align="center" | <b>Yes</b>
 +
|-
 +
| message
 +
| align="center" | textarea
 +
| The window message.
 +
| align="center" | <b>Yes</b>
 +
|}
 +
 +
=== The "SpinBoxEntryDialog" 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" | rules
 +
| style="background:darkturquoise" align="center" | textarea
 +
| style="background:darkturquoise" | Descriptions of the low, high and step values of the spinbox (use %LOW%, %HIGH%, %STEP%)
 +
| style="background:darkturquoise" align="center" | <b>No</b>
 +
|-
 +
| ok
 +
| align="center" | button
 +
| An "OK" button.
 +
| align="center" | <b>Yes</b>
 +
|-
 +
| style="background:darkturquoise" | cancel
 +
| style="background:darkturquoise" align="center" | button
 +
| style="background:darkturquoise" | A "Cancel" button.
 +
| style="background:darkturquoise" align="center" | <b>No</b>
 +
|-
 +
| entry
 +
| align="center" | textedit
 +
| The spinbox value input box.
 +
| align="center" | <b>Yes</b>
 
|}
 
|}

Latest revision as of 23:49, 7 February 2019

The base.xml file serves multiple purposes. Firstly, contents of the base.xml file may be inherited throughout MythTV, so it is generally where all the base versions of all the widgets are defined. Also, it defines certain windows used throughout the Myth Interface such as progress bars, popup dialogs, and search boxes.

base.xml Windows

Window Name Type Description
MythPopupBox Window A Generic Popup Menu.
MythDialogBox Window A Generic Dialog Box.
MythBusyDialog Window A "Busy" popup.
MythProgressDialog Window A Progress counter.
MythConfirmationDialog Window An "OK/Cancel" popup.
MythTextInputDialog Window A Text Entry popup.
MythSearchDialog Window An Incremental Search popup.
MythFileBrowser Window A File Browsing Dialog.
videowindow Window A "Please Wait" screen preceding video playback.
MythSearchListDialog Window A dialog used to search buttonlists. NEW in 0.25-pre
MythMetadataResults Window The results of a metadata search for videos, recordings, etc..
MythArtworkResults Window The results of a search for video, recording, etc. Artwork.
MythTimeInputDialog Window Template screen type for screens using a date and time buttonlist.
SpinBoxEntryDialog Window A convenience dialog to allow entry of a Spinbox value.


The "MythPopupBox" window

Widget Name Widget Type Description Required?
messagearea textarea The textual message area for the popup menu. Yes
list buttonlist The buttons for the popup menu. Yes


The "MythDialogBox" window

Widget Name Widget Type Description Required?
messagearea textarea The textual message area for the popup menu. Yes
list buttonlist The buttons for the popup menu. Yes
title textarea The window's title. Yes


The "MythBusyDialog" window

Widget Name Widget Type Description Required?
message textarea The textual message area for the busy dialog. Yes


The "MythProgressDialog" window

Widget Name Widget Type Description Required?
message textarea The window message. Yes
progressbar progressbar A visual progress bar. Yes
progresstext textarea The percentage value of progress. Yes


The "MythConfirmationDialog" window

Widget Name Widget Type Description Required?
message textarea The window message. Yes
ok button An "OK" button. Yes
cancel button A "Cancel" button. Yes


The "MythTextInputDialog" window

Widget Name Widget Type Description Required?
message textarea The window message. Yes
ok button An "OK" button. Yes
cancel button A "Cancel" button. Yes
input textedit The text input box. Yes


The "MythSearchDialog" window

Widget Name Widget Type Description Required?
title textarea The window message. Yes
ok button An "OK" button. Yes
cancel button A "Cancel" button. Yes
input textedit The text input box. Yes
itemlist buttonlist A list of items matched by the search Yes


The "MythFileBrowser" window

Widget Name Widget Type Description Required?
location textedit The path currently being viewed. Yes
back button An "UpLevel" button No
home button A Button to return to the home path. No
ok button An "OK" button. Yes
cancel button A "Cancel" button. Yes
filelist buttonlist A list of the available files in the path. Yes
filename textarea A filename of the selected item. No
fullpath textarea The full path and file name of the selected item. No
preview imagetype A image preview of the selected item. No


The "videowindow" window

Widget Name Widget Type Description Required?
This window has no required elements. No


The "MythSearchListDialog" window

Widget Name Widget Type Description Required?
searchedit textedit The search text input box. Yes
prevbutton button A find previous button. Yes
nextbutton button A find next button. Yes
searchstate statetype Indicates whether the search text has been found. States are 'found' and 'notfound'. No


The "MythMetadataResults" window

Widget Name Widget Type Description Required?
results buttonlist A list of returned values from a grabber script, for user selection. Yes


The "MythArtworkResults" window

Widget Name Widget Type Description Required?
results buttonlist A list of returned artwork items, for user selection. Yes


Usable items in the MythArtworkResults buttonlist

Widget Name Widget Type Description Required?
buttonimage imagetype The thumbnail of the returned artwork item. N
url textarea The URL of the full sized item. N
resolution textarea The resolution of the final download. N
width textarea The width of the full sized item. N
height textarea The height of the full sized item. N


The "MythTimeInputDialog" window

Widget Name Widget Type Description Required?
dates buttonlist A list of dates. Yes
times buttonlist A list of times. Yes
ok button An "OK" button. Yes
message textarea The window message. Yes

The "SpinBoxEntryDialog" window

Widget Name Widget Type Description Required?
rules textarea Descriptions of the low, high and step values of the spinbox (use %LOW%, %HIGH%, %STEP%) No
ok button An "OK" button. Yes
cancel button A "Cancel" button. No
entry textedit The spinbox value input box. Yes