PVR::CPVRGUIInfo Class Reference

#include <PVRGUIInfo.h>

Inheritance diagram for PVR::CPVRGUIInfo:

Public Member Functions
	CPVRGUIInfo ()
	~CPVRGUIInfo () override=default
void	Start ()
void	Stop ()
void	Notify (const PVREvent &event)
	CEventStream callback for PVR events.
void	Notify (const PVRChannelNumberInputChangedEvent &event)
	CEventStream callback for channel number input changes.
void	Notify (const PVRPreviewAndPlayerShowInfoChangedEvent &event)
	CEventStream callback for channel preview and player show info changes.
bool	InitCurrentItem (CFileItem *item) override
	Init a new current guiinfo manager item. Gets called whenever the active guiinfo manager item changes.
bool	GetLabel (std::string &value, const CFileItem *item, int contextWindow, const KODI::GUILIB::GUIINFO::CGUIInfo &info, std::string *fallback) const override
	Get a GUIInfoManager label string.
bool	GetFallbackLabel (std::string &value, const CFileItem *item, int contextWindow, const KODI::GUILIB::GUIINFO::CGUIInfo &info, std::string *fallback) override
	Get a GUIInfoManager label fallback string. Will be called if none of the registered provider's GetLabel() implementation has returned success.
bool	GetInt (int &value, const CGUIListItem *item, int contextWindow, const KODI::GUILIB::GUIINFO::CGUIInfo &info) const override
	Get a GUIInfoManager integer value.
bool	GetBool (bool &value, const CGUIListItem *item, int contextWindow, const KODI::GUILIB::GUIINFO::CGUIInfo &info) const override
	Get a GUIInfoManager bool value.
Public Member Functions inherited from KODI::GUILIB::GUIINFO::CGUIInfoProvider
	CGUIInfoProvider ()=default
	~CGUIInfoProvider () override=default
void	UpdateAVInfo (const AudioStreamInfo &audioInfo, const VideoStreamInfo &videoInfo, const SubtitleStreamInfo &subtitleInfo) override
	Set new audio/video stream info data.
Public Member Functions inherited from KODI::GUILIB::GUIINFO::IGUIInfoProvider
virtual	~IGUIInfoProvider ()=default

Additional Inherited Members
Protected Attributes inherited from KODI::GUILIB::GUIINFO::CGUIInfoProvider
VideoStreamInfo	m_videoInfo
AudioStreamInfo	m_audioInfo
SubtitleStreamInfo	m_subtitleInfo

Constructor & Destructor Documentation

CPVRGUIInfo()

CPVRGUIInfo::CPVRGUIInfo

(

)

~CPVRGUIInfo()

PVR::CPVRGUIInfo::~CPVRGUIInfo ( )

overridedefault

Member Function Documentation

GetBool()

bool CPVRGUIInfo::GetBool ( bool & value, const CGUIListItem * item, int contextWindow, const KODI::GUILIB::GUIINFO::CGUIInfo & info ) const

overridevirtual

Get a GUIInfoManager bool value.

Parameters

value	Will be filled with the requested value.
item	The item to get the value for. Can be nullptr.
contextWindow	The context window. Can be 0.
info	The GUI info (label id + additional data).

Returns

True if the value was filled successfully, false otherwise.

Implements KODI::GUILIB::GUIINFO::IGUIInfoProvider.

GetFallbackLabel()

bool CPVRGUIInfo::GetFallbackLabel ( std::string & value, const CFileItem * item, int contextWindow, const KODI::GUILIB::GUIINFO::CGUIInfo & info, std::string * fallback )

overridevirtual

Get a GUIInfoManager label fallback string. Will be called if none of the registered provider's GetLabel() implementation has returned success.

Parameters

value	Will be filled with the requested value.
item	The item to get the value for. Can be nullptr.
contextWindow	The context window. Can be 0.
info	The GUI info (label id + additional data).
fallback	A fallback value. Can be nullptr.

Returns

True if the value was filled successfully, false otherwise.

Reimplemented from KODI::GUILIB::GUIINFO::CGUIInfoProvider.

GetInt()

bool CPVRGUIInfo::GetInt ( int & value, const CGUIListItem * item, int contextWindow, const KODI::GUILIB::GUIINFO::CGUIInfo & info ) const

overridevirtual

Get a GUIInfoManager integer value.

Parameters

value	Will be filled with the requested value.
item	The item to get the value for. Can be nullptr.
contextWindow	The context window. Can be 0.
info	The GUI info (label id + additional data).

Returns

True if the value was filled successfully, false otherwise.

Implements KODI::GUILIB::GUIINFO::IGUIInfoProvider.

GetLabel()

bool CPVRGUIInfo::GetLabel ( std::string & value, const CFileItem * item, int contextWindow, const KODI::GUILIB::GUIINFO::CGUIInfo & info, std::string * fallback ) const

overridevirtual

Get a GUIInfoManager label string.

Parameters

value	Will be filled with the requested value.
item	The item to get the value for. Can be nullptr.
contextWindow	The context window. Can be 0.
info	The GUI info (label id + additional data).
fallback	A fallback value. Can be nullptr.

Returns

True if the value was filled successfully, false otherwise.

Implements KODI::GUILIB::GUIINFO::IGUIInfoProvider.

InitCurrentItem()

bool CPVRGUIInfo::InitCurrentItem ( CFileItem * item )

overridevirtual

Init a new current guiinfo manager item. Gets called whenever the active guiinfo manager item changes.

Parameters

item	The new item.

Returns

True if the item was inited by the provider, false otherwise.

Implements KODI::GUILIB::GUIINFO::IGUIInfoProvider.

Notify() [1/3]

void CPVRGUIInfo::Notify

(

const PVRChannelNumberInputChangedEvent &

event

)

CEventStream callback for channel number input changes.

Parameters

event

The event.

Notify() [2/3]

void CPVRGUIInfo::Notify

(

const PVREvent &

event

)

CEventStream callback for PVR events.

Parameters

event

The event.

Notify() [3/3]

void CPVRGUIInfo::Notify

(

const PVRPreviewAndPlayerShowInfoChangedEvent &

event

)

CEventStream callback for channel preview and player show info changes.

Parameters

event

The event.

Start()

void CPVRGUIInfo::Start

(

)

Stop()

void CPVRGUIInfo::Stop

(

)

---

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

• PVRGUIInfo.h
• PVRGUIInfo.cpp