xbmc/pvr/guilib/PVRGUIActionsUtils.h

   1 /*
   2  *  Copyright (C) 2016-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 "pvr/IPVRComponent.h"
  12
  13 #include <memory>
  14
  15 class CFileItem;
  16
  17 namespace PVR
  18 {
  19 class CPVRGUIActionsUtils : public IPVRComponent
  20 {
  21 public:
  22   CPVRGUIActionsUtils() = default;
  23   ~CPVRGUIActionsUtils() override = default;
  24
  25   /*!
  26      * @brief Check whether OnInfo supports the given item.
  27      * @param item The item.
  28      * @return True if supported, false otherwise.
  29      */
  30   bool HasInfoForItem(const CFileItem& item) const;
  31
  32   /*!
  33      * @brief Process info action for the given item.
  34      * @param item The item.
  35      * @return True on success, false otherwise.
  36      */
  37   bool OnInfo(const CFileItem& item);
  38
  39   /*!
  40    * @brief Load item details (create recording info tag etc.).
  41    * @param item The item.
  42    * @return Loaded item on success, nullptr otherwise.
  43    */
  44   std::shared_ptr<CFileItem> LoadItem(const CFileItem& item);
  45
  46 private:
  47   CPVRGUIActionsUtils(const CPVRGUIActionsUtils&) = delete;
  48   CPVRGUIActionsUtils const& operator=(CPVRGUIActionsUtils const&) = delete;
  49 };
  50
  51 namespace GUI
  52 {
  53 // pretty scope and name
  54 using Utils = CPVRGUIActionsUtils;
  55 } // namespace GUI
  56
  57 } // namespace PVR