Guiliani  Version 2.5 revision 7293 (documentation build 13)
CGUIDirectoryWin Class Reference

Specific implementation of CGUIDirectory for Windows systems. More...

#include <GUIDirectoryWin.h>

Inheritance diagram for CGUIDirectoryWin:

Public Member Functions

 ~CGUIDirectoryWin ()
 
virtual eC_Bool CheckExist () const
 
virtual eC_Bool CreateSubDir (const eC_String &kDirName)
 
virtual eC_Bool IsReadable () const
 
virtual eC_Bool IsRoot () const
 
virtual eC_Bool RemoveFile (const eC_String &kFileName)
 
virtual eC_Bool RemoveSubDir (const eC_String &kDirName, eC_Bool bRecursive=false)
 
virtual eC_Bool RenameFile (const eC_String &kOldName, const eC_String &kNewName)
 
- Public Member Functions inherited from CGUIDirectory
 CGUIDirectory (const CGUIDirectory &kDirectory)
 
 CGUIDirectory (const eC_String &kPath, const StringList_t &kNameFilter, eC_UInt uiFilter=ALL, SortFlag_t eSort=NAME, eC_Bool bSortCaseInsensitive=true)
 
 CGUIDirectory (const eC_String &kPath="", const eC_String &kNameFilter="")
 
virtual ~CGUIDirectory ()
 
eC_Bool ChangeDirectory (const eC_String &kDirName)
 
eC_Bool ChangeToParentDir ()
 
virtual eC_Bool CheckExist () const =0
 
eC_UInt CountFiles ()
 
virtual eC_Bool CreateSubDir (const eC_String &kDirName)=0
 
eC_String GetAbsPath () const
 
const CGUIDirInfoGetDirInfo (const eC_String &kFilePath)
 
eC_String GetDirName () const
 
StringList_t GetEntryFileNameList ()
 
const CGUIDirInfo::DirInfoPtrList_tGetEntryInfoList ()
 
StringList_t GetEntryList ()
 
eC_UInt GetFilterAttr () const
 
StringList_t GetNameFilters () const
 
eC_Bool GetSortCaseInSensitive () const
 
SortFlag_t GetSortFlag () const
 
virtual eC_Bool IsAbsPath () const
 
virtual eC_Bool IsReadable () const =0
 
virtual eC_Bool IsRoot () const =0
 
void MakePathAbs ()
 
CGUIDirectoryoperator= (const CGUIDirectory &kDirectory)
 
void RefreshList ()
 
virtual eC_Bool RemoveFile (const eC_String &kFileName)=0
 
virtual eC_Bool RemoveSubDir (const eC_String &kDirName, eC_Bool bRecursive=false)=0
 
virtual eC_Bool RenameFile (const eC_String &kOldName, const eC_String &kNewName)=0
 
void RevertSortList ()
 
void SetFilter (eC_UInt uiFilter)
 
void SetListSpecialFileFlag (eC_Bool bListSpecialFile)
 
void SetNameFilters (const eC_String &kNameFilter)
 
void SetNameFilters (const StringList_t &kNameFilter)
 
void SetSortCaseInSensitive (eC_Bool bSortCaseInsensitive)
 
void SetSortFlag (SortFlag_t eSort)
 

Protected Member Functions

virtual void ListFiles ()
 
- Protected Member Functions inherited from CGUIDirectory
void FilterList ()
 
void FreeDirInfoList ()
 
virtual void ListFiles ()=0
 
void SortDirInfoList ()
 
void SortSubList (CGUIDirInfo::DirInfoPtrList_t &kList)
 

Friends

class CGUIFileSysWrapWin
 Only the CGUIFileSysWrapWin can construct an object of this class. More...
 

Additional Inherited Members

- Public Types inherited from CGUIDirectory
enum  Filter_t {
  DIRECTORIES = 0x001 , FILES = 0x002 , NOSYMLINK = 0x004 , READABLE = 0x008 ,
  WRITABLE = 0x010 , EXECUTABLE = 0x020 , HIDDEN = 0x040 , SYSTEM = 0x080 ,
  SYMLINK = 0x100 , ALL = 0x200
}
 
