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

#include <GUIFeatureList.h>

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

Public Member Functions

 CGUIFeatureList (CGUIWindow *window, GameClientPtr gameClient)
 
 ~CGUIFeatureList () override
 
bool Initialize () override
 Initialize the resource.
 
void Deinitialize () override
 Deinitialize the resource.
 
bool HasButton (JOYSTICK::FEATURE_TYPE type) const override
 Check if the feature type has any buttons in the GUI.
 
void Load (const ControllerPtr &controller) override
 Load the features for the specified controller.
 
void OnFocus (unsigned int buttonIndex) override
 Focus has been set to the specified GUI button.
 
void OnSelect (unsigned int buttonIndex) override
 The specified GUI button has been selected.
 
- Public Member Functions inherited from KODI::GAME::IFeatureList
virtual ~IFeatureList ()=default
 

Constructor & Destructor Documentation

◆ CGUIFeatureList()

CGUIFeatureList::CGUIFeatureList ( CGUIWindow * window,
GameClientPtr gameClient )

◆ ~CGUIFeatureList()

CGUIFeatureList::~CGUIFeatureList ( void )
override

Member Function Documentation

◆ Deinitialize()

void CGUIFeatureList::Deinitialize ( )
overridevirtual

Deinitialize the resource.

Remarks
This must be called if Initialize() returned true

Implements KODI::GAME::IFeatureList.

◆ HasButton()

bool CGUIFeatureList::HasButton ( JOYSTICK::FEATURE_TYPE type) const
overridevirtual

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

Implements KODI::GAME::IFeatureList.

◆ Initialize()

bool CGUIFeatureList::Initialize ( )
overridevirtual

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

Implements KODI::GAME::IFeatureList.

◆ Load()

void CGUIFeatureList::Load ( const ControllerPtr & controller)
overridevirtual

Load the features for the specified controller.

Parameters
controllerThe controller to load

Implements KODI::GAME::IFeatureList.

◆ OnFocus()

void KODI::GAME::CGUIFeatureList::OnFocus ( unsigned int buttonIndex)
inlineoverridevirtual

Focus has been set to the specified GUI button.

Parameters
buttonIndexThe index of the button being focused

Implements KODI::GAME::IFeatureList.

◆ OnSelect()

void CGUIFeatureList::OnSelect ( unsigned int buttonIndex)
overridevirtual

The specified GUI button has been selected.

Parameters
buttonIndexThe index of the button being selected

Implements KODI::GAME::IFeatureList.


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