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.
bool	GetProvidersDirectory (CFileItemList &results) const
	Get the list of providers.

Static Public Member Functions
static bool	Resolve (CFileItem &item)
	Resolves a given item to a playable item.
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.
static bool	GetRecordingsDirectoryInfo (CFileItem &item)
	Get info for a recording folder.

Constructor & Destructor Documentation

CPVRGUIDirectory() [1/2]

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

inlineexplicit

PVR GUI directory ctor.

Parameters

url	The directory's URL.

CPVRGUIDirectory() [2/2]

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

inlineexplicit

PVR GUI directory ctor.

Parameters

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

bRadio	If true, obtain radio groups, tv groups otherwise.
bExcludeHidden	If true exclude hidden groups, include hidden groups otherwise.
results	The 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

results

The 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

results

The list to fill with the results.

Returns

True on success, false otherwise.

GetProvidersDirectory()

bool CPVRGUIDirectory::GetProvidersDirectory

(

CFileItemList &

results

)

const

Get the list of providers.

Parameters

results

The file list to store the results in.

Returns

True on success, false otherwise..

GetRecordingsDirectoryInfo()

bool CPVRGUIDirectory::GetRecordingsDirectoryInfo ( CFileItem & item )

static

Get info for a recording folder.

Parameters

item	The folder.

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.

Resolve()

bool CPVRGUIDirectory::Resolve ( CFileItem & item )

static

Resolves a given item to a playable item.

Parameters

item	The item being manipulated (which the path points to a vfs protocol implementation)

Returns

True if the item was resolved, false if it failed to resolve

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:

• PVRGUIDirectory.h
• PVRGUIDirectory.cpp