MythUIButton Class Reference

A single button widget. More...

#include <libmythui/mythuibutton.h>

Inheritance diagram for MythUIButton:

Collaboration diagram for MythUIButton:

Signals
void	Clicked ()
Signals inherited from MythUIType
void	RequestUpdate ()
void	RequestRegionUpdate (const QRect &)
void	TakingFocus ()
void	LosingFocus ()
void	VisibilityChanged (bool Visible)
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 () override
void	Reset (void) override
	Reset the widget to it's original state, should not reset changes made by the theme. More...
bool	gestureEvent (MythGestureEvent *event) override
	Mouse click/movement handler, receives mouse gesture events from the QCoreApplication event loop. More...
bool	keyPressEvent (QKeyEvent *event) override
	Key event handler. More...
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. More...
MythUIType *	GetChild (const QString &name) const
	Get a named child of this UIType. More...
MythUIType *	GetChildAt (QPoint p, bool recursive=true, bool focusable=true) const
	Return the first MythUIType at the given coordinates. More...
QList< MythUIType * > *	GetAllChildren (void)
	Return a list of all child widgets. More...
QList< MythUIType * >	GetAllDescendants (void)
void	DeleteChild (const QString &name)
	Delete a named child of this UIType. More...
void	DeleteChild (MythUIType *child)
	Delete the given UIType if it is a child of this UIType. More...
void	DeleteAllChildren (void)
	Delete all child widgets. More...
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. More...
void	SetCanTakeFocus (bool set=true)
	Set whether this widget can take focus. More...
void	SetFocusOrder (int order)
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. More...
void	Draw (MythPainter *p, int xoffset, int yoffset, int alphaMod=255, QRect clipRect=QRect())
void	SetPosition (int x, int y)
	Convenience method, calls SetPosition(const MythPoint&) Override that instead to change functionality. More...
void	SetPosition (QPoint point)
virtual void	SetPosition (const MythPoint &point)
virtual MythPoint	GetPosition (void) const
virtual void	SetSize (QSize size)
virtual void	SetMinSize (const MythPoint &size)
	Set the minimum size of this widget, for widgets which can be rescaled. More...
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. More...
virtual void	VanishSibling (void)
virtual void	SetMinAreaParent (MythRect actual_area, MythRect allowed_area, MythUIType *child)
	Adjust the size of sibling objects within the button. More...
virtual void	SetMinArea (const MythRect &rect)
	Set the minimum area based on the given size. More...
virtual MythRect	GetArea (void) const
	If the object has a minimum area defined, return it, other wise return the default area. More...
virtual MythRect	GetFullArea (void) const
virtual void	RecalculateArea (bool recurse=true)
void	ExpandArea (QRect rect)
virtual QRegion	GetDirtyArea (void) const
bool	IsVisible (bool recurse=false) const
virtual 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 bool	inputMethodEvent (QInputMethodEvent *event)
	Input Method event handler. More...
