IListProvider.h

/*
 *  Copyright (C) 2013-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 <vector>

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

class IListProvider
{
public:
  explicit IListProvider(int parentID) : m_parentID(parentID) {}
  explicit IListProvider(const IListProvider& other) = default;
  virtual ~IListProvider() = default;

  static std::unique_ptr<IListProvider> Create(const TiXmlNode* parent, int parentID);

  static std::unique_ptr<IListProvider> CreateSingle(const TiXmlNode* content, int parentID);

  virtual std::unique_ptr<IListProvider> Clone() = 0;

  virtual bool Update(bool forceRefresh)=0;

  virtual void Fetch(std::vector<CGUIListItemPtr> &items)=0;

  virtual bool IsUpdating() const { return false; }

  virtual void Reset() {}

  virtual void FreeResources(bool immediately) {}

  virtual bool OnClick(const CGUIListItemPtr &item)=0;

  virtual bool OnPlay(const CGUIListItemPtr& item) { return false; }

  virtual bool OnInfo(const CGUIListItemPtr &item)=0;

  virtual bool OnContextMenu(const CGUIListItemPtr &item)=0;

  virtual void SetDefaultItem(int item, bool always) {}

  virtual int GetDefaultItem() const { return -1; }

  virtual bool AlwaysFocusDefaultItem() const { return false; }
protected:
  int m_parentID;
};