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

A checkbox widget supporting three check states - on,off,half and two conditions - selected and unselected. More...

#include <mythuicheckbox.h>

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

Public Types

enum  StateType {
  None = 0, Normal, Disabled, Active,
  Selected, SelectedInactive
}
 

Signals

void valueChanged ()
 
void toggled (bool)
 
- 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

 MythUICheckBox (MythUIType *parent, const QString &name)
 
 ~MythUICheckBox () override=default
 
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 toggleCheckState (void)
 
void SetCheckState (MythUIStateType::StateType state)
 
void SetCheckState (bool onoff)
 
MythUIStateType::StateType GetCheckState () const
 
bool GetBooleanCheckState (void) const
 
- Public Member Functions inherited from MythUIType
 MythUIType (QObject *parent, const QString &name)
 
virtual void Reset (void)
 Reset the widget to it's original state, should not reset changes made by the theme. More...
 
void AddChild (MythUIType *child)
 Add a child UIType. More...
 
MythUITypeGetChild (const QString &name) const
 Get a named child of this UIType. More...
 
MythUITypeGetChildAt (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...
 
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 (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 ()
 

Protected Member Functions

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)
 
- 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)
 
virtual bool ParseElement (const QString &filename, QDomElement &element, bool showWarnings)
 Parse the xml definition of this widget setting the state of the object accordingly. More...
 

Protected Attributes

MythUIStateTypem_backgroundState {nullptr}
 
MythUIStateTypem_checkState {nullptr}
 
MythUIStateType::StateType m_currentCheckState {MythUIStateType::Off}
 
QString m_state {"active"}
 
- 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 (int width)
 
static int NormY (int height)
 

Detailed Description

A checkbox widget supporting three check states - on,off,half and two conditions - selected and unselected.

Definition at line 15 of file mythuicheckbox.h.

Member Enumeration Documentation

◆ StateType

Enumerator
None 
Normal 
Disabled 
Active 
Selected 
SelectedInactive 

Definition at line 23 of file mythuicheckbox.h.

Constructor & Destructor Documentation

◆ MythUICheckBox()

MythUICheckBox::MythUICheckBox ( MythUIType parent,
const QString &  name 
)

Definition at line 12 of file mythuicheckbox.cpp.

Referenced by CreateCopy().

◆ ~MythUICheckBox()

MythUICheckBox::~MythUICheckBox ( )
overridedefault

Member Function Documentation

◆ gestureEvent()

bool MythUICheckBox::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 148 of file mythuicheckbox.cpp.

◆ keyPressEvent()

bool MythUICheckBox::keyPressEvent ( QKeyEvent *  event)
overridevirtual

Key event handler.

Parameters
eventKeypress event

Reimplemented from MythUIType.

Definition at line 166 of file mythuicheckbox.cpp.

◆ toggleCheckState()

void MythUICheckBox::toggleCheckState ( void  )

Definition at line 43 of file mythuicheckbox.cpp.

Referenced by gestureEvent(), and keyPressEvent().

◆ SetCheckState() [1/2]

void MythUICheckBox::SetCheckState ( MythUIStateType::StateType  state)

◆ SetCheckState() [2/2]

void MythUICheckBox::SetCheckState ( bool  onoff)

Definition at line 79 of file mythuicheckbox.cpp.

◆ GetCheckState()

MythUIStateType::StateType MythUICheckBox::GetCheckState ( ) const

◆ GetBooleanCheckState()

bool MythUICheckBox::GetBooleanCheckState ( void  ) const

◆ Select

void MythUICheckBox::Select ( )
protectedslot

Definition at line 108 of file mythuicheckbox.cpp.

Referenced by MythUICheckBox().

◆ Deselect

void MythUICheckBox::Deselect ( )
protectedslot

Definition at line 118 of file mythuicheckbox.cpp.

Referenced by MythUICheckBox().

◆ Enable

void MythUICheckBox::Enable ( )
protectedslot

Definition at line 129 of file mythuicheckbox.cpp.

Referenced by MythUICheckBox().

◆ Disable

void MythUICheckBox::Disable ( )
protectedslot

Definition at line 136 of file mythuicheckbox.cpp.

Referenced by MythUICheckBox().

◆ valueChanged

void MythUICheckBox::valueChanged ( )
signal

◆ toggled

void MythUICheckBox::toggled ( bool  )
signal

◆ CopyFrom()

void MythUICheckBox::CopyFrom ( MythUIType base)
overrideprotectedvirtual

Copy this widgets state from another.

Reimplemented from MythUIType.

Definition at line 198 of file mythuicheckbox.cpp.

◆ CreateCopy()

void MythUICheckBox::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 189 of file mythuicheckbox.cpp.

◆ Finalize()

void MythUICheckBox::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 216 of file mythuicheckbox.cpp.

◆ SetInitialStates()

void MythUICheckBox::SetInitialStates ( void  )
protected

Definition at line 23 of file mythuicheckbox.cpp.

Referenced by CopyFrom(), and Finalize().

Member Data Documentation

◆ m_backgroundState

MythUIStateType* MythUICheckBox::m_backgroundState {nullptr}
protected

Definition at line 54 of file mythuicheckbox.h.

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

◆ m_checkState

MythUIStateType* MythUICheckBox::m_checkState {nullptr}
protected

Definition at line 55 of file mythuicheckbox.h.

Referenced by SetCheckState(), SetInitialStates(), and toggleCheckState().

◆ m_currentCheckState

MythUIStateType::StateType MythUICheckBox::m_currentCheckState {MythUIStateType::Off}
protected

◆ m_state

QString MythUICheckBox::m_state {"active"}
protected

Definition at line 58 of file mythuicheckbox.h.

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


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