KODI::GUILIB::GUIINFO::CGUIControlsGUIInfo Class Reference

Inheritance diagram for KODI::GUILIB::GUIINFO::CGUIControlsGUIInfo:

Collaboration diagram for KODI::GUILIB::GUIINFO::CGUIControlsGUIInfo:

Public Member Functions
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 CGUIInfo &info, std::string *fallback) const override
	Get a GUIInfoManager label string. More...
bool	GetInt (int &value, const CGUIListItem *item, int contextWindow, const CGUIInfo &info) const override
	Get a GUIInfoManager integer value. More...
bool	GetBool (bool &value, const CGUIListItem *item, int contextWindow, const CGUIInfo &info) const override
	Get a GUIInfoManager bool value. More...
void	SetNextWindow (int windowID)
void	SetPreviousWindow (int windowID)
void	SetContainerMoving (int id, bool next, bool scrolling)
	containers call this to specify that the focus is changing More...
void	ResetContainerMovingCache ()
Public Member Functions inherited from KODI::GUILIB::GUIINFO::CGUIInfoProvider
bool	GetFallbackLabel (std::string &value, const CFileItem *item, int contextWindow, const 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...
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 CGUIControlsGUIInfo::GetBool ( bool &  value, const CGUIListItem *  item, int  contextWindow, const 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.

GetInt()

bool CGUIControlsGUIInfo::GetInt ( int &  value, const CGUIListItem *  item, int  contextWindow, const 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 CGUIControlsGUIInfo::GetLabel ( std::string &  value, const CFileItem *  item, int  contextWindow, const 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 CGUIControlsGUIInfo::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.

SetContainerMoving()

void CGUIControlsGUIInfo::SetContainerMoving	(	int	id,
		bool	next,
		bool	scrolling
	)

containers call this to specify that the focus is changing

Parameters

id	control id
next	true if we're moving to the next item, false if previous
scrolling	true if the container is scrolling, false if the movement requires no scroll

---

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

• xbmc/guilib/guiinfo/GUIControlsGUIInfo.h
• xbmc/guilib/guiinfo/GUIControlsGUIInfo.cpp