MythTV  master
Signals | Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | List of all members

A single button widget. More...

#include <mythuibutton.h>

Inheritance diagram for MythUIButton:
Inheritance graph
[legend]
Collaboration diagram for MythUIButton:
Collaboration graph
[legend]

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 ()
 
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...
 
MythUITypeGetChild (const QString &name) const
 Get a named child of this UIType. More...
 
MythUITypeGetChildAt (const 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...
 
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)
 
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...
 
virtual void SetPosition (const MythPoint &point)
 
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. 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 (const MythRect &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 void mediaEvent (MythMediaEvent *event)
 Media/Device status event handler, received from MythMediaMonitor. More...
 
MythFontPropertiesGetFont (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 (const QPoint &point) const
 Check if the given point falls within this widgets area. More...
 
virtual MythPainterGetPainter (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
virtual ~MythUIType ()
 
void customEvent (QEvent *event) override
 
virtual void DrawSelf (MythPainter *p, int xoffset, int yoffset, int alphaMod, QRect clipRect)
 
void AddFocusableChildrenToList (QMap< int, MythUIType * > &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)
 
void ConnectDependants (bool recurse=false)
 

Protected Attributes

QString m_Message
 
QString m_ValueText
 
MythUIStateTypem_BackgroundState {nullptr}
 
MythUITextm_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 *, boolm_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}
 
FontMapm_Fonts {nullptr}
 
MythUITypem_Parent {nullptr}
 
MythPainterm_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 MythUITypeGetGlobalObjectStore (void)
 
static void ClearGlobalObjectStore (void)
 
static void ParseChildren (const QString &filename, QDomElement &element, MythUIType *parent, bool showWarnings)
 
static MythUITypeParseUIType (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 (const int width)
 
static int NormY (const 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 19 of file mythuibutton.cpp.

Referenced by CreateCopy().

◆ ~MythUIButton()

MythUIButton::~MythUIButton ( )

Definition at line 35 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 58 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
eventMouse event

Reimplemented from MythUIType.

Definition at line 154 of file mythuibutton.cpp.

◆ keyPressEvent()

bool MythUIButton::keyPressEvent ( QKeyEvent *  event)
overridevirtual

Key event handler.

Parameters
eventKeypress event

Reimplemented from MythUIType.

Definition at line 123 of file mythuibutton.cpp.

◆ SetText()

void MythUIButton::SetText ( const QString &  msg)

◆ GetText()

QString MythUIButton::GetText ( void  ) const

Definition at line 243 of file mythuibutton.cpp.

◆ GetDefaultText()

QString MythUIButton::GetDefaultText ( void  ) const

Definition at line 248 of file mythuibutton.cpp.

◆ Push()

void MythUIButton::Push ( bool  lock = false)

◆ 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)

◆ Select

void MythUIButton::Select ( )
protectedslot

Definition at line 63 of file mythuibutton.cpp.

Referenced by MythUIButton().

◆ Deselect

void MythUIButton::Deselect ( )
protectedslot

Definition at line 71 of file mythuibutton.cpp.

Referenced by MythUIButton().

◆ Enable

void MythUIButton::Enable ( void  )
protectedslot

Definition at line 82 of file mythuibutton.cpp.

Referenced by MythUIButton().

◆ Disable

void MythUIButton::Disable ( void  )
protectedslot

Definition at line 87 of file mythuibutton.cpp.

Referenced by MythUIButton().

◆ UnPush

void MythUIButton::UnPush ( )
protectedslot

Definition at line 183 of file mythuibutton.cpp.

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

◆ Clicked

void MythUIButton::Clicked ( )
signal

Referenced by MythTerminal::Create(), Push(), and UnPush().

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

◆ CopyFrom()

void MythUIButton::CopyFrom ( MythUIType base)
overrideprotectedvirtual

Copy this widgets state from another.

Reimplemented from MythUIType.

Definition at line 284 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 275 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 305 of file mythuibutton.cpp.

◆ SetInitialStates()

void MythUIButton::SetInitialStates ( void  )
protected

Definition at line 41 of file mythuibutton.cpp.

Referenced by CopyFrom(), and Finalize().

◆ SetState()

void MythUIButton::SetState ( const QString &  state)
protected

Definition at line 92 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

◆ 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: