Kodi Documentation  18.0
Kodi is an open source media player and entertainment hub.
Classes | Public Member Functions | Static Public Member Functions | List of all members
XFILE::CDirectory Class Reference
Filesystem

Wrappers for IDirectory. More...

#include <Directory.h>

Classes

class  CHints
 

Public Member Functions

 CDirectory (void)
 
virtual ~CDirectory (void)
 

Static Public Member Functions

static bool GetDirectory (const CURL &url, CFileItemList &items, const std::string &strMask, int flags)
 
static bool GetDirectory (const CURL &url, std::shared_ptr< IDirectory > pDirectory, CFileItemList &items, const CHints &hints)
 
static bool GetDirectory (const CURL &url, CFileItemList &items, const CHints &hints)
 
static bool Create (const CURL &url)
 
static bool Exists (const CURL &url, bool bUseCache=true)
 
static bool Remove (const CURL &url)
 
static bool RemoveRecursive (const CURL &url)
 
static bool GetDirectory (const std::string &strPath, CFileItemList &items, const std::string &strMask, int flags)
 
static bool GetDirectory (const std::string &strPath, std::shared_ptr< IDirectory > pDirectory, CFileItemList &items, const std::string &strMask, int flags)
 
static bool GetDirectory (const std::string &strPath, CFileItemList &items, const CHints &hints)
 
static bool Create (const std::string &strPath)
 
static bool Exists (const std::string &strPath, bool bUseCache=true)
 
static bool Remove (const std::string &strPath)
 
static bool RemoveRecursive (const std::string &strPath)
 
static void FilterFileDirectories (CFileItemList &items, const std::string &mask, bool expandImages=false)
 Filter files that act like directories from the list, replacing them with their directory counterparts. More...
 

Detailed Description

Wrappers for IDirectory.

Constructor & Destructor Documentation

§ CDirectory()

CDirectory::CDirectory ( void  )
default

§ ~CDirectory()

CDirectory::~CDirectory ( void  )
virtualdefault

Member Function Documentation

§ Create() [1/2]

bool CDirectory::Create ( const CURL &  url)
static

§ Create() [2/2]

bool CDirectory::Create ( const std::string &  strPath)
static

§ Exists() [1/2]

bool CDirectory::Exists ( const CURL &  url,
bool  bUseCache = true 
)
static

§ Exists() [2/2]

bool CDirectory::Exists ( const std::string &  strPath,
bool  bUseCache = true 
)
static

§ FilterFileDirectories()

void CDirectory::FilterFileDirectories ( CFileItemList &  items,
const std::string &  mask,
bool  expandImages = false 
)
static

Filter files that act like directories from the list, replacing them with their directory counterparts.

Parameters
itemsThe item list to filter
maskThe mask to apply when filtering files
expandImagesTrue to include disc images in file directory expansion

§ GetDirectory() [1/6]

bool CDirectory::GetDirectory ( const CURL &  url,
CFileItemList &  items,
const std::string &  strMask,
int  flags 
)
static

§ GetDirectory() [2/6]

bool CDirectory::GetDirectory ( const CURL &  url,
std::shared_ptr< IDirectory >  pDirectory,
CFileItemList &  items,
const CHints &  hints 
)
static
Todo:
we shouldn't be checking the gui setting here, callers should use getHidden instead

§ GetDirectory() [3/6]

bool CDirectory::GetDirectory ( const CURL &  url,
CFileItemList &  items,
const CHints &  hints 
)
static

§ GetDirectory() [4/6]

bool CDirectory::GetDirectory ( const std::string &  strPath,
CFileItemList &  items,
const std::string &  strMask,
int  flags 
)
static

§ GetDirectory() [5/6]

bool CDirectory::GetDirectory ( const std::string &  strPath,
std::shared_ptr< IDirectory >  pDirectory,
CFileItemList &  items,
const std::string &  strMask,
int  flags 
)
static

§ GetDirectory() [6/6]

bool CDirectory::GetDirectory ( const std::string &  strPath,
CFileItemList &  items,
const CHints &  hints 
)
static

§ Remove() [1/2]

bool CDirectory::Remove ( const CURL &  url)
static

§ Remove() [2/2]

bool CDirectory::Remove ( const std::string &  strPath)
static

§ RemoveRecursive() [1/2]

bool CDirectory::RemoveRecursive ( const CURL &  url)
static

§ RemoveRecursive() [2/2]

bool CDirectory::RemoveRecursive ( const std::string &  strPath)
static
The documentation for this class was generated from the following files: