added convenient wxON_BLOCK_EXIT_THISn() macros wrapping wxON_BLOCK_EXIT_OBJn(*this)

[wxWidgets.git] / interface / dir.h

diff --git a/interface/dir.h b/interface/dir.h
index 5f7bd2000de3a42a7e1a277cf167e54d6743be53..cb9ca739175e89e4feb9fe08d6cc19e9d73f1ea1 100644 (file)
--- a/interface/dir.h
+++ b/interface/dir.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        dir.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        dir.h

-// Purpose:     documentation for wxDirTraverser class
+// Purpose:     interface of wxDirTraverser

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -51,7 +51,7 @@ class wxDirTraverser
 {
 public:
     /**
 {
 public:
     /**

-        This function is called for each directory. It may return @c wxSIR_STOP
+        This function is called for each directory. It may return @c wxDIR_STOP

         to abort traversing completely, @c wxDIR_IGNORE to skip this directory but
         continue with others or @c wxDIR_CONTINUE to enumerate all files and
         subdirectories in this directory.
         to abort traversing completely, @c wxDIR_IGNORE to skip this directory but
         continue with others or @c wxDIR_CONTINUE to enumerate all files and
         subdirectories in this directory.


@@ -69,7 +69,7 @@ public:
 
     /**
         This function is called for each directory which we failed to open for
 
     /**
         This function is called for each directory which we failed to open for

-        enumerating. It may return @c wxSIR_STOP to abort traversing completely,
+        enumerating. It may return @c wxDIR_STOP to abort traversing completely,

         @c wxDIR_IGNORE to skip this directory but continue with others or
         @c wxDIR_CONTINUE to retry opening this directory once again.
         The base class version always returns @c wxDIR_IGNORE.
         @c wxDIR_IGNORE to skip this directory but continue with others or
         @c wxDIR_CONTINUE to retry opening this directory once again.
         The base class version always returns @c wxDIR_IGNORE.


@@ -78,6 +78,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxDir
     @wxheader{dir.h}
 /**
     @class wxDir
     @wxheader{dir.h}


@@ -175,19 +176,19 @@ public:
     */
     bool GetFirst(wxString* filename,
                   const wxString& filespec = wxEmptyString,
     */
     bool GetFirst(wxString* filename,
                   const wxString& filespec = wxEmptyString,

-                  int flags = wxDIR_DEFAULT);
+                  int flags = wxDIR_DEFAULT) const;

 
     /**
         Returns the name of the directory itself. The returned string does not have the
         trailing path separator (slash or backslash).
     */
 
     /**
         Returns the name of the directory itself. The returned string does not have the
         trailing path separator (slash or backslash).
     */

-    wxString GetName();
+    wxString GetName() const;

 
     /**
         Continue enumerating files which satisfy the criteria specified by the last
         call to GetFirst().
     */
 
     /**
         Continue enumerating files which satisfy the criteria specified by the last
         call to GetFirst().
     */

-    bool GetNext(wxString* filename);
+    bool GetNext(wxString* filename) const;

 
     /**
         Returns the size (in bytes) of all files recursively found in @c dir or
 
     /**
         Returns the size (in bytes) of all files recursively found in @c dir or


@@ -203,7 +204,7 @@ public:
         big, it could be
         far from real size of the directory.
         See also: wxFileName::GetHumanReadableSize,
         big, it could be
         far from real size of the directory.
         See also: wxFileName::GetHumanReadableSize,

-        wxGetDiskSpace
+        wxGetDiskSpace()

     */
     static wxULongLong GetTotalSize(const wxString& dir,
                                     wxArrayString* filesSkipped = NULL);
     */
     static wxULongLong GetTotalSize(const wxString& dir,
                                     wxArrayString* filesSkipped = NULL);


@@ -226,7 +227,7 @@ public:
         Returns @true if the directory was successfully opened by a previous call to
         Open().
     */
         Returns @true if the directory was successfully opened by a previous call to
         Open().
     */

-    bool IsOpened();
+    bool IsOpened() const;

 
     /**
         Open the directory for enumerating, returns @true on success
 
     /**
         Open the directory for enumerating, returns @true on success


@@ -253,3 +254,4 @@ public:
                     const wxString& filespec = wxEmptyString,
                     int flags = wxDIR_DEFAULT);
 };
                     const wxString& filespec = wxEmptyString,
                     int flags = wxDIR_DEFAULT);
 };

+