MythThemedMenuPrivate Class Reference

Inheritance diagram for MythThemedMenuPrivate:

Detailed Description

Definition at line 172 of file myththemedmenu.cpp.


Public Member Functions
	MythThemedMenuPrivate (MythThemedMenu lparent, const char cdir, MythThemedMenuState *lstate)
	Constructor, Init() must be called before class can be used.
	~MythThemedMenuPrivate ()
bool	keyPressHandler (QKeyEvent *e)
	Delegate key event to appropriate action for keyHandler().
bool	keyHandler (QStringList &actions, bool fullexit)
	Interpret key presses on the menu into the appropriate actions.
bool	ReloadTheme (void)
	Reset and reparse everything.
bool	parseMenu (const QString &menuname)
	Parse the themebuttons to be added based on the name of the menu file provided.
void	parseThemeButton (QDomElement &element)
	Parses the element's tags and set the ThemeButton's type, text, depends, and action, then adds the button.
void	addButton (const QString &type, const QString &text, const QString &alttext, const QStringList &action)
	Create a new MythThemedButton based on the MythThemedMenuState m_state and the type, text, alt-text and action provided in the parameters.
bool	layoutButtons (void)
	Properly lay out all of the buttons that were added with addButton.
void	positionButtons (bool resetpos)
	Place buttons in position and set them visible and active.
bool	makeRowVisible (int newrow, int oldrow)
bool	handleAction (const QString &action)
	Handle a MythTV action for the Menus.
bool	findDepends (const QString &fileList)
QString	findMenuFile (const QString &menuname)
	Locates the appropriate menu file from which to parse the menu.
void	checkScrollArrows (void)
	Add or remove scroll arrows as needed.
bool	checkPinCode (const QString &timestamp_setting, const QString &password_setting, const QString &text)
	Queries the user for a password to enter a part of MythTV restricted by a password.
void	SetupBackground ()
	Sets up menu background, must be done before the buttons are parsed.
void	SetupUITypes ()
	Sets up UI according to the corresponding mythThemedMenuState.
bool	gestureEvent (MythUIType origtype, MythGestureEvent ge)
	Interprets mouse gestures as MythTV action events.
void	updateLCD (void)
Public Attributes
MythThemedMenu *	parent
MythThemedMenuState *	m_state
bool	allocedstate
vector< ThemedButton * >	buttonList
ThemedButton *	activebutton
int	currentrow
int	currentcolumn
vector< MenuRow >	buttonRows
QString	selection
bool	foundtheme
int	exitModifier
bool	ignorekeys
int	maxrows
int	visiblerows
int	columns
bool	wantpop
QString	titleText
QString	menumode
MythUIStateType *	watermark
MythUIImage *	uparrow
MythUIImage *	downarrow

Constructor & Destructor Documentation

MythThemedMenuPrivate::MythThemedMenuPrivate	(	MythThemedMenu *	lparent,
		const char *	cdir,
		MythThemedMenuState *	lstate
	)

Constructor, Init() must be called before class can be used.

Parameters:

	lparent	menu that owns this instance
	cdir	directory where theme is stored
	lstate	corresponding settings of the theme

Definition at line 1281 of file myththemedmenu.cpp.

MythThemedMenuPrivate::~MythThemedMenuPrivate ( )

Definition at line 1304 of file myththemedmenu.cpp.

Member Function Documentation

bool MythThemedMenuPrivate::keyPressHandler ( QKeyEvent * e )

Delegate key event to appropriate action for keyHandler().

Returns:: true iff key event was properly handled

Definition at line 1974 of file myththemedmenu.cpp.

Referenced by MythThemedMenu::keyPressEvent().

bool MythThemedMenuPrivate::keyHandler	(	QStringList &	actions,
		bool	fullexit
	)

Interpret key presses on the menu into the appropriate actions.

Parameters:

actions

list of MythTV actions to be handled.

Definition at line 1986 of file myththemedmenu.cpp.

Referenced by gestureEvent(), and keyPressHandler().

bool MythThemedMenuPrivate::ReloadTheme ( void )

Reset and reparse everything.

Note: this does not use the theme or menu file chosen in Init(), but instead uses defaults which should work if MythTV was properly installed.

Definition at line 1948 of file myththemedmenu.cpp.

Referenced by MythThemedMenu::ReloadTheme().

bool MythThemedMenuPrivate::parseMenu ( const QString & menuname )

Parse the themebuttons to be added based on the name of the menu file provided.

If the menu to be parsed is the main menu and this fails to find the XML file this will simply return false. Otherwise if it fails to find the menu it will pop up an error dialog and then return false.

The idea behind this is that if we can't parse the main menu we have to exit from the fronend entirely. But in all other cases we can simply return to the main menu and hope that it is a non-essential portion of MythTV which the theme does not support.

Definition at line 1423 of file myththemedmenu.cpp.

Referenced by MythThemedMenu::Init(), and ReloadTheme().

void MythThemedMenuPrivate::parseThemeButton ( QDomElement & element )

Parses the element's tags and set the ThemeButton's type, text, depends, and action, then adds the button.

Parameters:

element

DOM element describing features of the themeButton

Definition at line 1315 of file myththemedmenu.cpp.

Referenced by parseMenu().

void MythThemedMenuPrivate::addButton	(	const QString &	type,
		const QString &	text,
		const QString &	alttext,
		const QStringList &	action
	)

Create a new MythThemedButton based on the MythThemedMenuState m_state and the type, text, alt-text and action provided in the parameters.

Parameters:

	type	type of button to be created
	text	text to appear on the button
	alttext	alternate text to appear when required
	action	actions to be associated with button