MythUICheckBox Class Reference
[MythUI Widget and theme handling]

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

#include <mythuicheckbox.h>

Inheritance diagram for MythUICheckBox:
MythUIType XMLParseBase

List of all members.

Public Types

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

Signals

void valueChanged ()
void toggled (bool)

Public Member Functions

 MythUICheckBox (MythUIType *parent, const QString &name)
 ~MythUICheckBox ()
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 toggleCheckState (void)
void SetCheckState (MythUIStateType::StateType state)
void SetCheckState (bool onoff)
MythUIStateType::StateType GetCheckState () const
bool GetBooleanCheckState (void) const

Protected Slots

void Select ()
void Deselect ()
void Enable ()
void Disable ()

Protected Member Functions

virtual void CopyFrom (MythUIType *base)
virtual void CreateCopy (MythUIType *parent)
virtual void Finalize (void)
void SetInitialStates (void)

Protected Attributes

MythUIStateTypem_BackgroundState
MythUIStateTypem_CheckState
MythUIStateType::StateType m_currentCheckState
QString m_state

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

Enumerator:
None 
Normal 
Disabled 
Active 
Selected 
SelectedInactive 

Definition at line 23 of file mythuicheckbox.h.


Constructor & Destructor Documentation

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

Definition at line 12 of file mythuicheckbox.cpp.

Referenced by CreateCopy().

MythUICheckBox::~MythUICheckBox (  ) 

Definition at line 28 of file mythuicheckbox.cpp.


Member Function Documentation

bool MythUICheckBox::gestureEvent ( MythGestureEvent event  )  [virtual]

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

Should not be used directly.

Parameters:
uitype The mythuitype receiving the event
event Mouse event

Reimplemented from MythUIType.

Definition at line 156 of file mythuicheckbox.cpp.

bool MythUICheckBox::keyPressEvent ( QKeyEvent *  event  )  [virtual]

Key event handler.

Parameters:
event Keypress event

Reimplemented from MythUIType.

Definition at line 174 of file mythuicheckbox.cpp.

void MythUICheckBox::toggleCheckState ( void   ) 

Definition at line 50 of file mythuicheckbox.cpp.

Referenced by gestureEvent(), and keyPressEvent().

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

Definition at line 86 of file mythuicheckbox.cpp.

MythUIStateType::StateType MythUICheckBox::GetCheckState (  )  const
bool MythUICheckBox::GetBooleanCheckState ( void   )  const
void MythUICheckBox::Select (  )  [protected, slot]

Definition at line 115 of file mythuicheckbox.cpp.

Referenced by MythUICheckBox().

void MythUICheckBox::Deselect (  )  [protected, slot]

Definition at line 125 of file mythuicheckbox.cpp.

Referenced by MythUICheckBox().

void MythUICheckBox::Enable (  )  [protected, slot]

Definition at line 136 of file mythuicheckbox.cpp.

Referenced by MythUICheckBox().

void MythUICheckBox::Disable (  )  [protected, slot]

Definition at line 143 of file mythuicheckbox.cpp.

Referenced by MythUICheckBox().

void MythUICheckBox::valueChanged (  )  [signal]

Referenced by SetCheckState(), and toggleCheckState().

void MythUICheckBox::toggled ( bool   )  [signal]

Referenced by SetCheckState(), and toggleCheckState().

void MythUICheckBox::CopyFrom ( MythUIType base  )  [protected, virtual]

Copy this widgets state from another.

Reimplemented from MythUIType.

Definition at line 206 of file mythuicheckbox.cpp.

Referenced by CreateCopy().

void MythUICheckBox::CreateCopy ( MythUIType parent  )  [protected, virtual]

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

Reimplemented from MythUIType.

Definition at line 197 of file mythuicheckbox.cpp.

void MythUICheckBox::Finalize ( void   )  [protected, virtual]

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 224 of file mythuicheckbox.cpp.

void MythUICheckBox::SetInitialStates ( void   )  [protected]

Definition at line 32 of file mythuicheckbox.cpp.

Referenced by CopyFrom(), and Finalize().


Member Data Documentation

Definition at line 54 of file mythuicheckbox.h.

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

Definition at line 55 of file mythuicheckbox.h.

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

QString MythUICheckBox::m_state [protected]

Definition at line 58 of file mythuicheckbox.h.

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


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends
Generated on Mon May 28 06:42:18 2012 for MythTV by  doxygen 1.6.3