MythTV  master
Public Types | Public Member Functions | Static Public Member Functions | Protected Slots | Private Member Functions | Private Attributes | List of all members
BackendSelection Class Reference

Classes to Prompt user for a master backend. More...

#include <backendselect.h>

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

Public Types

enum  Decision { kManualConfigure = -1, kCancelConfigure = 0, kAcceptConfigure = +1 }
 
typedef enum BackendSelection::Decision BackendDecision
 

Public Member Functions

 BackendSelection (MythScreenStack *parent, DatabaseParams *params, Configuration *pConfig, bool exitOnFinish=false)
 
virtual ~BackendSelection ()
 
bool Create (void) override
 
void Close (void) override
 
void customEvent (QEvent *event) override
 
- Public Member Functions inherited from MythScreenType
 MythScreenType (MythScreenStack *parent, const QString &name, bool fullscreen=true)
 
virtual ~MythScreenType ()
 
bool keyPressEvent (QKeyEvent *) override
 Key event handler. More...
 
bool gestureEvent (MythGestureEvent *) 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)
 
bool IsLoaded (void)
 
MythPainterGetPainter (void) override
 
- Public Member Functions inherited from MythUIComposite
 MythUIComposite (QObject *parent, const QString &name)
 
virtual ~MythUIComposite ()=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 (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...
 
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
 

Static Public Member Functions

static Decision Prompt (DatabaseParams *dbParams, Configuration *pConfig)
 
- 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)
 

Protected Slots

void Accept (void)
 
void Accept (MythUIButtonListItem *)
 
void Manual (void)
 Linked to 'Configure Manually' button. More...
 
void Cancel (void)
 Linked to 'Cancel' button. More...
 

Private Member Functions

void Load (void) override
 Load data which will ultimately be displayed on-screen or used to determine what appears on-screen (See Warning) More...
 
void Init (void) override
 Used after calling Load() to assign data to widgets and other UI initilisation which is prohibited in Load() More...
 
bool ConnectBackend (DeviceLocation *dev)
 Attempt UPnP connection to a backend device, get its DB details. More...
 
void AddItem (DeviceLocation *dev)
 
void RemoveItem (const QString &USN)
 
bool TryDBfromURL (const QString &error, QString URL)
 
void PromptForPassword (void)
 
void CloseWithDecision (Decision)
 

Private Attributes

DatabaseParamsm_DBparams {nullptr}
 
Configurationm_pConfig {nullptr}
 
bool m_exitOnFinish
 
ItemMap m_devices
 
MythUIButtonListm_backendList {nullptr}
 
MythUIButtonm_manualButton {nullptr}
 
MythUIButtonm_saveButton {nullptr}
 
MythUIButtonm_cancelButton {nullptr}
 
QString m_pinCode
 
QString m_USN
 
QMutex m_mutex
 
BackendDecision m_backendDecision {kCancelConfigure}
 
QEventLoop * m_loop {nullptr}
 

Additional Inherited Members

- Public Slots inherited from MythScreenType
- 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 inherited from MythScreenType
void Exiting ()
 
- 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)
 
- 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...
 
void LoadInBackground (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
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)
 
int NormX (const int width)
 
int NormY (const int height)
 
void ConnectDependants (bool recurse=false)
 
virtual void Finalize (void)
 Perform any post-xml parsing initialisation tasks. More...
 
- 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}
 
QMap< int, MythUIType * > 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}
 

Detailed Description

Classes to Prompt user for a master backend.

Author
Originally based on masterselection.cpp/h by David Blain.

Definition at line 37 of file backendselect.h.

Member Typedef Documentation

◆ BackendDecision

Member Enumeration Documentation

◆ Decision

Enumerator
kManualConfigure 
kCancelConfigure 
kAcceptConfigure 

Definition at line 42 of file backendselect.h.

Constructor & Destructor Documentation

◆ BackendSelection()

BackendSelection::BackendSelection ( MythScreenStack parent,
DatabaseParams params,
Configuration pConfig,
bool  exitOnFinish = false 
)

Definition at line 16 of file backendselect.cpp.

Referenced by Prompt().

◆ ~BackendSelection()

BackendSelection::~BackendSelection ( )
virtual

Definition at line 28 of file backendselect.cpp.

Member Function Documentation

◆ Prompt()

BackendSelection::Decision BackendSelection::Prompt ( DatabaseParams dbParams,
Configuration pConfig 
)
static

Definition at line 47 of file backendselect.cpp.

Referenced by MythContextPrivate::ChooseBackend().

◆ Create()

bool BackendSelection::Create ( void  )
overridevirtual

Reimplemented from MythScreenType.

Definition at line 71 of file backendselect.cpp.

Referenced by Prompt().

◆ Close()

void BackendSelection::Close ( void  )
overridevirtual

Reimplemented from MythScreenType.

Definition at line 374 of file backendselect.cpp.

◆ customEvent()

void BackendSelection::customEvent ( QEvent *  event)
override

Definition at line 305 of file backendselect.cpp.

◆ Accept [1/2]

void BackendSelection::Accept ( void  )
protectedslot

Definition at line 124 of file backendselect.cpp.

