KODI::GAME::IControllerList Class Reference

A list populated by installed controllers for the controller configuration window. More...

#include <IConfigurationWindow.h>

Inheritance diagram for KODI::GAME::IControllerList:

Public Member Functions
virtual	~IControllerList ()=default
virtual bool	Initialize (void)=0
	Initialize the resource.
virtual void	Deinitialize (void)=0
	Deinitialize the resource.
virtual bool	Refresh (const std::string &controllerId)=0
	Refresh the contents of the list.
virtual void	OnFocus (unsigned int controllerIndex)=0
virtual void	OnSelect (unsigned int controllerIndex)=0
	The specified controller has been selected.
virtual int	GetFocusedController () const =0
	Get the index of the focused controller.
virtual void	ResetController (void)=0
	Reset the focused controller.

Detailed Description

A list populated by installed controllers for the controller configuration window.

The configuration window presents a list of controllers. Also on the screen is a list of features (IFeatureList) belonging to that controller.

The configuration utility reacts to several events:

1) When a controller is focused, the feature list is populated with the controller's features.

2) When a feature is selected, the user is prompted for controller input. This initiates a "wizard" (IConfigurationWizard) that walks the user through the subsequent features.

3) When the wizard's active feature loses focus, the wizard is cancelled and the prompt for input ends.

Constructor & Destructor Documentation

~IControllerList()

virtual KODI::GAME::IControllerList::~IControllerList ( )

virtualdefault

Member Function Documentation

Deinitialize()

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

pure virtual

Deinitialize the resource.

Implemented in KODI::GAME::CGUIControllerList.

GetFocusedController()

virtual int KODI::GAME::IControllerList::GetFocusedController ( ) const

pure virtual

Get the index of the focused controller.

Returns

The index of the focused controller, or -1 if no controller has been focused yet

Implemented in KODI::GAME::CGUIControllerList.

Initialize()

virtual bool KODI::GAME::IControllerList::Initialize ( void )

pure virtual

Initialize the resource.

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

OnFocus()

virtual void KODI::GAME::IControllerList::OnFocus ( unsigned int controllerIndex )

pure virtual

Implemented in KODI::GAME::CGUIControllerList.

OnSelect()

virtual void KODI::GAME::IControllerList::OnSelect ( unsigned int controllerIndex )

pure virtual

The specified controller has been selected.

Parameters

controllerIndex

The index of the controller being selected

Implemented in KODI::GAME::CGUIControllerList.

Refresh()

virtual bool KODI::GAME::IControllerList::Refresh ( const std::string & controllerId )

pure virtual

Refresh the contents of the list.

Parameters

controllerId

The controller to focus, or empty to leave focus unchanged

Returns

True if the list was changed

Implemented in KODI::GAME::CGUIControllerList.

ResetController()

virtual void KODI::GAME::IControllerList::ResetController ( void )

pure virtual

Reset the focused controller.

Implemented in KODI::GAME::CGUIControllerList.

---

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

• IConfigurationWindow.h