xbmc/pvr/guilib/PVRGUIActionsRecordings.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 CPVRRecording;
  20
  21 class CPVRGUIActionsRecordings : public IPVRComponent
  22 {
  23 public:
  24   CPVRGUIActionsRecordings() = default;
  25   ~CPVRGUIActionsRecordings() override = default;
  26
  27   /*!
  28    * @brief Open a dialog with information for a given recording.
  29    * @param item containing a recording.
  30    * @return true on success, false otherwise.
  31    */
  32   bool ShowRecordingInfo(const CFileItem& item) const;
  33
  34   /*!
  35    * @brief Open the recording settings dialog to edit a recording.
  36    * @param item containing the recording to edit.
  37    * @return true on success, false otherwise.
  38    */
  39   bool EditRecording(const CFileItem& item) const;
  40
  41   /*!
  42    * @brief Check if any recording settings can be edited.
  43    * @param item containing the recording to edit.
  44    * @return true on success, false otherwise.
  45    */
  46   bool CanEditRecording(const CFileItem& item) const;
  47
  48   /*!
  49    * @brief Delete a recording, always showing a confirmation dialog.
  50    * @param item containing a recording to delete.
  51    * @return true, if the recording was deleted successfully, false otherwise.
  52    */
  53   bool DeleteRecording(const CFileItem& item) const;
  54
  55   /*!
  56    * @brief Delete all watched recordings contained in the given folder, always showing a
  57    * confirmation dialog.
  58    * @param item containing a recording folder containing the items to delete.
  59    * @return true, if the recordings were deleted successfully, false otherwise.
  60    */
  61   bool DeleteWatchedRecordings(const CFileItem& item) const;
  62
  63   /*!
  64    * @brief Delete all recordings from trash, always showing a confirmation dialog.
  65    * @return true, if the recordings were permanently deleted successfully, false otherwise.
  66    */
  67   bool DeleteAllRecordingsFromTrash() const;
  68
  69   /*!
  70    * @brief Undelete a recording.
  71    * @param item containing a recording to undelete.
  72    * @return true, if the recording was undeleted successfully, false otherwise.
  73    */
  74   bool UndeleteRecording(const CFileItem& item) const;
  75
  76 private:
  77   CPVRGUIActionsRecordings(const CPVRGUIActionsRecordings&) = delete;
  78   CPVRGUIActionsRecordings const& operator=(CPVRGUIActionsRecordings const&) = delete;
  79
  80   /*!
  81    * @brief Open a dialog to confirm to delete a recording.
  82    * @param item the recording to delete.
  83    * @return true, to proceed with delete, false otherwise.
  84    */
  85   bool ConfirmDeleteRecording(const CFileItem& item) const;
  86
  87   /*!
  88    * @brief Open a dialog to confirm delete all watched recordings contained in the given folder.
  89    * @param item containing a recording folder containing the items to delete.
  90    * @return true, to proceed with delete, false otherwise.
  91    */
  92   bool ConfirmDeleteWatchedRecordings(const CFileItem& item) const;
  93
  94   /*!
  95    * @brief Open a dialog to confirm to permanently remove all deleted recordings.
  96      * @return true, to proceed with delete, false otherwise.
  97    */
  98   bool ConfirmDeleteAllRecordingsFromTrash() const;
  99
 100   /*!
 101    * @brief Open the recording settings dialog.
 102    * @param recording containing the recording the settings shall be displayed for.
 103    * @return true, if the dialog was ended successfully, false otherwise.
 104    */
 105   bool ShowRecordingSettings(const std::shared_ptr<CPVRRecording>& recording) const;
 106 };
 107
 108 namespace GUI
 109 {
 110 // pretty scope and name
 111 using Recordings = CPVRGUIActionsRecordings;
 112 } // namespace GUI
 113
 114 } // namespace PVR