Add wxDateTime::DiffAsDateSpan().

[wxWidgets.git] / include / wx / dir.h

diff --git a/include/wx/dir.h b/include/wx/dir.h
index 212d0586a2d0c75e2e81c7d33acc75827ba4b041..83dab66454b83c7a296bdcc1b237d76c1b893e8b 100644 (file)
--- a/include/wx/dir.h
+++ b/include/wx/dir.h
@@ -12,9 +12,11 @@
 #ifndef _WX_DIR_H_
 #define _WX_DIR_H_
 
 #ifndef _WX_DIR_H_
 #define _WX_DIR_H_
 

+#include "wx/longlong.h"

 #include "wx/string.h"
 #include "wx/string.h"

+#include "wx/filefn.h"      // for wxS_DIR_DEFAULT

 
 

-class WXDLLIMPEXP_BASE wxArrayString;
+class WXDLLIMPEXP_FWD_BASE wxArrayString;

 
 // ----------------------------------------------------------------------------
 // constants
 
 // ----------------------------------------------------------------------------
 // constants


@@ -22,7 +24,7 @@ class WXDLLIMPEXP_BASE wxArrayString;
 
 // these flags define what kind of filenames is included in the list of files
 // enumerated by GetFirst/GetNext
 
 // these flags define what kind of filenames is included in the list of files
 // enumerated by GetFirst/GetNext

-enum
+enum wxDirFlags

 {
     wxDIR_FILES     = 0x0001,       // include files
     wxDIR_DIRS      = 0x0002,       // include directories
 {
     wxDIR_FILES     = 0x0001,       // include files
     wxDIR_DIRS      = 0x0002,       // include directories


@@ -62,7 +64,7 @@ public:
     virtual wxDirTraverseResult OnDir(const wxString& dirname) = 0;
 
     // called for each directory which we couldn't open during our traversal
     virtual wxDirTraverseResult OnDir(const wxString& dirname) = 0;
 
     // called for each directory which we couldn't open during our traversal

-    // of the directory tyree
+    // of the directory tree

     //
     // this method can also return either wxDIR_STOP, wxDIR_IGNORE or
     // wxDIR_CONTINUE but the latter is treated specially: it means to retry
     //
     // this method can also return either wxDIR_STOP, wxDIR_IGNORE or
     // wxDIR_CONTINUE but the latter is treated specially: it means to retry


@@ -77,13 +79,11 @@ public:
 // wxDir: portable equivalent of {open/read/close}dir functions
 // ----------------------------------------------------------------------------
 
 // wxDir: portable equivalent of {open/read/close}dir functions
 // ----------------------------------------------------------------------------
 

-class WXDLLIMPEXP_BASE wxDirData;
+class WXDLLIMPEXP_FWD_BASE wxDirData;

 
 class WXDLLIMPEXP_BASE wxDir
 {
 public:
 
 class WXDLLIMPEXP_BASE wxDir
 {
 public:

-    // test for existence of a directory with the given name
-    static bool Exists(const wxString& dir);

 
     // ctors
     // -----
 
     // ctors
     // -----


@@ -94,18 +94,26 @@ public:
     // opens the directory for enumeration, use IsOpened() to test success
     wxDir(const wxString& dir);
 
     // opens the directory for enumeration, use IsOpened() to test success
     wxDir(const wxString& dir);
 

-    // dtor cleans up the associated ressources
-    ~wxDir();
+    // dtor calls Close() automatically
+    ~wxDir() { Close(); }

 
     // open the directory for enumerating
     bool Open(const wxString& dir);
 
 
     // open the directory for enumerating
     bool Open(const wxString& dir);
 

+    // close the directory, Open() can be called again later
+    void Close();
+

     // returns true if the directory was successfully opened
     bool IsOpened() const;
 
     // get the full name of the directory (without '/' at the end)
     wxString GetName() const;
 
     // returns true if the directory was successfully opened
     bool IsOpened() const;
 
     // get the full name of the directory (without '/' at the end)
     wxString GetName() const;
 

+    // Same as GetName() but does include the trailing separator, unless the
+    // string is empty (only for invalid directories).
+    wxString GetNameWithSep() const;
+
+

     // file enumeration routines
     // -------------------------
 
     // file enumeration routines
     // -------------------------
 


@@ -119,10 +127,10 @@ public:
     bool GetNext(wxString *filename) const;
 
     // return true if this directory has any files in it
     bool GetNext(wxString *filename) const;
 
     // return true if this directory has any files in it

-    bool HasFiles(const wxString& spec = wxEmptyString);
+    bool HasFiles(const wxString& spec = wxEmptyString) const;

 
     // return true if this directory has any subdirectories
 
     // return true if this directory has any subdirectories

-    bool HasSubDirs(const wxString& spec = wxEmptyString);
+    bool HasSubDirs(const wxString& spec = wxEmptyString) const;

 
     // enumerate all files in this directory and its subdirectories
     //
 
     // enumerate all files in this directory and its subdirectories
     //


@@ -145,12 +153,31 @@ public:
                               const wxString& filespec,
                               int flags = wxDIR_DEFAULT);
 
                               const wxString& filespec,
                               int flags = wxDIR_DEFAULT);
 

+#if wxUSE_LONGLONG
+    // returns the size of all directories recursively found in given path
+    static wxULongLong GetTotalSize(const wxString &dir, wxArrayString *filesSkipped = NULL);
+#endif // wxUSE_LONGLONG
+
+
+    // static utilities for directory management
+    // (alias to wxFileName's functions for dirs)
+    // -----------------------------------------
+
+    // test for existence of a directory with the given name
+    static bool Exists(const wxString& dir);
+
+    static bool Make(const wxString &dir, int perm = wxS_DIR_DEFAULT,
+                     int flags = 0);
+
+    static bool Remove(const wxString &dir, int flags = 0);
+
+

 private:
     friend class wxDirData;
 
     wxDirData *m_data;
 
 private:
     friend class wxDirData;
 
     wxDirData *m_data;
 

-    DECLARE_NO_COPY_CLASS(wxDir)
+    wxDECLARE_NO_COPY_CLASS(wxDir);

 };
 
 #endif // _WX_DIR_H_
 };
 
 #endif // _WX_DIR_H_