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

#include <GUIAction.h>

Public Member Functions

 CExecutableAction (const std::string &action)
 
 CExecutableAction (const std::string &condition, const std::string &action)
 
std::string GetCondition () const
 
bool HasCondition () const
 
std::string GetAction () const
 
void SetAction (const std::string &action)
 
bool operator== (const CExecutableAction &right) const
 

Detailed Description

Class which defines an executable action

Constructor & Destructor Documentation

◆ CExecutableAction() [1/2]

CGUIAction::CExecutableAction::CExecutableAction ( const std::string & action)
explicit

Executable action constructor (without conditional execution)

Parameters
action- The action to be executed

◆ CExecutableAction() [2/2]

CGUIAction::CExecutableAction::CExecutableAction ( const std::string & condition,
const std::string & action )

Executable action constructor (providing the condition and the action)

Parameters
condition- The condition that dictates the action execution
action- The actual action

Member Function Documentation

◆ GetAction()

std::string CGUIAction::CExecutableAction::GetAction ( ) const

Get the action string of this executable action

Returns
action - The action string

◆ GetCondition()

std::string CGUIAction::CExecutableAction::GetCondition ( ) const

Get the condition of this executable action (may be empty)

Returns
condition - The condition that dictates the action execution (or an empty string)

◆ HasCondition()

bool CGUIAction::CExecutableAction::HasCondition ( ) const

Checks if the executable action has any condition

Returns
true if the executable action has any condition, else false

◆ operator==()

bool CGUIAction::CExecutableAction::operator== ( const CExecutableAction & right) const
inline

◆ SetAction()

void CGUIAction::CExecutableAction::SetAction ( const std::string & action)

Sets/Replaces the action string of this executable action

Parameters
action- The action string

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