xbmc/guilib/listproviders/MultiProvider.h

   1 /*
   2  *  Copyright (C) 2013-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 "IListProvider.h"
  12 #include "threads/CriticalSection.h"
  13
  14 #include <map>
  15 #include <vector>
  16
  17 typedef std::unique_ptr<IListProvider> IListProviderPtr;
  18
  19 class TiXmlNode;
  20
  21 /*!
  22  \ingroup listproviders
  23  \brief A listprovider that handles multiple individual providers.
  24  */
  25 class CMultiProvider : public IListProvider
  26 {
  27 public:
  28   CMultiProvider(const TiXmlNode *first, int parentID);
  29   explicit CMultiProvider(const CMultiProvider& other);
  30
  31   // Implementation of IListProvider
  32   std::unique_ptr<IListProvider> Clone() override;
  33   bool Update(bool forceRefresh) override;
  34   void Fetch(std::vector<std::shared_ptr<CGUIListItem>>& items) override;
  35   bool IsUpdating() const override;
  36   void Reset() override;
  37   bool OnClick(const std::shared_ptr<CGUIListItem>& item) override;
  38   bool OnInfo(const std::shared_ptr<CGUIListItem>& item) override;
  39   bool OnContextMenu(const std::shared_ptr<CGUIListItem>& item) override;
  40
  41 protected:
  42   typedef size_t item_key_type;
  43   static item_key_type GetItemKey(std::shared_ptr<CGUIListItem> const& item);
  44   std::vector<IListProviderPtr> m_providers;
  45   std::map<item_key_type, IListProvider*> m_itemMap;
  46   CCriticalSection m_section; // protects m_itemMap
  47 };