xbmc/guilib/GUIAction.h

   1 /*
   2  *  Copyright (C) 2005-2018 Team Kodi
   3  *  This file is part of Kodi - https://kodi.tv
   4  *
   5  *  SPDX-License-Identifier: GPL-2.0-or-later
   6  *  See LICENSES/README.md for more information.
   7  */
   8
   9 #pragma once
  10
  11 #include <memory>
  12 #include <string>
  13 #include <vector>
  14
  15 class CGUIControl;
  16 class CGUIListItem;
  17
  18 /**
  19  * Class containing vector of condition->(action/navigation route) and handling its execution.
  20  */
  21 class CGUIAction
  22 {
  23 public:
  24   /**
  25    * Class which defines an executable action
  26    */
  27   class CExecutableAction
  28   {
  29   public:
  30     /**
  31     * Executable action constructor (without conditional execution)
  32     * @param action - The action to be executed
  33     */
  34     explicit CExecutableAction(const std::string& action);
  35     /**
  36     * Executable action constructor (providing the condition and the action)
  37     * @param condition - The condition that dictates the action execution
  38     * @param action - The actual action
  39     */
  40     CExecutableAction(const std::string& condition, const std::string& action);
  41
  42     /**
  43     * Get the condition of this executable action (may be empty)
  44     * @return condition - The condition that dictates the action execution (or an empty string)
  45     */
  46     std::string GetCondition() const;
  47
  48     /**
  49     * Checks if the executable action has any condition
  50     * @return true if the executable action has any condition, else false
  51     */
  52     bool HasCondition() const;
  53
  54     /**
  55     * Get the action string of this executable action
  56     * @return action - The action string
  57     */
  58     std::string GetAction() const;
  59
  60     /**
  61     * Sets/Replaces the action string of this executable action
  62     * @param action - The action string
  63     */
  64     void SetAction(const std::string& action);
  65
  66     bool operator==(const CExecutableAction& right) const
  67     {
  68       return m_condition == right.m_condition && m_action == right.m_action;
  69     }
  70
  71   private:
  72     /**
  73     * Executable action default constructor
  74     */
  75     CExecutableAction() = delete;
  76     /* The condition that dictates the action execution */
  77     std::string m_condition;
  78     /* The actual action */
  79     std::string m_action;
  80   };
  81
  82   CGUIAction() = default;
  83   explicit CGUIAction(int controlID);
  84   /**
  85    * Execute actions without specifying any target control or parent control. Action will use the default focused control.
  86    */
  87   bool ExecuteActions() const;
  88   /**
  89    * Execute actions (no navigation paths); if action is paired with condition - evaluate condition first
  90    */
  91   bool ExecuteActions(int controlID,
  92                       int parentID,
  93                       const std::shared_ptr<CGUIListItem>& item = nullptr) const;
  94   /**
  95    * Check if there are any conditional actions
  96   */
  97   bool HasConditionalActions() const;
  98   /**
  99    * Check if there is any action that meet its condition
 100    */
 101   bool HasActionsMeetingCondition() const;
 102   /**
 103    * Check if there is any action
 104    */
 105   bool HasAnyActions() const;
 106   /**
 107    * Get the total number of actions
 108   */
 109   size_t GetActionCount() const;
 110   /**
 111    * Get navigation route that meet its conditions first
 112    */
 113   int GetNavigation() const;
 114   /**
 115    * Set navigation route
 116    */
 117   void SetNavigation(int id);
 118   /**
 119    * Configure CGUIAction to send threaded messages
 120    */
 121   void EnableSendThreadMessageMode();
 122   /**
 123    * Add an executable action to the CGUIAction container
 124    */
 125   void Append(const CExecutableAction& action);
 126   /**
 127    * Prune any executable actions stored in the CGUIAction
 128    */
 129   void Reset();
 130
 131   bool operator==(const CGUIAction& rhs) const
 132   {
 133     return m_actions == rhs.m_actions && m_sendThreadMessages == rhs.m_sendThreadMessages;
 134   }
 135
 136 private:
 137   std::vector<CExecutableAction> m_actions;
 138   bool m_sendThreadMessages = false;
 139 };