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

#include <PVRGUIDirectory.h>

Public Member Functions

 CPVRGUIDirectory (const CURL &url)
 PVR GUI directory ctor.
 
 CPVRGUIDirectory (const std::string &path)
 PVR GUI directory ctor.
 
virtual ~CPVRGUIDirectory ()=default
 PVR GUI directory dtor.
 
bool Exists () const
 Check existence of this directory.
 
bool GetDirectory (CFileItemList &results) const
 Obtain the directory listing.
 
bool SupportsWriteFileOperations () const
 Check if this directory supports file write operations.
 
bool GetChannelsDirectory (CFileItemList &results) const
 Get the list of channels.
 

Static Public Member Functions

static bool HasTVRecordings ()
 Check if any TV recordings are existing.
 
static bool HasDeletedTVRecordings ()
 Check if any deleted TV recordings are existing.
 
static bool HasRadioRecordings ()
 Check if any radio recordings are existing.
 
static bool HasDeletedRadioRecordings ()
 Check if any deleted radio recordings are existing.
 
static bool GetChannelGroupsDirectory (bool bRadio, bool bExcludeHidden, CFileItemList &results)
 Get the list of channel groups.
 

Constructor & Destructor Documentation

◆ CPVRGUIDirectory() [1/2]

PVR::CPVRGUIDirectory::CPVRGUIDirectory ( const CURL & url)
inlineexplicit

PVR GUI directory ctor.

Parameters
urlThe directory's URL.

◆ CPVRGUIDirectory() [2/2]

PVR::CPVRGUIDirectory::CPVRGUIDirectory ( const std::string & path)
inlineexplicit

PVR GUI directory ctor.

Parameters
pathThe directory's path.

◆ ~CPVRGUIDirectory()

virtual PVR::CPVRGUIDirectory::~CPVRGUIDirectory ( )
virtualdefault

PVR GUI directory dtor.

Member Function Documentation

◆ Exists()

bool CPVRGUIDirectory::Exists ( ) const

Check existence of this directory.

Returns
True if the directory exists, false otherwise.

◆ GetChannelGroupsDirectory()

bool CPVRGUIDirectory::GetChannelGroupsDirectory ( bool bRadio,
bool bExcludeHidden,
CFileItemList & results )
static

Get the list of channel groups.

Parameters
bRadioIf true, obtain radio groups, tv groups otherwise.
bExcludeHiddenIf true exclude hidden groups, include hidden groups otherwise.
resultsThe file list to store the results in.
Returns
True on success, false otherwise..

◆ GetChannelsDirectory()

bool CPVRGUIDirectory::GetChannelsDirectory ( CFileItemList & results) const

Get the list of channels.

Parameters
resultsThe file list to store the results in.
Returns
True on success, false otherwise..

◆ GetDirectory()

bool CPVRGUIDirectory::GetDirectory ( CFileItemList & results) const

Obtain the directory listing.

Parameters
resultsThe list to fill with the results.
Returns
True on success, false otherwise.

◆ HasDeletedRadioRecordings()

bool CPVRGUIDirectory::HasDeletedRadioRecordings ( )
static

Check if any deleted radio recordings are existing.

Returns
True if deleted radio recordings exists, false otherwise.

◆ HasDeletedTVRecordings()

bool CPVRGUIDirectory::HasDeletedTVRecordings ( )
static

Check if any deleted TV recordings are existing.

Returns
True if deleted TV recordings exists, false otherwise.

◆ HasRadioRecordings()

bool CPVRGUIDirectory::HasRadioRecordings ( )
static

Check if any radio recordings are existing.

Returns
True if radio recordings exists, false otherwise.

◆ HasTVRecordings()

bool CPVRGUIDirectory::HasTVRecordings ( )
static

Check if any TV recordings are existing.

Returns
True if TV recordings exists, false otherwise.

◆ SupportsWriteFileOperations()

bool CPVRGUIDirectory::SupportsWriteFileOperations ( ) const

Check if this directory supports file write operations.

Returns
True if the directory supports file write operations, false otherwise.

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