KODI::GAME::CGUIAgentControllerList Class Reference

#include <GUIAgentControllerList.h>

Inheritance diagram for KODI::GAME::CGUIAgentControllerList:

Public Member Functions
	CGUIAgentControllerList (CGUIWindow &window)
	~CGUIAgentControllerList () override
void	OnWindowLoaded () override
	Callback when the GUI window is loaded.
void	OnWindowUnload () override
	Callback when the GUI window is unloaded.
bool	Initialize (GameClientPtr gameClient) override
	Initialize resources.
void	Deinitialize () override
	Deinitialize resources.
bool	HasControl (int controlId) const override
	Query if a control with the given ID belongs to this list.
int	GetCurrentControl () const override
	Query the ID of the current control in this list.
void	FrameMove () override
	Called once per frame.
void	Refresh () override
	Refresh the contents of the list.
void	SetFocused () override
	The agent list has been focused in the GUI.
void	OnSelect () override
	The agent list has been selected in the GUI.
void	Notify (const Observable &obs, const ObservableMessage msg) override
	Process a message from an observable.
Public Member Functions inherited from KODI::GAME::IAgentControllerList
virtual	~IAgentControllerList ()=default
Public Member Functions inherited from Observer
	Observer ()=default
virtual	~Observer ()=default

Constructor & Destructor Documentation

CGUIAgentControllerList()

CGUIAgentControllerList::CGUIAgentControllerList

(

CGUIWindow &

window

)

~CGUIAgentControllerList()

CGUIAgentControllerList::~CGUIAgentControllerList ( )

override

Member Function Documentation

Deinitialize()

void CGUIAgentControllerList::Deinitialize ( )

overridevirtual

Deinitialize resources.

Implements KODI::GAME::IAgentControllerList.

FrameMove()

void CGUIAgentControllerList::FrameMove ( )

overridevirtual

Called once per frame.

This allows the list to update its currently focused item.

Implements KODI::GAME::IAgentControllerList.

GetCurrentControl()

int CGUIAgentControllerList::GetCurrentControl ( ) const

overridevirtual

Query the ID of the current control in this list.

Implements KODI::GAME::IAgentControllerList.

HasControl()

bool CGUIAgentControllerList::HasControl ( int controlId ) const

overridevirtual

Query if a control with the given ID belongs to this list.

Implements KODI::GAME::IAgentControllerList.

Initialize()

bool CGUIAgentControllerList::Initialize ( GameClientPtr gameClient )

overridevirtual

Initialize resources.

Parameters

gameClient

The active game client, an empty pointer if no game client is active

Returns

True if the resource is initialized and can be used, false if the resource failed to initialize and must not be used

Implements KODI::GAME::IAgentControllerList.

Notify()

void CGUIAgentControllerList::Notify ( const Observable & obs, const ObservableMessage msg )

overridevirtual

Process a message from an observable.

Parameters

obs	The observable that sends the message.
msg	The message.

Implements Observer.

OnSelect()

void CGUIAgentControllerList::OnSelect ( )

overridevirtual

The agent list has been selected in the GUI.

Implements KODI::GAME::IAgentControllerList.

OnWindowLoaded()

void CGUIAgentControllerList::OnWindowLoaded ( )

overridevirtual

Callback when the GUI window is loaded.

Implements KODI::GAME::IAgentControllerList.

OnWindowUnload()

void CGUIAgentControllerList::OnWindowUnload ( )

overridevirtual

Callback when the GUI window is unloaded.

Implements KODI::GAME::IAgentControllerList.

Refresh()

void CGUIAgentControllerList::Refresh ( )

overridevirtual

Refresh the contents of the list.

Implements KODI::GAME::IAgentControllerList.

SetFocused()

void CGUIAgentControllerList::SetFocused ( )

overridevirtual

The agent list has been focused in the GUI.

Implements KODI::GAME::IAgentControllerList.

---

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

• GUIAgentControllerList.h
• GUIAgentControllerList.cpp