code.vuplus.com Git - vuplus_xbmc/blob - xbmc/guilib/GUIAction.h

   1 #pragma once
   2 /*
   3  *      Copyright (C) 2005-2013 Team XBMC
   4  *      http://xbmc.org
   5  *
   6  *  This Program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 2, or (at your option)
   9  *  any later version.
  10  *
  11  *  This Program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with XBMC; see the file COPYING.  If not, see
  18  *  <http://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 #include <vector>
  23 #include "utils/StdString.h"
  24
  25 class CGUIControl;
  26
  27 /**
  28  * Class containing vector of condition->(action/navigation route) pairs and handling its execution.
  29  */
  30 class CGUIAction
  31 {
  32 public:
  33   CGUIAction();
  34   CGUIAction(int controlID);
  35
  36   /**
  37    * Execute actions (no navigation paths), if action is paired with condition - evaluate condition first
  38    */
  39   bool ExecuteActions(int controlID, int parentID) const;
  40   /**
  41    * Check if there is any action that meet its condition
  42    */
  43   bool HasActionsMeetingCondition() const;
  44   /**
  45    * Check if there is any action
  46    */
  47   bool HasAnyActions() const { return m_actions.size() > 0; };
  48   /**
  49    * Get navigation route that meet its conditions first
  50    */
  51   int GetNavigation() const;
  52   /**
  53    * Set navigation route
  54    */
  55   void SetNavigation(int id);
  56 private:
  57   struct cond_action_pair
  58   {
  59     CStdString condition;
  60     CStdString action;
  61   };
  62
  63   std::vector<cond_action_pair> m_actions;
  64   bool m_sendThreadMessages;
  65
  66   typedef std::vector<cond_action_pair>::const_iterator ciActions;
  67   typedef std::vector<cond_action_pair>::iterator iActions;
  68   friend class CGUIControlFactory; // no need for setters / adders
  69 };