PVR::CPVRGUIActionsEPG Class Reference

#include <PVRGUIActionsEPG.h>

Inheritance diagram for PVR::CPVRGUIActionsEPG:

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) const
	Execute a saved search. Displays result in search window if it is open.
bool	EditSavedSearch (const CFileItem &item) const
	Edit a saved search. Opens the search dialog.
bool	RenameSavedSearch (const CFileItem &item) const
	Rename a saved search. Opens a title input dialog.
bool	ChooseIconForSavedSearch (const CFileItem &item) const
	Choose an icon for a saved search. Opens an art chooser dialog.
bool	DuplicateSavedSearch (const CFileItem &item) const
	Duplicate a saved search.
bool	DeleteSavedSearch (const CFileItem &item) const
	Delete a saved search. Opens confirmation dialog before deleting.
std::string	GetTitleForEpgTag (const std::shared_ptr< const CPVREpgInfoTag > &tag) const
	Get the title for the given EPG tag, taking settings and parental controls into account.
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

ChooseIconForSavedSearch()

bool CPVRGUIActionsEPG::ChooseIconForSavedSearch

(

const CFileItem &

item

)

const

Choose an icon for a saved search. Opens an art chooser dialog.

Parameters

item	The item containing a search filter.

Returns

True on success, false otherwise.

DeleteSavedSearch()

bool CPVRGUIActionsEPG::DeleteSavedSearch

(

const CFileItem &

item

)

const

Delete a saved search. Opens confirmation dialog before deleting.

Parameters

item	The item containing a search filter.

Returns

True on success, false otherwise.

DuplicateSavedSearch()

bool CPVRGUIActionsEPG::DuplicateSavedSearch

(

const CFileItem &

item

)

const

Duplicate a saved search.

Parameters

item	The item containing a search filter.

Returns

True on success, false otherwise.

EditSavedSearch()

bool CPVRGUIActionsEPG::EditSavedSearch

(

const CFileItem &

item

)

const

Edit a saved search. Opens the search dialog.

Parameters

item	The item containing a search filter.

Returns

True on success, false otherwise.

ExecuteSavedSearch()

bool CPVRGUIActionsEPG::ExecuteSavedSearch

(

const CFileItem &

item

)

const

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

Parameters

item	The 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

item	containing 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

GetTitleForEpgTag()

std::string CPVRGUIActionsEPG::GetTitleForEpgTag

(

const std::shared_ptr< const CPVREpgInfoTag > &

tag

)

const

Get the title for the given EPG tag, taking settings and parental controls into account.

Parameters

item	The EPG tag.

Returns

"Parental locked" in case the access to the information is restricted by parental controls, "No information available" if the real EPG event title is empty and SETTING_EPG_HIDENOINFOAVAILABLE is false or tag is nullptr, the real EPG event title as given by the EPG data provider otherwise.

RenameSavedSearch()

bool CPVRGUIActionsEPG::RenameSavedSearch

(

const CFileItem &

item

)

const

Rename a saved search. Opens a title input dialog.

Parameters

item	The 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

item	containing 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

item	containing 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:

• PVRGUIActionsEPG.h
• PVRGUIActionsEPG.cpp