enum  SortFlag_t { NAME = 0x00 , TIME = 0x01 , SIZE = 0x02 , TYPE = 0x04 }
 
typedef eC_TListDoubleLinked< eC_String > StringList_t
 A list of strings.
 
- Protected Attributes inherited from CGUIDirectory
eC_Bool m_bListNeedRecreation
 
eC_Bool m_bListSpecialFile
 
eC_Bool m_bSortCaseInsensitive
 
eC_Bool m_bSortDirsFirst
 
SortFlag_t m_eSortFlag
 
eC_String m_kCurrentWorkingDir
 
CGUIDirInfo::DirInfoPtrList_t m_kDirectoriesList
 
CGUIDirInfo::DirInfoPtrList_t m_kDirInfoList
 
eC_String m_kDirPath
 
CGUIDirInfo::DirInfoPtrList_t m_kFilesList
 
StringList_t m_kNameFilters
 
eC_UInt m_uiFilter
 

Detailed Description

Specific implementation of CGUIDirectory for Windows systems.

Constructor & Destructor Documentation

◆ ~CGUIDirectoryWin()

CGUIDirectoryWin::~CGUIDirectoryWin ( )
inline

Destructor.

Member Function Documentation

◆ CheckExist()

virtual eC_Bool CGUIDirectoryWin::CheckExist ( ) const
virtual

Check whether this directory does exist in the file system.

Returns
True if the directory exists, otherwise False.

Implements CGUIDirectory.

◆ CreateSubDir()

virtual eC_Bool CGUIDirectoryWin::CreateSubDir ( const eC_String &  kDirName)
virtual

Creates a sub-directory in this directory.

Parameters
kDirNameName of the new directory.
Returns
True on success, otherwise False.

Implements CGUIDirectory.

◆ IsReadable()

virtual eC_Bool CGUIDirectoryWin::IsReadable ( ) const
virtual

Check whether the given directory is readable or not.

Returns
True if the directory is readable, otherwise False.

Implements CGUIDirectory.

◆ IsRoot()

virtual eC_Bool CGUIDirectoryWin::IsRoot ( ) const
virtual

Check whether the given directory is a root directory or not.

Returns
True if the directory is the root directory, otherwise False.

Implements CGUIDirectory.

◆ ListFiles()

virtual void CGUIDirectoryWin::ListFiles ( )
protectedvirtual

Create the list that stores the CGUIDirInfo pointers.

Implements CGUIDirectory.

◆ RemoveFile()

virtual eC_Bool CGUIDirectoryWin::RemoveFile ( const eC_String &  kFileName)
virtual

Removes the file with the given name. The list of the dir info must be regenerated.

Parameters
kFileNameThe given file name that is to be removed.
Returns
True if the file is removed successfully, otherwise False.

Implements CGUIDirectory.

◆ RemoveSubDir()

virtual eC_Bool CGUIDirectoryWin::RemoveSubDir ( const eC_String &  kDirName,
eC_Bool  bRecursive = false 
)
virtual

Removes the sub directory specified by the given directory name.

Parameters
kDirNameName of the directory to be deleted.
bRecursiveIf true, all sub directories and files are also deleted. If false, the directory must be empty for this method to succeed.
Returns
True if successful, otherwise False.

Implements CGUIDirectory.

◆ RenameFile()

virtual eC_Bool CGUIDirectoryWin::RenameFile ( const eC_String &  kOldName,
const eC_String &  kNewName 
)
virtual

Renames a file or directory. The list of the dir info must be regenerated.

Parameters
kOldNameThe old file name that is to be renamed.
kNewNameThe new file name.
Returns
True if successful; otherwise False.

Implements CGUIDirectory.

Friends And Related Function Documentation

◆ CGUIFileSysWrapWin

friend class CGUIFileSysWrapWin
friend

Only the CGUIFileSysWrapWin can construct an object of this class.


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