XFILE::COverrideDirectory Class Reference

#include <OverrideDirectory.h>

Inheritance diagram for XFILE::COverrideDirectory:

Public Member Functions
	COverrideDirectory ()
	~COverrideDirectory () override
bool	Create (const CURL &url) override
	Create the directory.
bool	Exists (const CURL &url) override
	Check for directory existence.
bool	Remove (const CURL &url) override
	Removes the directory.
Public Member Functions inherited from XFILE::IDirectory
	IDirectory ()
virtual	~IDirectory (void)
virtual bool	GetDirectory (const CURL &url, CFileItemList &items)=0
	Get the items of the directory strPath.
virtual float	GetProgress () const
	Retrieve the progress of the current directory fetch (if possible).
virtual void	CancelDirectory ()
	Cancel the current directory fetch (if possible).
virtual bool	RemoveRecursive (const CURL &url)
	Recursively removes the directory.
virtual bool	IsAllowed (const CURL &url) const
	Whether this file should be listed.
virtual bool	AllowAll () const
	Whether to allow all files/folders to be listed.
virtual DIR_CACHE_TYPE	GetCacheType (const CURL &url) const
	How this directory should be cached.
void	SetMask (const std::string &strMask)
	Set a mask of extensions for the files in the directory.
void	SetFlags (int flags)
	Set the flags for this directory handler.
bool	ProcessRequirements ()
	Process additional requirements before the directory fetch is performed. Some directory fetches may require authentication, keyboard input etc. The IDirectory subclass should call GetKeyboardInput, SetErrorDialog or RequireAuthentication and then return false from the GetDirectory method. CDirectory will then prompt for input from the user, before re-calling the GetDirectory method.
virtual bool	Resolve (CFileItem &item) const
	Resolves a given item to a playable item.

Protected Member Functions
virtual std::string	TranslatePath (const CURL &url)=0
Protected Member Functions inherited from XFILE::IDirectory
bool	GetKeyboardInput (const CVariant &heading, std::string &input, bool hiddenInput=false)
	Prompt the user for some keyboard input Call this method from the GetDirectory method to retrieve additional input from the user. If this function returns false then no input has been received, and the GetDirectory call should return false.
void	SetErrorDialog (const CVariant &heading, const CVariant &line1, const CVariant &line2=0, const CVariant &line3=0)
	Show an error dialog on failure of GetDirectory call Call this method from the GetDirectory method to set an error message to be shown to the user.
void	RequireAuthentication (const CURL &url)
	Prompt the user for authentication of a URL. Call this method from the GetDirectory method when authentication is required from the user, before returning false from the GetDirectory call. The user will be prompted for authentication, and GetDirectory will be re-called.

Additional Inherited Members
Static Public Member Functions inherited from XFILE::IDirectory
static void	RegisterProfileManager (const CProfileManager &profileManager)
static void	UnregisterProfileManager ()
Protected Attributes inherited from XFILE::IDirectory
std::string	m_strFileMask
	Holds the file mask specified by SetMask()
int	m_flags
	Directory flags - see DIR_FLAG.
CVariant	m_requirements
Static Protected Attributes inherited from XFILE::IDirectory
static const CProfileManager *	m_profileManager = nullptr

Constructor & Destructor Documentation

COverrideDirectory()

COverrideDirectory::COverrideDirectory ( )

default

~COverrideDirectory()

COverrideDirectory::~COverrideDirectory ( )

overridedefault

Member Function Documentation

Create()

bool COverrideDirectory::Create ( const CURL & url )

overridevirtual

Create the directory.

Parameters

url	Directory to create.

Returns

Returns true, if directory is created or if it already exists

See also

CDirectoryFactory

Reimplemented from XFILE::IDirectory.

Exists()

bool COverrideDirectory::Exists ( const CURL & url )

overridevirtual

Check for directory existence.

Parameters

url	Directory to check.

Returns

Returns true, if directory exists

See also

CDirectoryFactory

Reimplemented from XFILE::IDirectory.

Remove()

bool COverrideDirectory::Remove ( const CURL & url )

overridevirtual

Removes the directory.

Parameters

url	Directory to remove.

Returns

Returns false if not successful

Reimplemented from XFILE::IDirectory.

TranslatePath()

virtual std::string XFILE::COverrideDirectory::TranslatePath ( const CURL & url )

protectedpure virtual

Implemented in XFILE::CResourceDirectory, and XFILE::CSpecialProtocolDirectory.

---

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

• OverrideDirectory.h
• OverrideDirectory.cpp