kodi
Classes | Public Member Functions | List of all members
CGUIAction Class Reference

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

#include <GUIAction.h>

Classes

class  CExecutableAction
 Class which defines an executable action. More...
 

Public Member Functions

 CGUIAction (int controlID)
 
bool ExecuteActions () const
 Execute actions without specifying any target control or parent control. More...
 
bool ExecuteActions (int controlID, int parentID, const std::shared_ptr< CGUIListItem > &item=nullptr) const
 Execute actions (no navigation paths); if action is paired with condition - evaluate condition first.
 
bool HasConditionalActions () const
 Check if there are any conditional actions.
 
bool HasActionsMeetingCondition () const
 Check if there is any action that meet its condition.
 
bool HasAnyActions () const
 Check if there is any action.
 
size_t GetActionCount () const
 Get the total number of actions.
 
int GetNavigation () const
 Get navigation route that meet its conditions first.
 
void SetNavigation (int id)
 Set navigation route.
 
void EnableSendThreadMessageMode ()
 Configure CGUIAction to send threaded messages.
 
void Append (const CExecutableAction &action)
 Add an executable action to the CGUIAction container.
 
void Reset ()
 Prune any executable actions stored in the CGUIAction.
 

Detailed Description

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

Member Function Documentation

◆ ExecuteActions()

bool CGUIAction::ExecuteActions ( ) const

Execute actions without specifying any target control or parent control.

Action will use the default focused control.


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