xbmc/pvr/guilib/PVRGUIActionsEPG.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 class CFileItem;
  14
  15 namespace PVR
  16 {
  17 class CPVRGUIActionsEPG : public IPVRComponent
  18 {
  19 public:
  20   CPVRGUIActionsEPG() = default;
  21   ~CPVRGUIActionsEPG() override = default;
  22
  23   /*!
  24    * @brief Open a dialog with epg information for a given item.
  25    * @param item containing epg data to show. item must be an epg tag, a channel or a timer.
  26    * @return true on success, false otherwise.
  27    */
  28   bool ShowEPGInfo(const CFileItem& item) const;
  29
  30   /*!
  31    * @brief Open a dialog with the epg list for a given item.
  32    * @param item containing channel info. item must be an epg tag, a channel or a timer.
  33    * @return true on success, false otherwise.
  34    */
  35   bool ShowChannelEPG(const CFileItem& item) const;
  36
  37   /*!
  38    * @brief Open a window containing a list of epg tags 'similar' to a given item.
  39    * @param item containing epg data for matching. item must be an epg tag, a channel or a
  40    * recording.
  41    * @return true on success, false otherwise.
  42    */
  43   bool FindSimilar(const CFileItem& item) const;
  44
  45   /*!
  46    * @brief Execute a saved search. Displays result in search window if it is open.
  47    * @param item The item containing a search filter.
  48    * @return True on success, false otherwise.
  49    */
  50   bool ExecuteSavedSearch(const CFileItem& item);
  51
  52   /*!
  53    * @brief Edit a saved search. Opens the search dialog.
  54    * @param item The item containing a search filter.
  55    * @return True on success, false otherwise.
  56    */
  57   bool EditSavedSearch(const CFileItem& item);
  58
  59   /*!
  60    * @brief Rename a saved search. Opens a title input dialog.
  61    * @param item The item containing a search filter.
  62    * @return True on success, false otherwise.
  63    */
  64   bool RenameSavedSearch(const CFileItem& item);
  65
  66   /*!
  67    * @brief Delete a saved search. Opens confirmation dialog before deleting.
  68    * @param item The item containing a search filter.
  69    * @return True on success, false otherwise.
  70    */
  71   bool DeleteSavedSearch(const CFileItem& item);
  72
  73 private:
  74   CPVRGUIActionsEPG(const CPVRGUIActionsEPG&) = delete;
  75   CPVRGUIActionsEPG const& operator=(CPVRGUIActionsEPG const&) = delete;
  76 };
  77
  78 namespace GUI
  79 {
  80 // pretty scope and name
  81 using EPG = CPVRGUIActionsEPG;
  82 } // namespace GUI
  83
  84 } // namespace PVR