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

Public Member Functions

 CGUIAgentList (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) const override
 Query if a control with the given ID belongs to this list.
 
int GetCurrentControl () const override
 Query the ID of the current control in this list.
 
void FrameMove () override
 Called once per frame. More...
 
void Refresh () override
 Refresh the contents of the list.
 
void SetFocused () override
 The agent list has been focused in the GUI.
 
void OnSelect () override
 The agent list has been selected in the GUI.
 
void Notify (const Observable &obs, const ObservableMessage msg) override
 Process a message from an observable. More...
 

Member Function Documentation

◆ FrameMove()

void CGUIAgentList::FrameMove ( )
overridevirtual

Called once per frame.

This allows the list to update its currently focused item.

Implements KODI::GAME::IAgentList.

◆ Initialize()

bool CGUIAgentList::Initialize ( GameClientPtr  gameClient)
overridevirtual

Initialize resources.

Parameters
gameClientThe active game client, an empty pointer if no game client is active
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::IAgentList.

◆ Notify()

void CGUIAgentList::Notify ( const Observable obs,
const ObservableMessage  msg 
)
overridevirtual

Process a message from an observable.

Parameters
obsThe observable that sends the message.
msgThe message.

Implements Observer.


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