A single button widget. More...

#include <mythuibutton.h>

Inheritance diagram for MythUIButton:

Collaboration diagram for MythUIButton:

Signals
void	Clicked ()
Signals inherited from MythUIType
void	RequestUpdate ()
void	RequestUpdate (const QRect &)
void	RequestRegionUpdate (const QRect &)
void	TakingFocus ()
void	LosingFocus ()
void	Showing ()
void	Hiding ()
void	Enabling ()
void	Disabling ()
void	FinishedMoving ()
void	FinishedFading ()
void	DependChanged (bool isDefault)

Public Member Functions
	MythUIButton (MythUIType *parent, const QString &name)
	~MythUIButton ()
virtual void	Reset (void)
	Reset the widget to it's original state, should not reset changes made by the theme.
virtual bool	gestureEvent (MythGestureEvent *event)
	Mouse click/movement handler, receives mouse gesture events from the QCoreApplication event loop.
virtual bool	keyPressEvent (QKeyEvent *)
	Key event handler.
void	SetText (const QString &msg)
QString	GetText (void) const
QString	GetDefaultText (void) const
void	Push (bool lock=false)
void	SetLockable (bool lockable)
void	SetLocked (bool locked)
Public Member Functions inherited from MythUIType
	MythUIType (QObject *parent, const QString &name)
void	AddChild (MythUIType *child)
	Add a child UIType.
MythUIType *	GetChild (const QString &name) const
	Get a named child of this UIType.
MythUIType *	GetChildAt (const QPoint &p, bool recursive=true, bool focusable=true) const
	Return the first MythUIType which accepts focus found at the given coordinates.
QList< MythUIType * > *	GetAllChildren (void)
	Return a list of all child widgets.
void	DeleteChild (const QString &name)
	Delete a named child of this UIType.
void	DeleteChild (MythUIType *child)
	Delete the given UIType if it is a child of this UIType.
void	DeleteAllChildren (void)
	Delete all child widgets.
bool	NeedsRedraw (void) const
void	ResetNeedsRedraw (void)
void	SetRedraw (void)
void	SetChildNeedsRedraw (MythUIType *child)
bool	CanTakeFocus (void) const
	Return if this widget can accept input focus.
void	SetCanTakeFocus (bool set=true)
	Set whether this widget can take focus.
void	SetFocusOrder (int)
bool	IsEnabled (void) const
void	SetEnabled (bool enable)
bool	MoveToTop (void)
bool	MoveChildToTop (MythUIType *child)
void	ActivateAnimations (MythUIAnimation::Trigger trigger)
QList< MythUIAnimation * > *	GetAnimations (void)
virtual void	Pulse (void)
	Pulse is called 70 times a second to trigger a single frame of an animation.
void	Draw (MythPainter *p, int xoffset, int yoffset, int alphaMod=255, QRect clipRegion=QRect())
void	SetPosition (int x, int y)
	Convenience method, calls SetPosition(const MythPoint&) Override that instead to change functionality.
virtual void	SetPosition (const MythPoint &pos)
virtual MythPoint	GetPosition (void) const
virtual void	SetSize (const QSize &size)
virtual void	SetMinSize (const MythPoint &size)
	Set the minimum size of this widget, for widgets which can be rescaled.
virtual QSize	GetMinSize (void) const
virtual void	SetArea (const MythRect &rect)
virtual void	AdjustMinArea (int delta_x, int delta_y, int delta_w, int delta_h)
	Adjust the size of a sibling.
virtual void	VanishSibling (void)
virtual void	SetMinAreaParent (MythRect actual_area, MythRect full_area, MythUIType *child)
	Adjust the size of sibling objects within the button.
virtual void	SetMinArea (const MythRect &rect)
	Set the minimum area based on the given size.
virtual MythRect	GetArea (void) const
	If the object has a minimum area defined, return it, other wise return the default area.