Referenced by Create(), and customEvent().

◆ Accept [2/2]

void BackendSelection::Accept ( MythUIButtonListItem item)
protectedslot

Definition at line 96 of file backendselect.cpp.

◆ Manual

void BackendSelection::Manual ( void  )
protectedslot

Linked to 'Configure Manually' button.

Definition at line 270 of file backendselect.cpp.

Referenced by Create().

◆ Cancel

void BackendSelection::Cancel ( void  )
protectedslot

Linked to 'Cancel' button.

Definition at line 241 of file backendselect.cpp.

Referenced by Accept(), and Create().

◆ Load()

void BackendSelection::Load ( void  )
overrideprivatevirtual

Load data which will ultimately be displayed on-screen or used to determine what appears on-screen (See Warning)

Warning
This method should only load data, it should NEVER perform UI routines or segfaults WILL result. This includes assinging data to any widgets, calling methods on a widget or anything else which triggers redraws. The safest and recommended approach is to avoid any interaction with a libmythui class or class member.

Reimplemented from MythScreenType.

Definition at line 246 of file backendselect.cpp.

◆ Init()

void BackendSelection::Init ( void  )
overrideprivatevirtual

Used after calling Load() to assign data to widgets and other UI initilisation which is prohibited in Load()

Warning
Do NOT confuse this with Load(), they serve very different purposes and most often both should be used when creating a new screen.

Reimplemented from MythScreenType.

Definition at line 252 of file backendselect.cpp.

◆ ConnectBackend()

bool BackendSelection::ConnectBackend ( DeviceLocation dev)
private

Attempt UPnP connection to a backend device, get its DB details.

Will loop until a valid PIN is entered.

Definition at line 188 of file backendselect.cpp.

Referenced by Accept().

◆ AddItem()

void BackendSelection::AddItem ( DeviceLocation dev)
private

Definition at line 135 of file backendselect.cpp.

Referenced by customEvent(), and Init().

◆ RemoveItem()

void BackendSelection::RemoveItem ( const QString &  USN)
private

Definition at line 275 of file backendselect.cpp.

Referenced by customEvent().

◆ TryDBfromURL()

bool BackendSelection::TryDBfromURL ( const QString &  error,
QString  URL 
)
private

Definition at line 291 of file backendselect.cpp.

Referenced by ConnectBackend().

◆ PromptForPassword()

void BackendSelection::PromptForPassword ( void  )
private

Definition at line 354 of file backendselect.cpp.

Referenced by ConnectBackend().

◆ CloseWithDecision()

void BackendSelection::CloseWithDecision ( Decision  d)
private

Definition at line 379 of file backendselect.cpp.

Referenced by Accept(), Cancel(), Close(), and Manual().

Member Data Documentation

◆ m_DBparams

DatabaseParams* BackendSelection::m_DBparams {nullptr}
private

Definition at line 75 of file backendselect.h.

Referenced by ConnectBackend(), and TryDBfromURL().

◆ m_pConfig

Configuration* BackendSelection::m_pConfig {nullptr}
private

Definition at line 76 of file backendselect.h.

Referenced by Accept().

◆ m_exitOnFinish

bool BackendSelection::m_exitOnFinish
private

Definition at line 77 of file backendselect.h.

Referenced by CloseWithDecision(), and ~BackendSelection().

◆ m_devices

ItemMap BackendSelection::m_devices
private

Definition at line 78 of file backendselect.h.

Referenced by AddItem(), RemoveItem(), and ~BackendSelection().

◆ m_backendList

MythUIButtonList* BackendSelection::m_backendList {nullptr}
private

Definition at line 80 of file backendselect.h.

Referenced by Accept(), AddItem(), ConnectBackend(), and Create().

◆ m_manualButton

MythUIButton* BackendSelection::m_manualButton {nullptr}
private

Definition at line 81 of file backendselect.h.

Referenced by Create().

◆ m_saveButton

MythUIButton* BackendSelection::m_saveButton {nullptr}
private

Definition at line 82 of file backendselect.h.

Referenced by Create().

◆ m_cancelButton

MythUIButton* BackendSelection::m_cancelButton {nullptr}
private

Definition at line 83 of file backendselect.h.

Referenced by Create().

◆ m_pinCode

QString BackendSelection::m_pinCode
private

Definition at line 86 of file backendselect.h.

Referenced by Accept(), ConnectBackend(), and customEvent().

◆ m_USN

QString BackendSelection::m_USN
private

Definition at line 87 of file backendselect.h.

Referenced by Accept(), and ConnectBackend().

◆ m_mutex

QMutex BackendSelection::m_mutex
private

Definition at line 89 of file backendselect.h.

Referenced by AddItem(), and RemoveItem().

◆ m_backendDecision

BackendDecision BackendSelection::m_backendDecision {kCancelConfigure}
private

Definition at line 91 of file backendselect.h.

Referenced by CloseWithDecision(), and Prompt().

◆ m_loop

QEventLoop* BackendSelection::m_loop {nullptr}
private

Definition at line 92 of file backendselect.h.

Referenced by BackendSelection(), CloseWithDecision(), Prompt(), and ~BackendSelection().


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