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

Screen for viewing and managing upcoming and conflicted recordings. More...

#include <viewscheduled.h>

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

Public Member Functions

 ViewScheduled (MythScreenStack *parent, TV *player=nullptr, bool showTV=false)
 
 ~ViewScheduled () override
 
bool Create (void) override
 
void ShowMenu (void) override
 
bool keyPressEvent (QKeyEvent *event) override
 Key event handler. More...
 
void customEvent (QEvent *event) override
 
- Public Member Functions inherited from MythScreenType
 MythScreenType (MythScreenStack *parent, const QString &name, bool fullscreen=true)
 
 ~MythScreenType () override
 
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...
 
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
 

Static Public Member Functions

static void * RunViewScheduled (void *player, bool showTv)
 
- 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 ChangeGroup (MythUIButtonListItem *item)
 
void deleteRule ()
 
void updateInfo (MythUIButtonListItem *item)
 
void SwitchList (void)
 
void Close (void) override
 
- Protected Slots inherited from ScheduleCommon
virtual void EditRecording (bool may_watch_now=false)
 Creates a dialog for editing the recording status, blocking until user leaves dialog. More...
 
virtual void EditRecording (MythUIButtonListItem *)
 
virtual void QuickRecord (void)
 Create a kSingleRecord or bring up recording dialog. More...
 
virtual void ShowPrevious (void) const
 Show the previous recordings for this recording rule. More...
 
virtual void ShowPrevious (uint ruleid, const QString &title) const
 Show the previous recordings for this recording rule. More...
 
virtual void ShowUpcoming (void) const
 Show the upcoming recordings for this title. More...
 
virtual void ShowUpcomingScheduled (void) const
 Show the upcoming recordings for this recording rule. More...
 
virtual void ShowChannelSearch (void) const
 Show the channel search. More...
 
virtual void ShowGuide (void) const
 Show the program guide. More...
 
virtual void EditScheduled (void)
 Creates a dialog for editing the recording schedule. More...
 
virtual void EditCustom (void)
 Creates a dialog for creating a custom recording rule. More...
 

Protected 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...
 
ProgramInfoGetCurrentProgram (void) const override
 
- Protected Member Functions inherited from ScheduleCommon
 ScheduleCommon (MythScreenStack *parent, const QString &name)
 
 ~ScheduleCommon () override=default
 
void customEvent (QEvent *event) override
 
- 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 (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...
 

Private Member Functions

void FillList (void)
 
void LoadList (bool useExistingData=false)
 
void setShowAll (bool all)
 
void viewInputs (void)
 
void EmbedTVWindow (void)
 
void UpdateUIListItem (MythUIButtonListItem *item, ProgramInfo *pginfo) const
 

Static Private Member Functions

static void CalcRecordedPercent (ProgramInfo &pg)
 

Private Attributes

bool m_conflictBool {false}
 
QDate m_conflictDate
 
QRect m_tvRect
 
MythUIButtonListm_schedulesList {nullptr}
 
MythUIButtonListm_groupList {nullptr}
 
MythUIProgressBarm_progressBar {nullptr}
 
bool m_showAll {false}
 
bool m_inEvent {false}
 
bool m_inFill {false}
 
bool m_needFill {false}
 
int m_listPos {0}
 
ProgramList m_recList
 
QMap< QDate, ProgramListm_recgroupList
 
QDate m_currentGroup
 
QDate m_defaultGroup
 
QMap< int, int > m_inputref
 
uint m_maxinput {0}
 
uint m_curinput {0}
 
TVm_player {nullptr}
 

Additional Inherited Members

- Public Slots inherited from ScheduleCommon
virtual void ShowDetails (void) const
 Show the Program Details screen. More...
 
- 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 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)
 
- Static Protected Member Functions inherited from ScheduleCommon
static void ShowUpcoming (const QString &title, const QString &seriesid)
 Show the upcoming recordings for this title. More...
 
static void EditScheduled (ProgramInfo *pginfo)
 Creates a dialog for editing the recording schedule. More...
 
static void EditScheduled (RecordingInfo *recinfo)
 Creates a dialog for editing the recording schedule. More...
 
