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

Basic menu dialog, message and a list of options. More...

#include <mythdialogbox.h>

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

Public Slots

void Select (MythUIButtonListItem *item)
 
- Public Slots inherited from MythScreenType
virtual void Close ()
 
- 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)
 

Signals

void Selected ()
 
void Closed (QString, int)
 
- Signals inherited from MythScreenType
void Exiting ()
 
- 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

 MythDialogBox (QString text, MythScreenStack *parent, const char *name, bool fullscreen=false, bool osd=false)
 
 MythDialogBox (QString title, QString text, MythScreenStack *parent, const char *name, bool fullscreen=false, bool osd=false)
 
 MythDialogBox (MythMenu *menu, MythScreenStack *parent, const char *name, bool fullscreen=false, bool osd=false)
 
 ~MythDialogBox (void) override
 
bool Create (void) override
 
void SetMenuItems (MythMenu *menu)
 
void SetReturnEvent (QObject *retobject, const QString &resultid)
 
void SetBackAction (const QString &text, QVariant data)
 
void SetExitAction (const QString &text, QVariant data)
 
void SetText (const QString &text)
 
void AddButtonV (const QString &title, QVariant data=0, bool newMenu=false, bool setCurrent=false)
 
void AddButtonD (const QString &title, bool setCurrent)
 
void AddButton (const QString &title)
 
void AddButton (const QString &title, const MythUICallbackNMF &slot, bool newMenu=false, bool setCurrent=false)
 
template<typename SLOT >
std::enable_if_t< FunctionPointerTest< SLOT >::MemberFunction > AddButton (const QString &title, const SLOT &slot, bool newMenu=false, bool setCurrent=false)
 
template<typename SLOT >
std::enable_if_t< FunctionPointerTest< SLOT >::MemberConstFunction > AddButton (const QString &title, const SLOT &slot, bool newMenu=false, bool setCurrent=false)
 
bool keyPressEvent (QKeyEvent *event) override
 Key event handler. More...
 
bool inputMethodEvent (QInputMethodEvent *event) override
 Input Method event handler. More...
 
bool gestureEvent (MythGestureEvent *event) override
 Mouse click/movement handler, receives mouse gesture events from the QCoreApplication event loop. More...
 
- Public Member Functions inherited from MythScreenType
 MythScreenType (MythScreenStack *parent, const QString &name, bool fullscreen=true)
 
 ~MythScreenType () override
 
bool keyPressEvent (QKeyEvent *event) override
 Key event handler. More...
 
bool inputMethodEvent (QInputMethodEvent *event) override
 Input Method event handler. More...
 
bool gestureEvent (MythGestureEvent *event) override
 Mouse click/movement handler, receives mouse gesture events from the QCoreApplication event loop. More...
 
virtual void ShowMenu (void)
 
void doInit (void)
 
void LoadInForeground (void)
 
bool IsInitialized (void) const
 Has Init() been called on this screen? More...
 
bool IsFullscreen (void) const
 
void SetFullscreen (bool full)
 
MythUITypeGetFocusWidget (void) const
 
bool SetFocusWidget (MythUIType *widget=nullptr)
 
virtual bool NextPrevWidgetFocus (bool up_or_down)
 
void BuildFocusList (void)
 
MythScreenStackGetScreenStack () const
 
virtual void aboutToHide (void)
 
virtual void aboutToShow (void)
 
bool IsDeleting (void) const
 
void SetDeleting (bool deleting)
 
bool IsLoading (void) const
 
bool IsLoaded (void) const
 
MythPainterGetPainter (void) override
 
- Public Member Functions inherited from MythUIComposite
 MythUIComposite (QObject *parent, const QString &name)
 
 ~MythUIComposite () override=default
 
virtual void SetTextFromMap (const InfoMap &infoMap)
 
virtual void ResetMap (const InfoMap &infoMap)
 
- 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 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...
 
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 Member Functions

void SendEvent (int res, const QString &text="", const QVariant &data=0)
 
void updateMenu (void)
 
- Protected Member Functions inherited from MythScreenType
 MythScreenType (MythUIType *parent, const QString &name, bool fullscreen=true)
 
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...
 
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...
 
virtual void Load (void)
 Load data which will ultimately be displayed on-screen or used to determine what appears on-screen (See Warning) More...
 
virtual void Init (void)
 Used after calling Load() to assign data to widgets and other UI initilisation which is prohibited in Load() More...
 
void LoadInBackground (const QString &message="")
 
void ReloadInBackground (void)
 
void OpenBusyPopup (const QString &message="")
 
void CloseBusyPopup (void)
 
void SetBusyPopupMessage (const QString &message)
 
