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

#include <PVRGUIActionsEPG.h>

Inheritance diagram for PVR::CPVRGUIActionsEPG:
PVR::IPVRComponent

Public Member Functions

 CPVRGUIActionsEPG ()=default
 
 ~CPVRGUIActionsEPG () override=default
 
bool ShowEPGInfo (const CFileItem &item) const
 Open a dialog with epg information for a given item.
 
bool ShowChannelEPG (const CFileItem &item) const
 Open a dialog with the epg list for a given item.
 
bool FindSimilar (const CFileItem &item) const
 Open a window containing a list of epg tags 'similar' to a given item.
 
bool ExecuteSavedSearch (const CFileItem &item)
 Execute a saved search. Displays result in search window if it is open.
 
bool EditSavedSearch (const CFileItem &item)
 Edit a saved search. Opens the search dialog.
 
bool RenameSavedSearch (const CFileItem &item)
 Rename a saved search. Opens a title input dialog.
 
bool DeleteSavedSearch (const CFileItem &item)
 Delete a saved search. Opens confirmation dialog before deleting.
 
- Public Member Functions inherited from PVR::IPVRComponent
virtual ~IPVRComponent ()=default
 

Constructor & Destructor Documentation

◆ CPVRGUIActionsEPG()

PVR::CPVRGUIActionsEPG::CPVRGUIActionsEPG ( )
default

◆ ~CPVRGUIActionsEPG()

PVR::CPVRGUIActionsEPG::~CPVRGUIActionsEPG ( )
overridedefault

Member Function Documentation

◆ DeleteSavedSearch()

bool CPVRGUIActionsEPG::DeleteSavedSearch ( const CFileItem & item)

Delete a saved search. Opens confirmation dialog before deleting.

Parameters
itemThe item containing a search filter.
Returns
True on success, false otherwise.

◆ EditSavedSearch()

bool CPVRGUIActionsEPG::EditSavedSearch ( const CFileItem & item)

Edit a saved search. Opens the search dialog.

Parameters
itemThe item containing a search filter.
Returns
True on success, false otherwise.

◆ ExecuteSavedSearch()

bool CPVRGUIActionsEPG::ExecuteSavedSearch ( const CFileItem & item)

Execute a saved search. Displays result in search window if it is open.

Parameters
itemThe item containing a search filter.
Returns
True on success, false otherwise.

◆ FindSimilar()

bool CPVRGUIActionsEPG::FindSimilar ( const CFileItem & item) const

Open a window containing a list of epg tags 'similar' to a given item.

Parameters
itemcontaining epg data for matching. item must be an epg tag, a channel or a recording.
Returns
true on success, false otherwise.
Todo
If we want dialogs to spawn program search in a clean way - without having to force-close any

◆ RenameSavedSearch()

bool CPVRGUIActionsEPG::RenameSavedSearch ( const CFileItem & item)

Rename a saved search. Opens a title input dialog.

Parameters
itemThe item containing a search filter.
Returns
True on success, false otherwise.

◆ ShowChannelEPG()

bool CPVRGUIActionsEPG::ShowChannelEPG ( const CFileItem & item) const

Open a dialog with the epg list for a given item.

Parameters
itemcontaining channel info. item must be an epg tag, a channel or a timer.
Returns
true on success, false otherwise.

◆ ShowEPGInfo()

bool CPVRGUIActionsEPG::ShowEPGInfo ( const CFileItem & item) const

Open a dialog with epg information for a given item.

Parameters
itemcontaining epg data to show. item must be an epg tag, a channel or a timer.
Returns
true on success, false otherwise.

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