GUIAction.h

/*
 *  Copyright (C) 2005-2018 Team Kodi
 *  This file is part of Kodi - https://kodi.tv
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 *  See LICENSES/README.md for more information.
 */

#pragma once

#include <memory>
#include <string>
#include <vector>

class CGUIControl;
class CGUIListItem; typedef std::shared_ptr<CGUIListItem> CGUIListItemPtr;

class CGUIAction
{
public:
  class CExecutableAction
  {
  public:
    explicit 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);

  private:
    CExecutableAction() = delete;
    /* The condition that dictates the action execution */
    std::string m_condition;
    /* The actual action */
    std::string m_action;
  };

  CGUIAction() = default;
  explicit CGUIAction(int controlID);
  bool ExecuteActions() const;
  bool ExecuteActions(int controlID, int parentID, const CGUIListItemPtr& item = nullptr) const;
  bool HasActionsMeetingCondition() const;
  bool HasAnyActions() const;
  int GetNavigation() const;
  void SetNavigation(int id);
  void EnableSendThreadMessageMode();
  void Append(const CExecutableAction& action);
  void Reset();

private:
  std::vector<CExecutableAction> m_actions;
  bool m_sendThreadMessages = false;
};