PVRGUIActionsTimers.h

/*
 *  Copyright (C) 2016-2022 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 "pvr/IPVRComponent.h"
#include "pvr/settings/PVRSettings.h"

#include <memory>

class CFileItem;

namespace PVR
{
class CPVRChannel;
class CPVRTimerInfoTag;

class CPVRGUIActionsTimers : public IPVRComponent
{
public:
  CPVRGUIActionsTimers();
  ~CPVRGUIActionsTimers() override = default;

  bool AddTimer(bool bRadio) const;

  bool AddTimer(const CFileItem& item, bool bShowTimerSettings) const;

  bool AddTimer(const std::shared_ptr<CPVRTimerInfoTag>& item) const;

  bool AddTimerRule(const CFileItem& item,
                    bool bShowTimerSettings,
                    bool bFallbackToOneShotTimer) const;

  bool ToggleTimer(const CFileItem& item) const;

  bool ToggleTimerState(const CFileItem& item) const;

  bool EditTimer(const CFileItem& item) const;

  bool EditTimerRule(const CFileItem& item) const;

  std::shared_ptr<CFileItem> GetTimerRule(const CFileItem& item) const;

  bool DeleteTimer(const CFileItem& item) const;

  bool DeleteTimerRule(const CFileItem& item) const;

  bool ToggleRecordingOnPlayingChannel();

  bool SetRecordingOnChannel(const std::shared_ptr<CPVRChannel>& channel, bool bOnOff);

  bool StopRecording(const CFileItem& item) const;

  bool AddReminder(const CFileItem& item) const;

  void AnnounceReminders() const;

private:
  CPVRGUIActionsTimers(const CPVRGUIActionsTimers&) = delete;
  CPVRGUIActionsTimers const& operator=(CPVRGUIActionsTimers const&) = delete;

  bool ShowTimerSettings(const std::shared_ptr<CPVRTimerInfoTag>& timer) const;

  bool AddTimer(const CFileItem& item,
                bool bCreateRule,
                bool bShowTimerSettings,
                bool bFallbackToOneShotTimer) const;

  bool DeleteTimer(const CFileItem& item, bool bIsRecording, bool bDeleteRule) const;

  bool DeleteTimer(const std::shared_ptr<CPVRTimerInfoTag>& timer,
                   bool bIsRecording,
                   bool bDeleteRule) const;

  bool ConfirmDeleteTimer(const std::shared_ptr<const CPVRTimerInfoTag>& timer,
                          bool& bDeleteRule) const;

  bool ConfirmStopRecording(const std::shared_ptr<const CPVRTimerInfoTag>& timer) const;

  void AnnounceReminder(const std::shared_ptr<CPVRTimerInfoTag>& timer) const;

  CPVRSettings m_settings;
  mutable bool m_bReminderAnnouncementRunning{false};
};

namespace GUI
{
// pretty scope and name
using Timers = CPVRGUIActionsTimers;
} // namespace GUI

} // namespace PVR