KODI::GUILIB::GUIINFO::IGUIInfoProvider Class Reference

#include <IGUIInfoProvider.h>

Inheritance diagram for KODI::GUILIB::GUIINFO::IGUIInfoProvider:

Public Member Functions
virtual	~IGUIInfoProvider ()=default
virtual bool	InitCurrentItem (CFileItem *item)=0
	Init a new current guiinfo manager item. Gets called whenever the active guiinfo manager item changes.
virtual bool	GetLabel (std::string &value, const CFileItem *item, int contextWindow, const CGUIInfo &info, std::string *fallback) const =0
	Get a GUIInfoManager label string.
virtual bool	GetFallbackLabel (std::string &value, const CFileItem *item, int contextWindow, const CGUIInfo &info, std::string *fallback)=0
	Get a GUIInfoManager label fallback string. Will be called if none of the registered provider's GetLabel() implementation has returned success.
virtual bool	GetInt (int &value, const CGUIListItem *item, int contextWindow, const CGUIInfo &info) const =0
	Get a GUIInfoManager integer value.
virtual bool	GetBool (bool &value, const CGUIListItem *item, int contextWindow, const CGUIInfo &info) const =0
	Get a GUIInfoManager bool value.
virtual void	UpdateAVInfo (const AudioStreamInfo &audioInfo, const VideoStreamInfo &videoInfo, const SubtitleStreamInfo &subtitleInfo)=0
	Set new audio/video stream info data.

Constructor & Destructor Documentation

~IGUIInfoProvider()

virtual KODI::GUILIB::GUIINFO::IGUIInfoProvider::~IGUIInfoProvider ( )

virtualdefault

Member Function Documentation

GetBool()

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

pure virtual

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.

Implemented in KODI::GUILIB::GUIINFO::CAddonsGUIInfo, KODI::GUILIB::GUIINFO::CGamesGUIInfo, KODI::GUILIB::GUIINFO::CGUIControlsGUIInfo, KODI::GUILIB::GUIINFO::CLibraryGUIInfo, KODI::GUILIB::GUIINFO::CMusicGUIInfo, KODI::GUILIB::GUIINFO::CPicturesGUIInfo, KODI::GUILIB::GUIINFO::CPlayerGUIInfo, KODI::GUILIB::GUIINFO::CSkinGUIInfo, KODI::GUILIB::GUIINFO::CSystemGUIInfo, KODI::GUILIB::GUIINFO::CVideoGUIInfo, KODI::GUILIB::GUIINFO::CVisualisationGUIInfo, KODI::GUILIB::GUIINFO::CWeatherGUIInfo, and PVR::CPVRGUIInfo.

GetFallbackLabel()

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

pure virtual

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.

Implemented in KODI::GUILIB::GUIINFO::CGUIInfoProvider, KODI::GUILIB::GUIINFO::CMusicGUIInfo, KODI::GUILIB::GUIINFO::CVideoGUIInfo, and PVR::CPVRGUIInfo.

GetInt()

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

pure virtual

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.

Implemented in KODI::GUILIB::GUIINFO::CAddonsGUIInfo, KODI::GUILIB::GUIINFO::CGamesGUIInfo, KODI::GUILIB::GUIINFO::CGUIControlsGUIInfo, KODI::GUILIB::GUIINFO::CLibraryGUIInfo, KODI::GUILIB::GUIINFO::CMusicGUIInfo, KODI::GUILIB::GUIINFO::CPicturesGUIInfo, KODI::GUILIB::GUIINFO::CPlayerGUIInfo, KODI::GUILIB::GUIINFO::CSkinGUIInfo, KODI::GUILIB::GUIINFO::CSystemGUIInfo, KODI::GUILIB::GUIINFO::CVideoGUIInfo, KODI::GUILIB::GUIINFO::CVisualisationGUIInfo, KODI::GUILIB::GUIINFO::CWeatherGUIInfo, and PVR::CPVRGUIInfo.

GetLabel()

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

pure virtual

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.

Implemented in KODI::GUILIB::GUIINFO::CAddonsGUIInfo, KODI::GUILIB::GUIINFO::CGamesGUIInfo, KODI::GUILIB::GUIINFO::CGUIControlsGUIInfo, KODI::GUILIB::GUIINFO::CLibraryGUIInfo, KODI::GUILIB::GUIINFO::CMusicGUIInfo, KODI::GUILIB::GUIINFO::CPicturesGUIInfo, KODI::GUILIB::GUIINFO::CPlayerGUIInfo, KODI::GUILIB::GUIINFO::CSkinGUIInfo, KODI::GUILIB::GUIINFO::CSystemGUIInfo, KODI::GUILIB::GUIINFO::CVideoGUIInfo, KODI::GUILIB::GUIINFO::CVisualisationGUIInfo, KODI::GUILIB::GUIINFO::CWeatherGUIInfo, and PVR::CPVRGUIInfo.

InitCurrentItem()

virtual bool KODI::GUILIB::GUIINFO::IGUIInfoProvider::InitCurrentItem ( CFileItem * item )

pure virtual

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.

Implemented in KODI::GUILIB::GUIINFO::CAddonsGUIInfo, KODI::GUILIB::GUIINFO::CGamesGUIInfo, KODI::GUILIB::GUIINFO::CGUIControlsGUIInfo, KODI::GUILIB::GUIINFO::CLibraryGUIInfo, KODI::GUILIB::GUIINFO::CMusicGUIInfo, KODI::GUILIB::GUIINFO::CPicturesGUIInfo, KODI::GUILIB::GUIINFO::CPlayerGUIInfo, KODI::GUILIB::GUIINFO::CSkinGUIInfo, KODI::GUILIB::GUIINFO::CSystemGUIInfo, KODI::GUILIB::GUIINFO::CVideoGUIInfo, KODI::GUILIB::GUIINFO::CVisualisationGUIInfo, KODI::GUILIB::GUIINFO::CWeatherGUIInfo, and PVR::CPVRGUIInfo.

UpdateAVInfo()

virtual void KODI::GUILIB::GUIINFO::IGUIInfoProvider::UpdateAVInfo ( const AudioStreamInfo & audioInfo, const VideoStreamInfo & videoInfo, const SubtitleStreamInfo & subtitleInfo )

pure virtual

Set new audio/video stream info data.

Parameters

audioInfo	New audio stream info.
videoInfo	New video stream info.

Implemented in KODI::GUILIB::GUIINFO::CGUIInfoProvider.

---

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

• IGUIInfoProvider.h