xbmc
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Friends | List of all members
XFILE::CWin32SMBDirectory Class Reference
Inheritance diagram for XFILE::CWin32SMBDirectory:
Inheritance graph
[legend]
Collaboration diagram for XFILE::CWin32SMBDirectory:
Collaboration graph
[legend]

Public Member Functions

virtual bool GetDirectory (const CURL &url, CFileItemList &items)
 Get the items of the directory strPath. More...
 
virtual bool Create (const CURL &url)
 Create the directory. More...
 
virtual bool Exists (const CURL &url)
 Check for directory existence. More...
 
virtual bool Remove (const CURL &url)
 Removes the directory. More...
 
- Public Member Functions inherited from XFILE::IDirectory
virtual float GetProgress () const
 Retrieve the progress of the current directory fetch (if possible). More...
 
virtual void CancelDirectory ()
 Cancel the current directory fetch (if possible). More...
 
virtual bool RemoveRecursive (const CURL &url)
 Recursively removes the directory. More...
 
virtual bool IsAllowed (const CURL &url) const
 Whether this file should be listed. More...
 
virtual bool AllowAll () const
 Whether to allow all files/folders to be listed. More...
 
virtual DIR_CACHE_TYPE GetCacheType (const CURL &url) const
 How this directory should be cached. More...
 
void SetMask (const std::string &strMask)
 Set a mask of extensions for the files in the directory. More...
 
void SetFlags (int flags)
 Set the flags for this directory handler. More...
 
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. More...
 

Protected Member Functions

bool RealCreate (const CURL &url, bool tryToConnect)
 
bool RealExists (const CURL &url, bool tryToConnect)
 
bool ConnectAndAuthenticate (CURL &url, bool allowPromptForCredential=false)
 
- 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. More...
 
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. More...
 
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. More...
 

Static Protected Member Functions

static bool GetNetworkResources (const CURL &basePath, CFileItemList &items)
 

Friends

class CWin32SMBFile
 

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 CProfileManagerm_profileManager = nullptr
 

Member Function Documentation

◆ Create()

bool CWin32SMBDirectory::Create ( const CURL url)
virtual

Create the directory.

Parameters
urlDirectory to create.
Returns
Returns true, if directory is created or if it already exists
See also
CDirectoryFactory

Reimplemented from XFILE::IDirectory.

◆ Exists()

bool CWin32SMBDirectory::Exists ( const CURL url)
virtual

Check for directory existence.

Parameters
urlDirectory to check.
Returns
Returns true, if directory exists
See also
CDirectoryFactory

Reimplemented from XFILE::IDirectory.

◆ GetDirectory()

bool CWin32SMBDirectory::GetDirectory ( const CURL url,
CFileItemList items 
)
virtual

Get the items of the directory strPath.

Parameters
urlDirectory to read.
itemsRetrieves the directory entries.
Returns
Returns true, if successful.
See also
CDirectoryFactory
Todo:
support m_strFileMask, require rewrite of internal caching

Implements XFILE::IDirectory.

◆ RealExists()

bool CWin32SMBDirectory::RealExists ( const CURL url,
bool  tryToConnect 
)
protected
Todo:
use real caseless string comparison everywhere in this function

◆ Remove()

bool CWin32SMBDirectory::Remove ( const CURL url)
virtual

Removes the directory.

Parameters
urlDirectory to remove.
Returns
Returns false if not successful

Reimplemented from XFILE::IDirectory.


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