Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
PVR::CPVRGUIActionsRecordings Class Reference

#include <PVRGUIActionsRecordings.h>

Inheritance diagram for PVR::CPVRGUIActionsRecordings:
PVR::IPVRComponent

Public Member Functions

 CPVRGUIActionsRecordings ()
 
 ~CPVRGUIActionsRecordings () override=default
 
bool ShowRecordingInfo (const CFileItem &item) const
 Open a dialog with information for a given recording.
 
bool EditRecording (const CFileItem &item) const
 Open the recording settings dialog to edit a recording.
 
bool CanEditRecording (const CFileItem &item) const
 Check if any recording settings can be edited.
 
bool DeleteRecording (const CFileItem &item) const
 Delete a recording, always showing a confirmation dialog.
 
bool DeleteWatchedRecordings (const CFileItem &item) const
 Delete all watched recordings contained in the given folder, always showing a confirmation dialog.
 
bool DeleteAllRecordingsFromTrash () const
 Delete all recordings from trash, always showing a confirmation dialog.
 
bool UndeleteRecording (const CFileItem &item) const
 Undelete a recording.
 
bool IncrementPlayCount (const CFileItem &item) const
 Increment the play count of a recording. Process "Delete after watching" action.
 
bool MarkWatched (const CFileItem &item, bool watched) const
 Mark a recording watched or unwatched. Process "Delete after watching" action.
 
- Public Member Functions inherited from PVR::IPVRComponent
virtual ~IPVRComponent ()=default
 

Constructor & Destructor Documentation

◆ CPVRGUIActionsRecordings()

CPVRGUIActionsRecordings::CPVRGUIActionsRecordings ( )

◆ ~CPVRGUIActionsRecordings()

PVR::CPVRGUIActionsRecordings::~CPVRGUIActionsRecordings ( )
overridedefault

Member Function Documentation

◆ CanEditRecording()

bool CPVRGUIActionsRecordings::CanEditRecording ( const CFileItem & item) const

Check if any recording settings can be edited.

Parameters
itemcontaining the recording to edit.
Returns
true on success, false otherwise.

◆ DeleteAllRecordingsFromTrash()

bool CPVRGUIActionsRecordings::DeleteAllRecordingsFromTrash ( ) const

Delete all recordings from trash, always showing a confirmation dialog.

Returns
true, if the recordings were permanently deleted successfully, false otherwise.

◆ DeleteRecording()

bool CPVRGUIActionsRecordings::DeleteRecording ( const CFileItem & item) const

Delete a recording, always showing a confirmation dialog.

Parameters
itemcontaining a recording to delete.
Returns
true, if the recording was deleted successfully, false otherwise.

◆ DeleteWatchedRecordings()

bool CPVRGUIActionsRecordings::DeleteWatchedRecordings ( const CFileItem & item) const

Delete all watched recordings contained in the given folder, always showing a confirmation dialog.

Parameters
itemcontaining a recording folder containing the items to delete.
Returns
true, if the recordings were deleted successfully, false otherwise.

◆ EditRecording()

bool CPVRGUIActionsRecordings::EditRecording ( const CFileItem & item) const

Open the recording settings dialog to edit a recording.

Parameters
itemcontaining the recording to edit.
Returns
true on success, false otherwise.

◆ IncrementPlayCount()

bool CPVRGUIActionsRecordings::IncrementPlayCount ( const CFileItem & item) const

Increment the play count of a recording. Process "Delete after watching" action.

Parameters
itemcontaining a recording for which the play count shall be incremented.
Returns
true, if the recording's play count was incremented successfully, false otherwise.

◆ MarkWatched()

bool CPVRGUIActionsRecordings::MarkWatched ( const CFileItem & item,
bool watched ) const

Mark a recording watched or unwatched. Process "Delete after watching" action.

Parameters
itemcontaining a recording to be marked watched or unwatched.
watchedWhether to mark the recording watched or unwatched.
Returns
true, if the recording's watched state was changed successfully, false otherwise.

◆ ShowRecordingInfo()

bool CPVRGUIActionsRecordings::ShowRecordingInfo ( const CFileItem & item) const

Open a dialog with information for a given recording.

Parameters
itemcontaining a recording.
Returns
true on success, false otherwise.

◆ UndeleteRecording()

bool CPVRGUIActionsRecordings::UndeleteRecording ( const CFileItem & item) const

Undelete a recording.

Parameters
itemcontaining a recording to undelete.
Returns
true, if the recording was undeleted successfully, false otherwise.

The documentation for this class was generated from the following files: