![]() |
Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
|
Get access to shares and it's directories. More...
#include <VirtualDirectory.h>
Public Member Functions | |
CVirtualDirectory (void) | |
~CVirtualDirectory (void) override | |
bool | GetDirectory (const CURL &url, CFileItemList &items) override |
Retrieve the shares or the content of a directory. | |
void | CancelDirectory () override |
Cancel the current directory fetch (if possible). | |
bool | GetDirectory (const CURL &url, CFileItemList &items, bool bUseFileDirectories, bool keepImpl) |
void | SetSources (const std::vector< CMediaSource > &sources) |
Add shares to the virtual directory. | |
unsigned int | GetNumberOfSources () |
bool | IsSource (const std::string &strPath, std::vector< CMediaSource > *sources=NULL, std::string *name=NULL) const |
Is the share strPath in the virtual directory. | |
bool | IsInSource (const std::string &strPath) const |
Is the share path in the virtual directory. | |
const CMediaSource & | operator[] (const int index) const |
CMediaSource & | operator[] (const int index) |
void | GetSources (std::vector< CMediaSource > &sources) const |
void | AllowNonLocalSources (bool allow) |
std::shared_ptr< IDirectory > | GetDirImpl () |
void | ReleaseDirImpl () |
![]() | |
IDirectory () | |
virtual | ~IDirectory (void) |
virtual float | GetProgress () const |
Retrieve the progress of the current directory fetch (if possible). | |
virtual bool | Create (const CURL &url) |
Create the directory. | |
virtual bool | Exists (const CURL &url) |
Check for directory existence. | |
virtual bool | Remove (const CURL &url) |
Removes the directory. | |
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 CacheType | 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 | |
void | CacheThumbs (CFileItemList &items) |
![]() | |
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. | |
Protected Attributes | |
std::vector< CMediaSource > | m_sources |
bool | m_allowNonLocalSources |
std::shared_ptr< IDirectory > | m_pDir |
![]() | |
std::string | m_strFileMask |
Holds the file mask specified by SetMask() | |
int | m_flags |
Directory flags - see DIR_FLAG. | |
CVariant | m_requirements |
Additional Inherited Members | |
![]() | |
static void | RegisterProfileManager (const CProfileManager &profileManager) |
static void | UnregisterProfileManager () |
![]() | |
static const CProfileManager * | m_profileManager = nullptr |
Get access to shares and it's directories.
XFILE::CVirtualDirectory::CVirtualDirectory | ( | void | ) |
|
overridedefault |
|
protected |
|
overridevirtual |
Cancel the current directory fetch (if possible).
Reimplemented from XFILE::IDirectory.
|
overridevirtual |
Retrieve the shares or the content of a directory.
strPath | Specifies the path of the directory to retrieve or pass an empty string to get the shares. |
items | Content of the directory. |
Implements XFILE::IDirectory.
bool XFILE::CVirtualDirectory::GetDirectory | ( | const CURL & | url, |
CFileItemList & | items, | ||
bool | bUseFileDirectories, | ||
bool | keepImpl ) |
|
inline |
|
inline |
void XFILE::CVirtualDirectory::GetSources | ( | std::vector< CMediaSource > & | sources | ) | const |
bool XFILE::CVirtualDirectory::IsInSource | ( | const std::string & | path | ) | const |
Is the share path in the virtual directory.
path | Share to test |
bool XFILE::CVirtualDirectory::IsSource | ( | const std::string & | strPath, |
std::vector< CMediaSource > * | sources = NULL, | ||
std::string * | name = NULL ) const |
Is the share strPath in the virtual directory.
strPath | Share to test |
|
inline |
|
inline |
|
inline |
void XFILE::CVirtualDirectory::SetSources | ( | const std::vector< CMediaSource > & | sources | ) |
Add shares to the virtual directory.
std::vector<CMediaSource> | Shares to add |
|
protected |
|
protected |
|
protected |