virtual void	mediaEvent (MythMediaEvent *event)
	Media/Device status event handler, received from MythMediaMonitor. More...
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
void	SetXMLName (const QString &name)
QString	GetXMLName (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. More...
bool	ContainsPoint (QPoint point) const
	Check if the given point falls within this widgets area. More...
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 (MythUIType *dependee, 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
bool	ParseElement (const QString &filename, QDomElement &element, bool showWarnings) override
	Parse the xml definition of this widget setting the state of the object accordingly. More...
void	CopyFrom (MythUIType *base) override
	Copy this widgets state from another. More...
void	CreateCopy (MythUIType *parent) override
	Copy the state of this widget to the one given, it must be of the same type. More...
void	Finalize (void) override
	Perform any post-xml parsing initialisation tasks. More...
void	SetInitialStates (void)
void	SetState (const QString &state)
Protected Member Functions inherited from MythUIType
	~MythUIType () override
void	customEvent (QEvent *event) override
virtual void	DrawSelf (MythPainter *p, int xoffset, int yoffset, int alphaMod, QRect clipRect)
void	AddFocusableChildrenToList (FocusInfoType &focusList)
void	HandleAlphaPulse ()
	Handle one frame of an alpha (transparency) change animation. More...
void	HandleMovementPulse ()
	Handle one frame of a movement animation. More...
int	CalcAlpha (int alphamod) const
void	ConnectDependants (bool recurse=false)

Protected Attributes
QString	m_message
QString	m_valueText
MythUIStateType *	m_backgroundState {nullptr}
MythUIText *	m_text {nullptr}
QString	m_state
bool	m_pushed {false}
bool	m_lockable {false}
class QTimer *	m_clickTimer {nullptr}
Protected Attributes inherited from MythUIType
QList< MythUIType * >	m_childrenList
QMap< QString, QString >	m_dependsMap
QList< QPair< MythUIType *, bool > >	m_dependsValue
QList< int >	m_dependOperator
bool	m_visible {true}
bool	m_hasFocus {false}
bool	m_canHaveFocus {false}
bool	m_enabled {true}
bool	m_enableInitiator {false}
bool	m_initiator {false}
bool	m_vanish {false}
bool	m_vanished {false}
bool	m_isDependDefault {false}
QMap< MythUIType *, bool >	m_reverseDepend
int	m_focusOrder {0}
MythRect	m_area {0,0,0,0}
MythRect	m_minArea {0,0,0,0}
MythPoint	m_minSize
QRegion	m_dirtyRegion {0,0,0,0}
bool	m_needsRedraw {false}
UIEffects	m_effects
int	m_alphaChangeMode {0}
int	m_alphaChange {0}
int	m_alphaMin {0}
int	m_alphaMax {255}
bool	m_moving {false}
QPoint	m_xyDestination {0,0}
QPoint	m_xySpeed {0,0}
FontMap *	m_fonts {nullptr}
MythUIType *	m_parent {nullptr}
MythPainter *	m_painter {nullptr}
QList< MythUIAnimation * >	m_animations
QString	m_helptext
QString	m_xmlName
QString	m_xmlLocation
bool	m_deferload {false}
QColor	m_borderColor {Qt::black}

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)
void	UpdateDependState (MythUIType *dependee, 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)
Static Protected Member Functions inherited from MythUIType
static int	NormX (int width)
static int	NormY (int height)

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::MythUIButton	(	MythUIType *	parent,
		const QString &	name
	)

Definition at line 20 of file mythuibutton.cpp.

Referenced by CreateCopy().

~MythUIButton()

MythUIButton::~MythUIButton ( )

override

Definition at line 36 of file mythuibutton.cpp.

Member Function Documentation

Reset()

void MythUIButton::Reset ( void  )

overridevirtual

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

Reimplemented from MythUIType.

Definition at line 59 of file mythuibutton.cpp.

gestureEvent()

bool MythUIButton::gestureEvent ( MythGestureEvent *  event )

overridevirtual

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.

keyPressEvent()

bool MythUIButton::keyPressEvent ( QKeyEvent *  event )

overridevirtual

Key event handler.

Parameters

event

Keypress event

Reimplemented from MythUIType.

Definition at line 124 of file mythuibutton.cpp.

SetText()

void MythUIButton::SetText

(

const QString &

msg

)

Definition at line 229 of file mythuibutton.cpp.

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

GetText()

QString MythUIButton::GetText

(

void

)

const

Definition at line 246 of file mythuibutton.cpp.

GetDefaultText()

QString MythUIButton::GetDefaultText

(

void

)

const

Definition at line 251 of file mythuibutton.cpp.

Push()

void MythUIButton::Push

(

bool

lock = false

)

Definition at line 175 of file mythuibutton.cpp.

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

SetLockable()

void MythUIButton::SetLockable ( bool  lockable )

inline

Definition at line 39 of file mythuibutton.h.

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

SetLocked()

void MythUIButton::SetLocked

(

bool

locked

)

Definition at line 206 of file mythuibutton.cpp.

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

Select

void MythUIButton::Select ( )

protectedslot

Definition at line 64 of file mythuibutton.cpp.

Referenced by MythUIButton().

Deselect

void MythUIButton::Deselect ( )

protectedslot

Definition at line 72 of file mythuibutton.cpp.

Referenced by MythUIButton().

Enable

void MythUIButton::Enable ( )

protectedslot

Definition at line 83 of file mythuibutton.cpp.

Referenced by MythUIButton().

Disable

void MythUIButton::Disable ( )

protectedslot

Definition at line 88 of file mythuibutton.cpp.

Referenced by MythUIButton().

UnPush

void MythUIButton::UnPush ( )

protectedslot

Definition at line 186 of file mythuibutton.cpp.

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

Clicked

void MythUIButton::Clicked ( )

signal

Referenced by MythChannelOverlay::Create(), RatingSettings::Create(), VisualizationSettings::Create(), ChannelEditor::Create(), MythNavigationOverlay::Create(), CastDialog::Create(), ImportSettings::Create(), GeneralSettings::Create(), EditRomInfoDialog::Create(), CustomPriority::Create(), FileAssocDialog::Create(), PlayerSettings::Create(), MetadataSettings::Create(), GrabberSettings::Create(), GeneralSetupWizard::Create(), GameDetailsPopup::Create(), KeyGrabPopupBox::Create(), AudioSetupWizard::Create(), CustomEdit::Create(), MythBrowser::Create(), VideoSetupWizard::Create(), WelcomeDialog::Create(), ManualSchedule::Create(), BookmarkEditor::Create(), ProfileDialog::Create(), DVDThemeSelector::Create(), EditMetadataDialog::Create(), MythNewsEditor::Create(), SelectDestination::Create(), MythTerminal::Create(), PhrasePopup::Create(), LogViewer::Create(), PlotDialog::Create(), LanguageSelection::Create(), RawSettingsEditor::Create(), FunctionDialog::Create(), ImportIconsWizard::Create(), ZMEvents::Create(), RecordingSelector::Create(), BrowserConfig::Create(), ZMPlayer::Create(), ExportNative::Create(), RSSEditPopup::Create(), VideoSelector::Create(), ThumbFinder::Create(), GlobalSetup::Create(), ChannelScannerGUIScanPane::Create(), FileSelector::Create(), BackendSelection::Create(), ArchiveFileSelector::Create(), MythBurn::Create(), GUIStartup::Create(), EditStreamMetadata::Create(), MythControls::Create(), EditLyricsDialog::Create(), ImportMusicDialog::Create(), ScreenSetup::Create(), PowerSearchPopup::Create(), SpinBoxEntryDialog::Create(), SmartPlaylistEditor::Create(), MythUIFileBrowser::Create(), ImportNative::Create(), RSSEditor::Create(), Ripper::Create(), SourceSetup::Create(), EditPowerSearchPopup::Create(), LocationDialog::Create(), SearchInputDialog::Create(), EditAlbumartDialog::Create(), ScheduleEditor::Create(), CriteriaRowEditor::Create(), ImportCoverArtDialog::Create(), SmartPLOrderByDialog::Create(), MythConfirmationDialog::Create(), SchedOptEditor::Create(), VideoFilterDialog::Create(), SmartPLDateDialog::Create(), MythTextInputDialog::Create(), MetadataOptions::Create(), MythSpinBoxDialog::Create(), SearchButtonListDialog::Create(), MythUISearchDialog::Create(), MythTimeInputDialog::Create(), ChangeView::Create(), PasswordChange::Create(), RecMetadataEdit::Create(), ItemDetailPopup::Create(), EditMetadataCommon::CreateCommon(), MusicCommon::CreateCommon(), SchedEditChild::CreateEditChild(), Push(), UnPush(), and MythUIVirtualKeyboard::updateKeys().

ParseElement()

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

overrideprotectedvirtual

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.

CopyFrom()

void MythUIButton::CopyFrom ( MythUIType *  base )

overrideprotectedvirtual

Copy this widgets state from another.

Reimplemented from MythUIType.

Definition at line 287 of file mythuibutton.cpp.

CreateCopy()

void MythUIButton::CreateCopy ( MythUIType *  parent )

overrideprotectedvirtual

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

Reimplemented from MythUIType.

Definition at line 278 of file mythuibutton.cpp.

Finalize()

void MythUIButton::Finalize ( void  )

overrideprotectedvirtual

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 308 of file mythuibutton.cpp.

SetInitialStates()

void MythUIButton::SetInitialStates ( void  )

protected

Definition at line 42 of file mythuibutton.cpp.

Referenced by CopyFrom(), and Finalize().

SetState()

void MythUIButton::SetState ( const QString &  state )

protected

Definition at line 93 of file mythuibutton.cpp.

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

Member Data Documentation

m_message

QString MythUIButton::m_message

protected

Definition at line 62 of file mythuibutton.h.

Referenced by CopyFrom(), GetText(), SetInitialStates(), SetState(), and SetText().

m_valueText

QString MythUIButton::m_valueText

protected

Definition at line 63 of file mythuibutton.h.

Referenced by CopyFrom(), Finalize(), and ParseElement().

m_backgroundState

MythUIStateType* MythUIButton::m_backgroundState {nullptr}

protected

Definition at line 65 of file mythuibutton.h.

Referenced by SetInitialStates(), SetState(), and SetText().

m_text

MythUIText* MythUIButton::m_text {nullptr}

protected

Definition at line 66 of file mythuibutton.h.

Referenced by GetDefaultText(), SetInitialStates(), SetState(), and SetText().

m_state

QString MythUIButton::m_state

protected

Definition at line 68 of file mythuibutton.h.

Referenced by SetState().

m_pushed

bool MythUIButton::m_pushed {false}

protected

Definition at line 70 of file mythuibutton.h.

Referenced by Deselect(), gestureEvent(), keyPressEvent(), Push(), Select(), SetLocked(), SetState(), and UnPush().

m_lockable

bool MythUIButton::m_lockable {false}

protected

Definition at line 71 of file mythuibutton.h.

Referenced by CopyFrom(), Push(), SetLocked(), and UnPush().

m_clickTimer

class QTimer* MythUIButton::m_clickTimer {nullptr}

protected

Definition at line 72 of file mythuibutton.h.

Referenced by MythUIButton(), Push(), UnPush(), and ~MythUIButton().

---

The documentation for this class was generated from the following files:

• mythtv/libs/libmythui/mythuibutton.h
• mythtv/libs/libmythui/mythuibutton.cpp