ProgInfoList Class Reference

The info/details buttonlist overlay that displays key:data info. More...

#include <mythfrontend/proginfolist.h>

Inheritance diagram for ProgInfoList:

Collaboration diagram for ProgInfoList:

Public Types
enum	VisibleLevel : std::uint8_t { kNone = 0 , kLevel1 = 1 , kLevel2 = 2 }
using	DataItem = std::tuple< QString, QString, int >
using	DataList = QList< DataItem >

Public Member Functions
	ProgInfoList (MythScreenType &screen)
bool	Create (bool focusable)
	Initialise buttonlist from XML. More...
void	Toggle (void)
	Toggle infolist state. Focusable widgets toggle between Basic & Full info. Non-focusable widgets toggle between Basic & Off. More...
bool	Hide (void)
	Remove infolist from display. More...
void	Display (const DataList &data)
	Build list of key:value buttons. More...
VisibleLevel	GetLevel (void) const
void	PageDown (void)
void	PageUp (void)

Private Slots
void	Clear ()

Private Member Functions
void	CreateButton (const QString &name, const QString &value)
	Populate a buttonlist item with name & value. More...

Private Attributes
MythScreenType &	m_screen
	Parent screen. More...
MythUIButtonList *	m_btnList {nullptr}
	Overlay buttonlist. More...
VisibleLevel	m_infoVisible {kLevel1}
	Info list state. More...

Detailed Description

The info/details buttonlist overlay that displays key:data info.

Definition at line 12 of file proginfolist.h.

Member Typedef Documentation

DataItem

using ProgInfoList::DataItem = std::tuple<QString, QString, int>

Definition at line 20 of file proginfolist.h.

DataList

using ProgInfoList::DataList = QList<DataItem>

Definition at line 21 of file proginfolist.h.

Member Enumeration Documentation

VisibleLevel

enum ProgInfoList::VisibleLevel : std::uint8_t

Enumerator
kNone
kLevel1
kLevel2

Definition at line 17 of file proginfolist.h.

Constructor & Destructor Documentation

ProgInfoList()

ProgInfoList::ProgInfoList ( MythScreenType &  screen )

inlineexplicit

Definition at line 24 of file proginfolist.h.

Member Function Documentation

Clear

void ProgInfoList::Clear ( void  )

inlineprivateslot

Definition at line 37 of file proginfolist.h.

Referenced by Display(), and Toggle().

Create()

bool ProgInfoList::Create

(

bool

focusable

)

Initialise buttonlist from XML.

Parameters

focusable

Set if info list should be focusable (for scrolling)

Returns

bool True initialization succeeds

Definition at line 13 of file proginfolist.cpp.

Referenced by ProgDetails::Create().

CreateButton()

void ProgInfoList::CreateButton ( const QString &  name, const QString &  value  )

private

Populate a buttonlist item with name & value.

Parameters

name
value

Definition at line 78 of file proginfolist.cpp.

Referenced by Display().

Display()

void ProgInfoList::Display

(

const DataList &

data

)

Build list of key:value buttons.

Parameters

data	key/value list

Definition at line 97 of file proginfolist.cpp.

Referenced by ProgDetails::updatePage().

GetLevel()

VisibleLevel ProgInfoList::GetLevel ( void  ) const

inline

Definition at line 31 of file proginfolist.h.

Hide()

bool ProgInfoList::Hide

(

void

)

Remove infolist from display.

Returns

bool True if buttonlist was displayed/removed

Definition at line 60 of file proginfolist.cpp.

Referenced by ProgDetails::~ProgDetails().

PageDown()

void ProgInfoList::PageDown ( void  )

inline

Definition at line 33 of file proginfolist.h.

Referenced by ProgDetails::keyPressEvent().

PageUp()

void ProgInfoList::PageUp ( void  )

inline

Definition at line 34 of file proginfolist.h.

Referenced by ProgDetails::keyPressEvent().

Toggle()

void ProgInfoList::Toggle

(

void

)

Toggle infolist state. Focusable widgets toggle between Basic & Full info. Non-focusable widgets toggle between Basic & Off.

Definition at line 30 of file proginfolist.cpp.

Referenced by ProgDetails::keyPressEvent().

Member Data Documentation

m_btnList

MythUIButtonList* ProgInfoList::m_btnList {nullptr}

private

Overlay buttonlist.

Definition at line 43 of file proginfolist.h.

Referenced by Clear(), Create(), CreateButton(), Display(), Hide(), PageDown(), PageUp(), and Toggle().

m_infoVisible

VisibleLevel ProgInfoList::m_infoVisible {kLevel1}

private

Info list state.

Definition at line 44 of file proginfolist.h.

Referenced by Display(), GetLevel(), Hide(), and Toggle().

m_screen

MythScreenType& ProgInfoList::m_screen

private

Parent screen.

Definition at line 42 of file proginfolist.h.

Referenced by Create(), and Display().

---

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

• mythtv/programs/mythfrontend/proginfolist.h
• mythtv/programs/mythfrontend/proginfolist.cpp