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

An editor screen that allows manipulation of raw settings values. More...

#include <rawsettingseditor.h>

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

Public Member Functions

 RawSettingsEditor (MythScreenStack *parent, const char *name=nullptr)
 Raw Settings Editor constructor. More...
 
 ~RawSettingsEditor ()=default
 
bool Create (void) override
 Creates the UI screen. More...
 
void Load (void) override
 Loads the current values for the specified settings list. More...
 
void Init (void) override
 Initialize the settings screen with the loaded data. More...
 
- 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
 

Protected Attributes

QString m_title
 
QMap< QString, QString > m_settings
 
- 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}
 

Private Slots

void Save (void)
 Save editted values and clear settings cache if necessary. More...
 
void selectionChanged (MythUIButtonListItem *item)
 Slot handler for buttonlist current item changes. More...
 
void valueChanged (void)
 Tracks current value for a setting when the value is editted. More...
 

Private Member Functions

void updatePrevNextTexts (void)
 Updates previous and next text areas. More...
 

Private Attributes

MythUIButtonListm_settingsList {nullptr}
 
MythUITextEditm_settingValue {nullptr}
 
MythUIButtonm_saveButton {nullptr}
 
MythUIButtonm_cancelButton {nullptr}
 
MythUITextm_textLabel {nullptr}
 
QHash< int, MythUIText * > m_prevNextTexts
 
QHash< int, MythUIShape * > m_prevNextShapes
 
QHash< QString, QString > m_origValues
 
QHash< QString, QString > m_settingValues
 

Additional Inherited Members

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

Detailed Description

An editor screen that allows manipulation of raw settings values.

This class is a base to build on. It is not meant to be used directly. Any inheritting class must set the title and list of settings names in its constructor.

Definition at line 25 of file rawsettingseditor.h.

Constructor & Destructor Documentation

◆ RawSettingsEditor()

RawSettingsEditor::RawSettingsEditor ( MythScreenStack parent,
const char *  name = nullptr 
)

Raw Settings Editor constructor.

Initializes necessary variables.

Parameters
parentParent screen stack for this window
nameName of this window

Definition at line 20 of file rawsettingseditor.cpp.

◆ ~RawSettingsEditor()

RawSettingsEditor::~RawSettingsEditor ( )
default

Member Function Documentation

◆ Create()

bool RawSettingsEditor::Create ( void  )
overridevirtual

Creates the UI screen.

Reimplemented from MythScreenType.

Definition at line 29 of file rawsettingseditor.cpp.

Referenced by main(), SetupMenuCallback(), and TVMenuCallback().

◆ Load()

void RawSettingsEditor::Load ( void  )
overridevirtual

Loads the current values for the specified settings list.

Reimplemented from MythScreenType.

Definition at line 85 of file rawsettingseditor.cpp.

◆ Init()

void RawSettingsEditor::Init ( void  )
overridevirtual

Initialize the settings screen with the loaded data.

Reimplemented from MythScreenType.

Definition at line 106 of file rawsettingseditor.cpp.

◆ Save

void RawSettingsEditor::Save ( void  )
privateslot

Save editted values and clear settings cache if necessary.

Definition at line 132 of file rawsettingseditor.cpp.

Referenced by Create().

◆ selectionChanged

void RawSettingsEditor::selectionChanged ( MythUIButtonListItem item)
privateslot

Slot handler for buttonlist current item changes.

Updates the text edit area with the current value of the setting that is currently selected in the button list.

Parameters
itemThe currently selected item in the buttonlist

Definition at line 164 of file rawsettingseditor.cpp.

Referenced by Create().

◆ valueChanged

void RawSettingsEditor::valueChanged ( void  )
privateslot

Tracks current value for a setting when the value is editted.

Updates the local in-memory settings value cache when the value for a setting in the list is updated.

Definition at line 221 of file rawsettingseditor.cpp.

Referenced by Create().

◆ updatePrevNextTexts()

void RawSettingsEditor::updatePrevNextTexts ( void  )
private

Updates previous and next text areas.

Updates previous and next text areas to show values of other non-current settings in the button list.

Definition at line 181 of file rawsettingseditor.cpp.

Referenced by Init(), and selectionChanged().

Member Data Documentation

◆ m_title

QString RawSettingsEditor::m_title
protected

◆ m_settings

QMap<QString, QString> RawSettingsEditor::m_settings
protected

◆ m_settingsList

MythUIButtonList* RawSettingsEditor::m_settingsList {nullptr}
private

Definition at line 59 of file rawsettingseditor.h.

Referenced by Create(), Init(), updatePrevNextTexts(), and valueChanged().

◆ m_settingValue

MythUITextEdit* RawSettingsEditor::m_settingValue {nullptr}
private

Definition at line 60 of file rawsettingseditor.h.

Referenced by Create(), selectionChanged(), and valueChanged().

◆ m_saveButton

MythUIButton* RawSettingsEditor::m_saveButton {nullptr}
private

Definition at line 62 of file rawsettingseditor.h.

Referenced by Create().

◆ m_cancelButton

MythUIButton* RawSettingsEditor::m_cancelButton {nullptr}
private

Definition at line 63 of file rawsettingseditor.h.

Referenced by Create().

◆ m_textLabel

MythUIText* RawSettingsEditor::m_textLabel {nullptr}
private

Definition at line 65 of file rawsettingseditor.h.

Referenced by Create(), Init(), and selectionChanged().

◆ m_prevNextTexts

QHash<int, MythUIText*> RawSettingsEditor::m_prevNextTexts
private

Definition at line 68 of file rawsettingseditor.h.

Referenced by Create(), and updatePrevNextTexts().

◆ m_prevNextShapes

QHash<int, MythUIShape*> RawSettingsEditor::m_prevNextShapes
private

Definition at line 69 of file rawsettingseditor.h.

Referenced by Create(), and updatePrevNextTexts().

◆ m_origValues

QHash<QString, QString> RawSettingsEditor::m_origValues
private

Definition at line 72 of file rawsettingseditor.h.

Referenced by Load(), and Save().

◆ m_settingValues

QHash<QString, QString> RawSettingsEditor::m_settingValues
private

Definition at line 73 of file rawsettingseditor.h.

Referenced by Load(), Save(), selectionChanged(), updatePrevNextTexts(), and valueChanged().


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