static void MakeOverride (RecordingInfo *recinfo)
 Creates a dialog for editing an override recording schedule. More...
 
- Static Protected Member Functions inherited from MythUIType
static int NormX (int width)
 
static int NormY (int height)
 
- 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}
 

Detailed Description

Screen for viewing and managing upcoming and conflicted recordings.

Definition at line 29 of file viewscheduled.h.

Constructor & Destructor Documentation

◆ ViewScheduled()

ViewScheduled::ViewScheduled ( MythScreenStack parent,
TV player = nullptr,
bool  showTV = false 
)
explicit

Definition at line 38 of file viewscheduled.cpp.

Referenced by RunViewScheduled().

◆ ~ViewScheduled()

ViewScheduled::~ViewScheduled ( )
override

Definition at line 48 of file viewscheduled.cpp.

Member Function Documentation

◆ RunViewScheduled()

void * ViewScheduled::RunViewScheduled ( void *  player,
bool  showTv 
)
static

Definition at line 25 of file viewscheduled.cpp.

Referenced by SetFuncPtrs().

◆ Create()

bool ViewScheduled::Create ( void  )
overridevirtual

Reimplemented from MythScreenType.

Definition at line 61 of file viewscheduled.cpp.

◆ ShowMenu()

void ViewScheduled::ShowMenu ( void  )
overridevirtual

Reimplemented from MythScreenType.

Definition at line 193 of file viewscheduled.cpp.

◆ keyPressEvent()

bool ViewScheduled::keyPressEvent ( QKeyEvent *  event)
overridevirtual

Key event handler.

Parameters
eventKeypress event

Reimplemented from MythScreenType.

Definition at line 129 of file viewscheduled.cpp.

◆ customEvent()

void ViewScheduled::customEvent ( QEvent *  event)
override

Definition at line 589 of file viewscheduled.cpp.

◆ ChangeGroup

void ViewScheduled::ChangeGroup ( MythUIButtonListItem item)
protectedslot

Definition at line 370 of file viewscheduled.cpp.

Referenced by Create().

◆ deleteRule

void ViewScheduled::deleteRule ( )
protectedslot

Definition at line 529 of file viewscheduled.cpp.

Referenced by customEvent(), and keyPressEvent().

◆ updateInfo

void ViewScheduled::updateInfo ( MythUIButtonListItem item)
protectedslot

Definition at line 505 of file viewscheduled.cpp.

Referenced by Create(), and customEvent().

◆ SwitchList

void ViewScheduled::SwitchList ( void  )
protectedslot

Definition at line 121 of file viewscheduled.cpp.

Referenced by Create().

◆ Close

void ViewScheduled::Close ( void  )
overrideprotectedslot

Definition at line 112 of file viewscheduled.cpp.

◆ Load()

void ViewScheduled::Load ( void  )
overrideprotectedvirtual

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 102 of file viewscheduled.cpp.

◆ Init()

void ViewScheduled::Init ( void  )
overrideprotectedvirtual

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 107 of file viewscheduled.cpp.

◆ GetCurrentProgram()

ProgramInfo * ViewScheduled::GetCurrentProgram ( void  ) const
overrideprotectedvirtual

Reimplemented from ScheduleCommon.

Definition at line 734 of file viewscheduled.cpp.

◆ FillList()

void ViewScheduled::FillList ( void  )
private

Definition at line 431 of file viewscheduled.cpp.

Referenced by ChangeGroup(), and LoadList().

◆ LoadList()

void ViewScheduled::LoadList ( bool  useExistingData = false)
private

Definition at line 226 of file viewscheduled.cpp.

Referenced by customEvent(), Init(), and keyPressEvent().

◆ setShowAll()

void ViewScheduled::setShowAll ( bool  all)
private

Definition at line 563 of file viewscheduled.cpp.

Referenced by customEvent(), and keyPressEvent().

◆ viewInputs()

void ViewScheduled::viewInputs ( void  )
private

Definition at line 569 of file viewscheduled.cpp.

Referenced by customEvent(), and keyPressEvent().

◆ EmbedTVWindow()