virtual MythRect	GetFullArea (void) const
virtual void	RecalculateArea (bool recurse=true)
void	ExpandArea (const MythRect &rect)
virtual QRegion	GetDirtyArea (void) const
bool	IsVisible (bool recurse=false) const
void	SetVisible (bool visible)
void	MoveTo (QPoint destXY, QPoint speedXY)
void	AdjustAlpha (int mode, int alphachange, int minalpha=0, int maxalpha=255)
void	SetAlpha (int newalpha)
int	GetAlpha (void) const
virtual void	mediaEvent (MythMediaEvent *)
	Media/Device status event handler, received from MythMediaMonitor.
MythFontProperties *	GetFont (const QString &text) const
bool	AddFont (const QString &text, MythFontProperties *fontProp)
void	SetHelpText (const QString &text)
QString	GetHelpText (void) const
void	SetXMLLocation (const QString &filename, int where)
QString	GetXMLLocation (void) const
bool	IsDeferredLoading (bool recurse=false) const
void	SetDeferLoad (bool defer)
virtual void	LoadNow (void)
	Cause images in this and child widgets to be loaded.
bool	ContainsPoint (const QPoint &point) const
	Check if the given point falls within this widgets area.
virtual MythPainter *	GetPainter (void)
void	SetPainter (MythPainter *painter)
void	SetCentre (UIEffects::Centre centre)
void	SetZoom (float zoom)
void	SetHorizontalZoom (float zoom)
void	SetVerticalZoom (float zoom)
void	SetAngle (float angle)
void	SetDependIsDefault (bool isDefault)
void	SetReverseDependence (bool reverse)
void	SetDependsMap (QMap< QString, QString > dependsMap)
QMap< QString, QString >	GetDependsMap () const

Protected Slots
void	Select ()
void	Deselect ()
void	Enable ()
void	Disable ()
void	UnPush ()

Protected Member Functions
virtual bool	ParseElement (const QString &filename, QDomElement &element, bool showWarnings)
	Parse the xml definition of this widget setting the state of the object accordingly.
virtual void	CopyFrom (MythUIType *base)
	Copy this widgets state from another.
virtual void	CreateCopy (MythUIType *parent)
	Copy the state of this widget to the one given, it must be of the same type.
virtual void	Finalize (void)
	Perform any post-xml parsing initialisation tasks.
void	SetInitialStates (void)
void	SetState (QString state)
Protected Member Functions inherited from MythUIType
virtual	~MythUIType ()
virtual void	customEvent (QEvent *)
virtual void	DrawSelf (MythPainter *p, int xoffset, int yoffset, int alphaMod, QRect clipRegion)
void	AddFocusableChildrenToList (QMap< int, MythUIType * > &focusList)
void	HandleAlphaPulse ()
	Handle one frame of an alpha (transparency) change animation.
void	HandleMovementPulse ()
	Handle one frame of a movement animation.
int	CalcAlpha (int alphamod)
int	NormX (const int width)
int	NormY (const int height)
void	ConnectDependants (bool recurse=false)

Protected Attributes
QString	m_Message
QString	m_ValueText
MythUIStateType *	m_BackgroundState
MythUIText *	m_Text
QString	m_state
bool	m_Pushed
bool	m_Lockable
class QTimer *	m_clickTimer
Protected Attributes inherited from MythUIType
QList< MythUIType * >	m_ChildrenList
QMap< QString, QString >	m_dependsMap
bool	m_Visible
bool	m_HasFocus
bool	m_CanHaveFocus
bool	m_Enabled
bool	m_EnableInitiator
bool	m_Initiator
bool	m_Vanish
bool	m_Vanished
bool	m_IsDependDefault
bool	m_ReverseDepend
int	m_focusOrder
MythRect	m_Area
MythRect	m_MinArea
MythPoint	m_MinSize
QRegion	m_DirtyRegion
bool	m_NeedsRedraw
UIEffects	m_Effects
int	m_AlphaChangeMode
int	m_AlphaChange
int	m_AlphaMin
int	m_AlphaMax
bool	m_Moving
QPoint	m_XYDestination
QPoint	m_XYSpeed
FontMap *	m_Fonts
MythUIType *	m_Parent
MythPainter *	m_Painter
QList< MythUIAnimation * >	m_animations
QString	m_helptext
QString	m_xmlLocation
bool	m_deferload
QColor	m_BorderColor

