Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
KODI::GAME::IFeatureList Class Referenceabstract

A list populated by the controller's features. More...

#include <IConfigurationWindow.h>

Inheritance diagram for KODI::GAME::IFeatureList:
KODI::GAME::CGUIFeatureList

Public Member Functions

virtual ~IFeatureList ()=default
 
virtual bool Initialize (void)=0
 Initialize the resource.
 
virtual void Deinitialize (void)=0
 Deinitialize the resource.
 
virtual bool HasButton (JOYSTICK::FEATURE_TYPE type) const =0
 Check if the feature type has any buttons in the GUI.
 
virtual void Load (const ControllerPtr &controller)=0
 Load the features for the specified controller.
 
virtual void OnFocus (unsigned int buttonIndex)=0
 Focus has been set to the specified GUI button.
 
virtual void OnSelect (unsigned int buttonIndex)=0
 The specified GUI button has been selected.
 

Detailed Description

A list populated by the controller's features.

The feature list is populated by features (IFeatureButton) belonging to the current controller selected in the controller list (IControllerList).

Constructor & Destructor Documentation

◆ ~IFeatureList()

virtual KODI::GAME::IFeatureList::~IFeatureList ( )
virtualdefault

Member Function Documentation

◆ Deinitialize()

virtual void KODI::GAME::IFeatureList::Deinitialize ( void )
pure virtual

Deinitialize the resource.

Remarks
This must be called if Initialize() returned true

Implemented in KODI::GAME::CGUIFeatureList.

◆ HasButton()

virtual bool KODI::GAME::IFeatureList::HasButton ( JOYSTICK::FEATURE_TYPE type) const
pure virtual

Check if the feature type has any buttons in the GUI.

Parameters
Thetype of the feature being added to the GUI
Returns
True if the type is support, false otherwise

Implemented in KODI::GAME::CGUIFeatureList.

◆ Initialize()

virtual bool KODI::GAME::IFeatureList::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::CGUIFeatureList.

◆ Load()

virtual void KODI::GAME::IFeatureList::Load ( const ControllerPtr & controller)
pure virtual

Load the features for the specified controller.

Parameters
controllerThe controller to load

Implemented in KODI::GAME::CGUIFeatureList.

◆ OnFocus()

virtual void KODI::GAME::IFeatureList::OnFocus ( unsigned int buttonIndex)
pure virtual

Focus has been set to the specified GUI button.

Parameters
buttonIndexThe index of the button being focused

Implemented in KODI::GAME::CGUIFeatureList.

◆ OnSelect()

virtual void KODI::GAME::IFeatureList::OnSelect ( unsigned int buttonIndex)
pure virtual

The specified GUI button has been selected.

Parameters
buttonIndexThe index of the button being selected

Implemented in KODI::GAME::CGUIFeatureList.


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