xbmc
Public Member Functions | List of all members
KODI::GUILIB::GUIINFO::CGUIInfoProviders Class Reference

Public Member Functions

void RegisterProvider (IGUIInfoProvider *provider, bool bAppend=true)
 Register a guiinfo provider. More...
 
void UnregisterProvider (IGUIInfoProvider *provider)
 Unregister a guiinfo provider. More...
 
bool InitCurrentItem (CFileItem *item)
 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 CGUIInfo &info, std::string *fallback) const
 Get a GUIInfoManager label string from one of the registered providers. More...
 
bool GetInt (int &value, const CGUIListItem *item, int contextWindow, const CGUIInfo &info) const
 Get a GUIInfoManager integer value from one of the registered providers. More...
 
bool GetBool (bool &value, const CGUIListItem *item, int contextWindow, const CGUIInfo &info) const
 Get a GUIInfoManager bool value from one of the registered providers. More...
 
void UpdateAVInfo (const AudioStreamInfo &audioInfo, const VideoStreamInfo &videoInfo, const SubtitleStreamInfo &subtitleInfo)
 Set new audio/video/subtitle stream info data at all registered providers. More...
 
CPlayerGUIInfoGetPlayerInfoProvider ()
 Get the player guiinfo provider. More...
 
CSystemGUIInfoGetSystemInfoProvider ()
 Get the system guiinfo provider. More...
 
CPicturesGUIInfoGetPicturesInfoProvider ()
 Get the pictures guiinfo provider. More...
 
CGUIControlsGUIInfoGetGUIControlsInfoProvider ()
 Get the gui controls guiinfo provider. More...
 
CLibraryGUIInfoGetLibraryInfoProvider ()
 Get the library guiinfo provider. More...
 

Member Function Documentation

◆ GetBool()

bool CGUIInfoProviders::GetBool ( bool &  value,
const CGUIListItem item,
int  contextWindow,
const CGUIInfo info 
) const

Get a GUIInfoManager bool value from one of the registered providers.

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 by one of the providers, false otherwise.

◆ GetGUIControlsInfoProvider()

CGUIControlsGUIInfo& KODI::GUILIB::GUIINFO::CGUIInfoProviders::GetGUIControlsInfoProvider ( )
inline

Get the gui controls guiinfo provider.

Returns
The gui controls guiinfo provider.

◆ GetInt()

bool CGUIInfoProviders::GetInt ( int &  value,
const CGUIListItem item,
int  contextWindow,
const CGUIInfo info 
) const

Get a GUIInfoManager integer value from one of the registered providers.

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 by one of the providers, false otherwise.

◆ GetLabel()

bool CGUIInfoProviders::GetLabel ( std::string &  value,
const CFileItem item,
int  contextWindow,
const CGUIInfo info,
std::string *  fallback 
) const

Get a GUIInfoManager label string from one of the registered providers.

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 by one of the providers, false otherwise.

◆ GetLibraryInfoProvider()

CLibraryGUIInfo& KODI::GUILIB::GUIINFO::CGUIInfoProviders::GetLibraryInfoProvider ( )
inline

Get the library guiinfo provider.

Returns
The library guiinfo provider.

◆ GetPicturesInfoProvider()

CPicturesGUIInfo& KODI::GUILIB::GUIINFO::CGUIInfoProviders::GetPicturesInfoProvider ( )
inline

Get the pictures guiinfo provider.

Returns
The pictures guiinfo provider.

◆ GetPlayerInfoProvider()

CPlayerGUIInfo& KODI::GUILIB::GUIINFO::CGUIInfoProviders::GetPlayerInfoProvider ( )
inline

Get the player guiinfo provider.

Returns
The player guiinfo provider.

◆ GetSystemInfoProvider()

CSystemGUIInfo& KODI::GUILIB::GUIINFO::CGUIInfoProviders::GetSystemInfoProvider ( )
inline

Get the system guiinfo provider.

Returns
The system guiinfo provider.

◆ InitCurrentItem()

bool CGUIInfoProviders::InitCurrentItem ( CFileItem item)

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 one of the providers, false otherwise.

◆ RegisterProvider()

void CGUIInfoProviders::RegisterProvider ( IGUIInfoProvider provider,
bool  bAppend = true 
)

Register a guiinfo provider.

Parameters
providerThe provider to register.
bAppendTrue to append to the list of providers, false to insert before the first provider

◆ UnregisterProvider()

void CGUIInfoProviders::UnregisterProvider ( IGUIInfoProvider provider)

Unregister a guiinfo provider.

Parameters
providerThe provider to unregister.

◆ UpdateAVInfo()

void CGUIInfoProviders::UpdateAVInfo ( const AudioStreamInfo audioInfo,
const VideoStreamInfo videoInfo,
const SubtitleStreamInfo subtitleInfo 
)

Set new audio/video/subtitle stream info data at all registered providers.

Parameters
audioInfoNew audio stream info.
videoInfoNew video stream info.
subtitleInfoNew subtitle stream info.

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