Additional Inherited Members
Public Slots inherited from MythUIType
void	LoseFocus ()
bool	TakeFocus ()
void	Activate ()
void	Hide (void)
void	Show (void)
void	Refresh (void)
void	UpdateDependState (bool isDefault)
Static Public Member Functions inherited from XMLParseBase
static QString	getFirstText (QDomElement &element)
static bool	parseBool (const QString &text)
static bool	parseBool (QDomElement &element)
static MythPoint	parsePoint (const QString &text, bool normalize=true)
static MythPoint	parsePoint (QDomElement &element, bool normalize=true)
static QSize	parseSize (const QString &text, bool normalize=true)
static QSize	parseSize (QDomElement &element, bool normalize=true)
static MythRect	parseRect (const QString &text, bool normalize=true)
static MythRect	parseRect (QDomElement &element, bool normalize=true)
static int	parseAlignment (const QString &text)
static int	parseAlignment (QDomElement &element)
static QBrush	parseGradient (const QDomElement &element)
static QString	parseText (QDomElement &element)
static MythUIType *	GetGlobalObjectStore (void)
static void	ClearGlobalObjectStore (void)
static void	ParseChildren (const QString &filename, QDomElement &element, MythUIType *parent, bool showWarnings)
static MythUIType *	ParseUIType (const QString &filename, QDomElement &element, const QString &type, MythUIType parent, MythScreenType screen, bool showWarnings, QMap< QString, QString > &parentDependsMap)
static bool	WindowExists (const QString &xmlfile, const QString &windowname)
static bool	LoadWindowFromXML (const QString &xmlfile, const QString &windowname, MythUIType *parent)
static bool	LoadBaseTheme (void)
static bool	LoadBaseTheme (const QString &baseTheme)
static bool	CopyWindowFromBase (const QString &windowname, MythScreenType *win)

Detailed Description

A single button widget.

Has multiple states with backgrounds and fonts, text and optional checkbox (dual/tri state)

Definition at line 21 of file mythuibutton.h.

Constructor & Destructor Documentation

MythUIButton::MythUIButton	(	MythUIType *	parent,
		const QString &	name
	)

Definition at line 16 of file mythuibutton.cpp.

Referenced by CreateCopy().

MythUIButton::~MythUIButton ( )

Definition at line 38 of file mythuibutton.cpp.

Member Function Documentation

void MythUIButton::Reset ( void )

virtual

Reset the widget to it's original state, should not reset changes made by the theme.

Reimplemented from MythUIType.

Definition at line 61 of file mythuibutton.cpp.

bool MythUIButton::gestureEvent ( MythGestureEvent * event )

virtual

Mouse click/movement handler, receives mouse gesture events from the QCoreApplication event loop.

Should not be used directly.

Parameters

event Mouse event

Reimplemented from MythUIType.

Definition at line 157 of file mythuibutton.cpp.

bool MythUIButton::keyPressEvent ( QKeyEvent * e )

virtual

Key event handler.

Parameters

event Keypress event

Reimplemented from MythUIType.

Definition at line 126 of file mythuibutton.cpp.

void MythUIButton::SetText ( const QString & msg )

Definition at line 229 of file mythuibutton.cpp.

