xbmc
Public Member Functions | List of all members
PVR::CPVRGUIInfo Class Reference
Inheritance diagram for PVR::CPVRGUIInfo:
Inheritance graph
[legend]
Collaboration diagram for PVR::CPVRGUIInfo:
Collaboration graph
[legend]

Public Member Functions

void Start ()
 
void Stop ()
 
void Notify (const PVREvent &event)
 CEventStream callback for PVR events. More...
 
void Notify (const PVRChannelNumberInputChangedEvent &event)
 CEventStream callback for channel number input changes. More...
 
void Notify (const PVRPreviewAndPlayerShowInfoChangedEvent &event)
 CEventStream callback for channel preview and player show info changes. More...
 
bool InitCurrentItem (CFileItem *item) override
 Init a new current guiinfo manager item. Gets called whenever the active guiinfo manager item changes. More...
 
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. More...
 
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. More...
 
bool GetInt (int &value, const CGUIListItem *item, int contextWindow, const KODI::GUILIB::GUIINFO::CGUIInfo &info) const override
 Get a GUIInfoManager integer value. More...
 
bool GetBool (bool &value, const CGUIListItem *item, int contextWindow, const KODI::GUILIB::GUIINFO::CGUIInfo &info) const override
 Get a GUIInfoManager bool value. More...
 
- Public Member Functions inherited from KODI::GUILIB::GUIINFO::CGUIInfoProvider
void UpdateAVInfo (const AudioStreamInfo &audioInfo, const VideoStreamInfo &videoInfo, const SubtitleStreamInfo &subtitleInfo) override
 Set new audio/video stream info data. More...
 

Additional Inherited Members

- Protected Attributes inherited from KODI::GUILIB::GUIINFO::CGUIInfoProvider
VideoStreamInfo m_videoInfo
 
AudioStreamInfo m_audioInfo
 
SubtitleStreamInfo m_subtitleInfo
 

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
valueWill be filled with the requested value.
itemThe item to get the value for. Can be nullptr.
contextWindowThe context window. Can be 0.
infoThe 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
valueWill be filled with the requested value.
itemThe item to get the value for. Can be nullptr.
contextWindowThe context window. Can be 0.
infoThe GUI info (label id + additional data).
fallbackA 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
valueWill be filled with the requested value.
itemThe item to get the value for. Can be nullptr.
contextWindowThe context window. Can be 0.
infoThe 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
valueWill be filled with the requested value.
itemThe item to get the value for. Can be nullptr.
contextWindowThe context window. Can be 0.
infoThe GUI info (label id + additional data).
fallbackA 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
itemThe 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 PVREvent &  event)

CEventStream callback for PVR events.

Parameters
eventThe event.

◆ Notify() [2/3]

void CPVRGUIInfo::Notify ( const PVRChannelNumberInputChangedEvent event)

CEventStream callback for channel number input changes.

Parameters
eventThe event.

◆ Notify() [3/3]

void CPVRGUIInfo::Notify ( const PVRPreviewAndPlayerShowInfoChangedEvent event)

CEventStream callback for channel preview and player show info changes.

Parameters
eventThe event.

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