KODI::GAME::IAgentControllerList Class Reference

A list populated by the controllers of game-playing agents (CGameAgent) More...

#include <IAgentControllerList.h>

Inheritance diagram for KODI::GAME::IAgentControllerList:

Public Member Functions
virtual	~IAgentControllerList ()=default
virtual void	OnWindowLoaded ()=0
	Callback when the GUI window is loaded.
virtual void	OnWindowUnload ()=0
	Callback when the GUI window is unloaded.
virtual bool	Initialize (GameClientPtr gameClient)=0
	Initialize resources.
virtual void	Deinitialize ()=0
	Deinitialize resources.
virtual bool	HasControl (int controlId) const =0
	Query if a control with the given ID belongs to this list.
virtual int	GetCurrentControl () const =0
	Query the ID of the current control in this list.
virtual void	FrameMove ()=0
	Called once per frame.
virtual void	Refresh ()=0
	Refresh the contents of the list.
virtual void	SetFocused ()=0
	The agent list has been focused in the GUI.
virtual void	OnSelect ()=0
	The agent list has been selected in the GUI.

Detailed Description

A list populated by the controllers of game-playing agents (CGameAgent)

This class manages the behavior of the controller list (with control ID 7) in the player dialog (GameAgents window).

The active ports are determined by IActivePortList.

The list is populated by the CGUIGameControllerProvider.

Constructor & Destructor Documentation

~IAgentControllerList()

virtual KODI::GAME::IAgentControllerList::~IAgentControllerList ( )

virtualdefault

Member Function Documentation

Deinitialize()

virtual void KODI::GAME::IAgentControllerList::Deinitialize ( )

pure virtual

Deinitialize resources.

Implemented in KODI::GAME::CGUIAgentControllerList.

FrameMove()

virtual void KODI::GAME::IAgentControllerList::FrameMove ( )

pure virtual

Called once per frame.

This allows the list to update its currently focused item.

Implemented in KODI::GAME::CGUIAgentControllerList.

GetCurrentControl()

virtual int KODI::GAME::IAgentControllerList::GetCurrentControl ( ) const

pure virtual

Query the ID of the current control in this list.

Implemented in KODI::GAME::CGUIAgentControllerList.

HasControl()

virtual bool KODI::GAME::IAgentControllerList::HasControl ( int controlId ) const

pure virtual

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

Implemented in KODI::GAME::CGUIAgentControllerList.

Initialize()

virtual bool KODI::GAME::IAgentControllerList::Initialize ( GameClientPtr gameClient )

pure virtual

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

Implemented in KODI::GAME::CGUIAgentControllerList.

OnSelect()

virtual void KODI::GAME::IAgentControllerList::OnSelect ( )

pure virtual

The agent list has been selected in the GUI.

Implemented in KODI::GAME::CGUIAgentControllerList.

OnWindowLoaded()

virtual void KODI::GAME::IAgentControllerList::OnWindowLoaded ( )

pure virtual

Callback when the GUI window is loaded.

Implemented in KODI::GAME::CGUIAgentControllerList.

OnWindowUnload()

virtual void KODI::GAME::IAgentControllerList::OnWindowUnload ( )

pure virtual

Callback when the GUI window is unloaded.

Implemented in KODI::GAME::CGUIAgentControllerList.

Refresh()

virtual void KODI::GAME::IAgentControllerList::Refresh ( )

pure virtual

Refresh the contents of the list.

Implemented in KODI::GAME::CGUIAgentControllerList.

SetFocused()

virtual void KODI::GAME::IAgentControllerList::SetFocused ( )

pure virtual

The agent list has been focused in the GUI.

Implemented in KODI::GAME::CGUIAgentControllerList.

---

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

• IAgentControllerList.h