KODI::GAME::CGUIPortList Class Reference

#include <GUIPortList.h>

Inheritance diagram for KODI::GAME::CGUIPortList:

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

Constructor & Destructor Documentation

CGUIPortList()

CGUIPortList::CGUIPortList

(

CGUIWindow &

window

)

~CGUIPortList()

CGUIPortList::~CGUIPortList ( )

override

Member Function Documentation

Deinitialize()

void CGUIPortList::Deinitialize ( )

overridevirtual

Deinitialize resources.

Implements KODI::GAME::IPortList.

FrameMove()

void CGUIPortList::FrameMove ( )

overridevirtual

Callback when a frame is rendered by the GUI.

Implements KODI::GAME::IPortList.

GetCurrentControl()

int CGUIPortList::GetCurrentControl ( )

overridevirtual

Query the ID of the current control in this list.

Returns

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

Implements KODI::GAME::IPortList.

HasControl()

bool CGUIPortList::HasControl ( int controlId )

overridevirtual

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

Implements KODI::GAME::IPortList.

Initialize()

bool CGUIPortList::Initialize ( GameClientPtr gameClient )

overridevirtual

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

Implements KODI::GAME::IPortList.

OnSelect()

bool CGUIPortList::OnSelect ( )

overridevirtual

The port list has been selected.

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

Implements KODI::GAME::IPortList.

OnWindowLoaded()

void CGUIPortList::OnWindowLoaded ( )

overridevirtual

Callback when the GUI window is loaded.

Implements KODI::GAME::IPortList.

OnWindowUnload()

void CGUIPortList::OnWindowUnload ( )

overridevirtual

Callback when the GUI window is unloaded.

Implements KODI::GAME::IPortList.

Refresh()

void CGUIPortList::Refresh ( )

overridevirtual

Refresh the contents of the list.

Implements KODI::GAME::IPortList.

ResetPorts()

void CGUIPortList::ResetPorts ( )

overridevirtual

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

Implements KODI::GAME::IPortList.

SetFocused()

void CGUIPortList::SetFocused ( )

overridevirtual

The port list has been focused in the GUI.

Implements KODI::GAME::IPortList.

---

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

• GUIPortList.h
• GUIPortList.cpp