void ViewScheduled::EmbedTVWindow ( void  )
private

Definition at line 583 of file viewscheduled.cpp.

Referenced by Create(), and customEvent().

◆ UpdateUIListItem()

void ViewScheduled::UpdateUIListItem ( MythUIButtonListItem item,
ProgramInfo pginfo 
) const
private

Definition at line 383 of file viewscheduled.cpp.

Referenced by customEvent(), and FillList().

◆ CalcRecordedPercent()

static void ViewScheduled::CalcRecordedPercent ( ProgramInfo pg)
staticprivate

Member Data Documentation

◆ m_conflictBool

bool ViewScheduled::m_conflictBool {false}
private

Definition at line 68 of file viewscheduled.h.

Referenced by FillList(), Load(), and LoadList().

◆ m_conflictDate

QDate ViewScheduled::m_conflictDate
private

Definition at line 69 of file viewscheduled.h.

Referenced by FillList().

◆ m_tvRect

QRect ViewScheduled::m_tvRect
private

Definition at line 71 of file viewscheduled.h.

◆ m_schedulesList

MythUIButtonList* ViewScheduled::m_schedulesList {nullptr}
private

◆ m_groupList

MythUIButtonList* ViewScheduled::m_groupList {nullptr}
private

Definition at line 74 of file viewscheduled.h.

Referenced by Create(), LoadList(), and SwitchList().

◆ m_progressBar

MythUIProgressBar* ViewScheduled::m_progressBar {nullptr}
private

Definition at line 75 of file viewscheduled.h.

Referenced by Create(), and updateInfo().

◆ m_showAll

bool ViewScheduled::m_showAll {false}
private

Definition at line 77 of file viewscheduled.h.

Referenced by FillList(), keyPressEvent(), LoadList(), setShowAll(), ShowMenu(), and ~ViewScheduled().

◆ m_inEvent

bool ViewScheduled::m_inEvent {false}
private

Definition at line 79 of file viewscheduled.h.

Referenced by customEvent(), and keyPressEvent().

◆ m_inFill

bool ViewScheduled::m_inFill {false}
private

Definition at line 80 of file viewscheduled.h.

Referenced by ChangeGroup(), and LoadList().

◆ m_needFill

bool ViewScheduled::m_needFill {false}
private

Definition at line 81 of file viewscheduled.h.

Referenced by customEvent(), keyPressEvent(), LoadList(), setShowAll(), and viewInputs().

◆ m_listPos

int ViewScheduled::m_listPos {0}
private

Definition at line 83 of file viewscheduled.h.

◆ m_recList

ProgramList ViewScheduled::m_recList
private

Definition at line 84 of file viewscheduled.h.

Referenced by ChangeGroup(), customEvent(), FillList(), Load(), and LoadList().

◆ m_recgroupList

QMap<QDate, ProgramList> ViewScheduled::m_recgroupList
private

Definition at line 85 of file viewscheduled.h.

Referenced by FillList(), and LoadList().

◆ m_currentGroup

QDate ViewScheduled::m_currentGroup
private

Definition at line 87 of file viewscheduled.h.

Referenced by ChangeGroup(), FillList(), and LoadList().

◆ m_defaultGroup

QDate ViewScheduled::m_defaultGroup
private

Definition at line 88 of file viewscheduled.h.

Referenced by FillList(), and LoadList().

◆ m_inputref

QMap<int, int> ViewScheduled::m_inputref
private

Definition at line 90 of file viewscheduled.h.

Referenced by LoadList(), and viewInputs().

◆ m_maxinput

uint ViewScheduled::m_maxinput {0}
private

Definition at line 91 of file viewscheduled.h.

Referenced by LoadList(), and viewInputs().

◆ m_curinput

uint ViewScheduled::m_curinput {0}
private

Definition at line 92 of file viewscheduled.h.

Referenced by UpdateUIListItem(), and viewInputs().

◆ m_player

TV* ViewScheduled::m_player {nullptr}
private

Definition at line 94 of file viewscheduled.h.

Referenced by Close(), EmbedTVWindow(), ViewScheduled(), and ~ViewScheduled().


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