void ResetBusyPopup (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 void Finalize (void)
 Perform any post-xml parsing initialisation tasks. More...
 

Protected Attributes

MythUITextm_titlearea {nullptr}
 
MythUITextm_textarea {nullptr}
 
MythUIButtonListm_buttonList {nullptr}
 
QObject * m_retObject {nullptr}
 
QString m_id
 
bool m_useSlots {false}
 
bool m_fullscreen {false}
 
bool m_osdDialog {false}
 
QString m_title
 
QString m_text
 
QString m_backtext
 
QVariant m_backdata {0}
 
QString m_exittext
 
QVariant m_exitdata {0}
 
MythMenum_menu {nullptr}
 
MythMenum_currentMenu {nullptr}
 
- Protected Attributes inherited from MythScreenType
bool m_fullScreen {false}
 
bool m_isDeleting {false}
 
QSemaphore m_loadLock {1}
 
volatile bool m_isLoading {false}
 
volatile bool m_isLoaded {false}
 
bool m_isInitialized {false}
 
MythUITypem_currentFocusWidget {nullptr}
 
FocusInfoType m_focusWidgetList
 
MythScreenStackm_screenStack {nullptr}
 
MythUIBusyDialogm_busyPopup {nullptr}
 
QRegion m_savedMask
 
- 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

- 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

Basic menu dialog, message and a list of options.

Sends out a DialogCompletionEvent event and the Selected() signal containing the result when the user selects the Ok button.

Definition at line 166 of file mythdialogbox.h.

Constructor & Destructor Documentation

◆ MythDialogBox() [1/3]

MythDialogBox::MythDialogBox ( QString  text,
MythScreenStack parent,
const char *  name,
bool  fullscreen = false,
bool  osd = false 
)
inline

Definition at line 170 of file mythdialogbox.h.

◆ MythDialogBox() [2/3]

MythDialogBox::MythDialogBox ( QString  title,
QString  text,
MythScreenStack parent,
const char *  name,
bool  fullscreen = false,
bool  osd = false 
)
inline

Definition at line 175 of file mythdialogbox.h.

◆ MythDialogBox() [3/3]

MythDialogBox::MythDialogBox ( MythMenu menu,
MythScreenStack parent,
const char *  name,
bool  fullscreen = false,
bool  osd = false 
)
inline

Definition at line 180 of file mythdialogbox.h.

◆ ~MythDialogBox()

MythDialogBox::~MythDialogBox ( void  )
override

Definition at line 118 of file mythdialogbox.cpp.

Member Function Documentation

◆ Create()

bool MythDialogBox::Create ( void  )
overridevirtual

◆ SetMenuItems()

void MythDialogBox::SetMenuItems ( MythMenu menu)

Definition at line 167 of file mythdialogbox.cpp.

◆ SetReturnEvent()

void MythDialogBox::SetReturnEvent ( QObject *  retobject,
const QString &  resultid 
)

◆ SetBackAction()

void MythDialogBox::SetBackAction ( const QString &  text,
QVariant  data 
)

Definition at line 308 of file mythdialogbox.cpp.

◆ SetExitAction()

void MythDialogBox::SetExitAction ( const QString &  text,
QVariant  data 
)

Definition at line 314 of file mythdialogbox.cpp.

◆ SetText()

void MythDialogBox::SetText ( const QString &  text)

Definition at line 320 of file mythdialogbox.cpp.

◆ AddButtonV()

void MythDialogBox::AddButtonV ( const QString &  title,
QVariant  data = 0,
bool  newMenu = false,
bool  setCurrent = false 
)

Definition at line 326 of file mythdialogbox.cpp.

Referenced by MythThemedMenu::ShowMenu().

◆ AddButtonD()

void MythDialogBox::AddButtonD ( const QString &  title,
bool  setCurrent 
)
inline

Definition at line 197 of file mythdialogbox.h.

◆ AddButton() [1/4]

void MythDialogBox::AddButton ( const QString &  title)
inline

◆ AddButton() [2/4]

void MythDialogBox::AddButton ( const QString &  title,
const MythUICallbackNMF slot,
bool  newMenu = false,
bool  setCurrent = false 
)
inline

Definition at line 200 of file mythdialogbox.h.

◆ AddButton() [3/4]

template<typename SLOT >
std::enable_if_t<FunctionPointerTest<SLOT>::MemberFunction> MythDialogBox::AddButton ( const QString &  title,
const SLOT &  slot,
bool  newMenu = false,
bool  setCurrent = false 
)
inline

Definition at line 209 of file mythdialogbox.h.

◆ AddButton() [4/4]

template<typename SLOT >
std::enable_if_t<FunctionPointerTest<SLOT>::MemberConstFunction> MythDialogBox::AddButton ( const QString &  title,
const SLOT &  slot,
bool  newMenu = false,
bool  setCurrent = false 
)
inline

Definition at line 219 of file mythdialogbox.h.

◆ keyPressEvent()

bool MythDialogBox::keyPressEvent ( QKeyEvent *  event)
overridevirtual

Key event handler.

Parameters
eventKeypress event

Reimplemented from MythUIType.

Definition at line 345 of file mythdialogbox.cpp.

◆ inputMethodEvent()

bool MythDialogBox::inputMethodEvent ( QInputMethodEvent *  event)
overridevirtual

Input Method event handler.

Parameters
eventInput Method event

Reimplemented from MythUIType.

Definition at line 340 of file mythdialogbox.cpp.

◆ gestureEvent()

bool MythDialogBox::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 402 of file mythdialogbox.cpp.

◆ Select

void MythDialogBox::Select ( MythUIButtonListItem item)
slot

Definition at line 208 of file mythdialogbox.cpp.

Referenced by Create(), and keyPressEvent().

◆ Selected

void MythDialogBox::Selected ( )
signal

Referenced by Select().

◆ Closed

void MythDialogBox::Closed ( QString  ,
int   
)
signal

◆ SendEvent()

void MythDialogBox::SendEvent ( int  res,
const QString &  text = "",
const QVariant &  data = 0 
)
protected

Definition at line 426 of file mythdialogbox.cpp.

Referenced by gestureEvent(), keyPressEvent(), and Select().

◆ updateMenu()

void MythDialogBox::updateMenu ( void  )
protected

Definition at line 174 of file mythdialogbox.cpp.

Referenced by Create(), keyPressEvent(), Select(), and SetMenuItems().

Member Data Documentation

◆ m_titlearea

MythUIText* MythDialogBox::m_titlearea {nullptr}
protected

Definition at line 242 of file mythdialogbox.h.

Referenced by Create(), and updateMenu().

◆ m_textarea

MythUIText* MythDialogBox::m_textarea {nullptr}
protected

Definition at line 243 of file mythdialogbox.h.

Referenced by Create(), SetText(), and updateMenu().

◆ m_buttonList

MythUIButtonList* MythDialogBox::m_buttonList {nullptr}
protected

Definition at line 244 of file mythdialogbox.h.

Referenced by AddButtonV(), Create(), keyPressEvent(), Select(), and updateMenu().

◆ m_retObject

QObject* MythDialogBox::m_retObject {nullptr}
protected

Definition at line 245 of file mythdialogbox.h.

Referenced by Select(), SendEvent(), and SetReturnEvent().

◆ m_id

QString MythDialogBox::m_id
protected

Definition at line 246 of file mythdialogbox.h.

Referenced by SendEvent(), and SetReturnEvent().

◆ m_useSlots

bool MythDialogBox::m_useSlots {false}
protected

Definition at line 247 of file mythdialogbox.h.

Referenced by Select().

◆ m_fullscreen

bool MythDialogBox::m_fullscreen {false}
protected

Definition at line 249 of file mythdialogbox.h.

Referenced by Create().

◆ m_osdDialog

bool MythDialogBox::m_osdDialog {false}
protected

Definition at line 250 of file mythdialogbox.h.

Referenced by Create().

◆ m_title

QString MythDialogBox::m_title
protected

Definition at line 251 of file mythdialogbox.h.

Referenced by Create().

◆ m_text

QString MythDialogBox::m_text
protected

Definition at line 252 of file mythdialogbox.h.

Referenced by Create().

◆ m_backtext

QString MythDialogBox::m_backtext
protected

Definition at line 254 of file mythdialogbox.h.

Referenced by keyPressEvent(), and SetBackAction().

◆ m_backdata

QVariant MythDialogBox::m_backdata {0}
protected

Definition at line 255 of file mythdialogbox.h.

Referenced by keyPressEvent(), and SetBackAction().

◆ m_exittext

QString MythDialogBox::m_exittext
protected

Definition at line 256 of file mythdialogbox.h.

Referenced by keyPressEvent(), and SetExitAction().

◆ m_exitdata

QVariant MythDialogBox::m_exitdata {0}
protected

Definition at line 257 of file mythdialogbox.h.

Referenced by keyPressEvent(), and SetExitAction().

◆ m_menu

MythMenu* MythDialogBox::m_menu {nullptr}
protected

Definition at line 259 of file mythdialogbox.h.

Referenced by Create(), SetMenuItems(), and ~MythDialogBox().

◆ m_currentMenu

MythMenu* MythDialogBox::m_currentMenu {nullptr}
protected

Definition at line 260 of file mythdialogbox.h.

Referenced by keyPressEvent(), Select(), SendEvent(), SetMenuItems(), and updateMenu().


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