Kodi Documentation 18.0
Kodi is an open source media player and entertainment hub.
Classes | Public Member Functions | Friends | List of all members
CGUIAction Class Reference

#include <GUIAction.h>

Public Member Functions

 CGUIAction ()=default
 
 CGUIAction (int controlID)
 
bool ExecuteActions (int controlID, int parentID, const CGUIListItemPtr &item=NULL) const
 
bool HasActionsMeetingCondition () const
 
bool HasAnyActions () const
 
int GetNavigation () const
 
void SetNavigation (int id)
 

Friends

class CGUIControlFactory
 

Detailed Description

Class containing vector of condition->(action/navigation route) pairs and handling its execution.

Constructor & Destructor Documentation

◆ CGUIAction() [1/2]

CGUIAction::CGUIAction ( )
default

◆ CGUIAction() [2/2]

CGUIAction::CGUIAction ( int  controlID)
explicit

Member Function Documentation

◆ ExecuteActions()

bool CGUIAction::ExecuteActions ( int  controlID,
int  parentID,
const CGUIListItemPtr &  item = NULL 
) const

Execute actions (no navigation paths), if action is paired with condition - evaluate condition first

◆ GetNavigation()

int CGUIAction::GetNavigation ( ) const

Get navigation route that meet its conditions first

◆ HasActionsMeetingCondition()

bool CGUIAction::HasActionsMeetingCondition ( ) const

Check if there is any action that meet its condition

◆ HasAnyActions()

bool CGUIAction::HasAnyActions ( ) const
inline

Check if there is any action

◆ SetNavigation()

void CGUIAction::SetNavigation ( int  id)

Set navigation route

Friends And Related Function Documentation

◆ CGUIControlFactory

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