xbmc
Public Member Functions | List of all members
KODI::GAME::CGUIPortList Class Reference
Inheritance diagram for KODI::GAME::CGUIPortList:
Inheritance graph
[legend]
Collaboration diagram for KODI::GAME::CGUIPortList:
Collaboration graph
[legend]

Public Member Functions

 CGUIPortList (CGUIWindow &window)
 
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. More...
 
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. More...
 
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. More...
 
void ResetPorts () override
 Reset the ports to their game add-on's default configuration.
 

Member Function Documentation

◆ 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.

◆ Initialize()

bool CGUIPortList::Initialize ( GameClientPtr  gameClient)
overridevirtual

Initialize resources.

Parameters
gameClientThe 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.


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