Class which defines an executable action.
More...
#include <GUIAction.h>
|
| | CExecutableAction (const std::string &action) |
| | Executable action constructor (without conditional execution) More...
|
| |
| | CExecutableAction (const std::string &condition, const std::string &action) |
| | Executable action constructor (providing the condition and the action) More...
|
| |
| std::string | GetCondition () const |
| | Get the condition of this executable action (may be empty) More...
|
| |
| bool | HasCondition () const |
| | Checks if the executable action has any condition. More...
|
| |
| std::string | GetAction () const |
| | Get the action string of this executable action. More...
|
| |
| void | SetAction (const std::string &action) |
| | Sets/Replaces the action string of this executable action. More...
|
| |
Class which defines an executable action.
◆ 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 |
◆ 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
◆ 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:
