KODI::GAME::IPortList Class Reference

A list populated by controller ports for the port setup window. More...

#include <IPortList.h>

Inheritance diagram for KODI::GAME::IPortList:

Public Member Functions
virtual	~IPortList ()=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)=0
	Query if a control with the given ID belongs to this list.
virtual int	GetCurrentControl ()=0
	Query the ID of the current control in this list.
virtual void	Refresh ()=0
	Refresh the contents of the list.
virtual void	FrameMove ()=0
	Callback when a frame is rendered by the GUI.
virtual void	SetFocused ()=0
	The port list has been focused in the GUI.
virtual bool	OnSelect ()=0
	The port list has been selected.
virtual void	ResetPorts ()=0
	Reset the ports to their game add-on's default configuration.

Detailed Description

A list populated by controller ports for the port setup window.

The port setup window presents a list of ports and their attached controllers.

The label2 of each port is the currently-connected controller. The user selects from all controllers that the port accepts (as given by the game-addon's topology.xml file).

The controller topology is stored as a generic tree. Here we apply game logic to simplify controller selection.

Constructor & Destructor Documentation

~IPortList()

virtual KODI::GAME::IPortList::~IPortList ( )

virtualdefault

Member Function Documentation

Deinitialize()

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

pure virtual

Deinitialize resources.

Implemented in KODI::GAME::CGUIPortList.

FrameMove()

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

pure virtual

Callback when a frame is rendered by the GUI.

Implemented in KODI::GAME::CGUIPortList.

GetCurrentControl()

virtual int KODI::GAME::IPortList::GetCurrentControl ( )

pure virtual

Query the ID of the current control in this list.

Returns

The control ID, or -1 if no control is currently active

Implemented in KODI::GAME::CGUIPortList.

HasControl()

virtual bool KODI::GAME::IPortList::HasControl ( int controlId )

pure virtual

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

Implemented in KODI::GAME::CGUIPortList.

Initialize()

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

pure virtual

Initialize resources.

Parameters

gameClient

The game client providing the ports

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::CGUIPortList.

OnSelect()

virtual bool KODI::GAME::IPortList::OnSelect ( )

pure virtual

The port list has been selected.

True if a control was active, false of all controls were inactive

Implemented in KODI::GAME::CGUIPortList.

OnWindowLoaded()

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

pure virtual

Callback when the GUI window is loaded.

Implemented in KODI::GAME::CGUIPortList.

OnWindowUnload()

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

pure virtual

Callback when the GUI window is unloaded.

Implemented in KODI::GAME::CGUIPortList.

Refresh()

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

pure virtual

Refresh the contents of the list.

Implemented in KODI::GAME::CGUIPortList.

ResetPorts()

virtual void KODI::GAME::IPortList::ResetPorts ( )

pure virtual

Reset the ports to their game add-on's default configuration.

Implemented in KODI::GAME::CGUIPortList.

SetFocused()

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

pure virtual

The port list has been focused in the GUI.

Implemented in KODI::GAME::CGUIPortList.

---

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

• IPortList.h