Referenced by PhrasePopup::Create(), AudioSetupWizard::Create(), MythNewsEditor::Create(), WelcomeDialog::Create(), FunctionDialog::Create(), ZMEvents::Create(), ZMPlayer::Create(), PowerSearchPopup::Create(), ScreenSetup::Create(), SourceSetup::Create(), LocationDialog::Create(), ImportIconsWizard::enableControls(), Finalize(), ZMPlayer::playPressed(), AudioSetupWizard::toggleSpeakers(), ZMPlayer::updateFrame(), and MythUIVirtualKeyboard::updateKeys().

QString MythUIButton::GetText ( void ) const

Definition at line 246 of file mythuibutton.cpp.

QString MythUIButton::GetDefaultText ( void ) const

Definition at line 251 of file mythuibutton.cpp.

void MythUIButton::Push ( bool lock = false )

Definition at line 175 of file mythuibutton.cpp.

Referenced by gestureEvent(), keyPressEvent(), ZMEvents::keyPressEvent(), ZMPlayer::keyPressEvent(), ImportMusicDialog::keyPressEvent(), MusicCommon::keyPressEvent(), and ImportCoverArtDialog::keyPressEvent().

void MythUIButton::SetLockable ( bool lockable )

inline

Definition at line 39 of file mythuibutton.h.

Referenced by MusicCommon::CreateCommon(), and MythUIVirtualKeyboard::updateKeys().

void MythUIButton::SetLocked ( bool locked )

Definition at line 206 of file mythuibutton.cpp.

Referenced by MythUIVirtualKeyboard::charClicked(), MusicCommon::CreateCommon(), MusicCommon::customEvent(), MythUIVirtualKeyboard::lockClicked(), and MythUIVirtualKeyboard::shiftClicked().

void MythUIButton::Select ( )

protectedslot

Definition at line 66 of file mythuibutton.cpp.

Referenced by MythUIButton().

void MythUIButton::Deselect ( )

protectedslot

Definition at line 74 of file mythuibutton.cpp.

Referenced by MythUIButton().

void MythUIButton::Enable ( void )

protectedslot

Definition at line 85 of file mythuibutton.cpp.

Referenced by MythUIButton().

void MythUIButton::Disable ( void )

protectedslot

Definition at line 90 of file mythuibutton.cpp.

Referenced by MythUIButton().

void MythUIButton::UnPush ( )

protectedslot

Definition at line 186 of file mythuibutton.cpp.

Referenced by gestureEvent(), keyPressEvent(), MythUIButton(), and SetState().

void MythUIButton::Clicked ( )

signal

Referenced by Push(), and UnPush().

bool MythUIButton::ParseElement	(	const QString &	filename,
		QDomElement &	element,
		bool	showWarnings
	)

protectedvirtual

Parse the xml definition of this widget setting the state of the object accordingly.

Reimplemented from MythUIType.

Definition at line 259 of file mythuibutton.cpp.

void MythUIButton::CopyFrom ( MythUIType * base )

protectedvirtual

Copy this widgets state from another.

Reimplemented from MythUIType.

Definition at line 288 of file mythuibutton.cpp.

Referenced by CreateCopy().

void MythUIButton::CreateCopy ( MythUIType * parent )

protectedvirtual

Copy the state of this widget to the one given, it must be of the same type.

Reimplemented from MythUIType.

Definition at line 279 of file mythuibutton.cpp.

void MythUIButton::Finalize ( void )

protectedvirtual

Perform any post-xml parsing initialisation tasks.

This is called after the widget has been created and it's state established by ParseElement() or CopyFrom(). A derived class should use this to perform any initialisation tasks which should occur after this point.

Reimplemented from MythUIType.

Definition at line 310 of file mythuibutton.cpp.

void MythUIButton::SetInitialStates ( void )

protected

Definition at line 44 of file mythuibutton.cpp.

Referenced by CopyFrom(), and Finalize().

void MythUIButton::SetState ( QString state )

protected

Definition at line 95 of file mythuibutton.cpp.

Referenced by Deselect(), Disable(), Enable(), Push(), Select(), SetInitialStates(), SetLocked(), and UnPush().