added and documented wx_const/static_cast<>

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

diff --git a/include/wx/dir.h b/include/wx/dir.h
index 9c652c91ac3f1df9fe62a5c412a113bccec48a36..4a49f7c6bc9db6619efc6aa012482725ccb1b4e4 100644 (file)
--- a/include/wx/dir.h
+++ b/include/wx/dir.h
@@ -6,20 +6,22 @@
 // Created:     08.12.99
 // RCS-ID:      $Id$
 // Copyright:   (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_DIR_H_
 #define _WX_DIR_H_
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
     #pragma interface "dir.h"
 #endif
 
 #ifndef WX_PRECOMP
-    #include  "wx/string.h"
+    #include "wx/string.h"
 #endif
 
+class WXDLLIMPEXP_BASE wxArrayString;
+
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
@@ -49,27 +51,39 @@ enum wxDirTraverseResult
 // wxDirTraverser: helper class for wxDir::Traverse()
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxDirTraverser
+class WXDLLIMPEXP_BASE wxDirTraverser
 {
 public:
     // called for each file found by wxDir::Traverse()
     //
-    // return wxDIR_STOP or wxDIR_CONTINUE from here
+    // return wxDIR_STOP or wxDIR_CONTINUE from here (wxDIR_IGNORE doesn't
+    // make sense)
     virtual wxDirTraverseResult OnFile(const wxString& filename) = 0;
 
     // called for each directory found by wxDir::Traverse()
     //
     // return one of the enum elements defined above
     virtual wxDirTraverseResult OnDir(const wxString& dirname) = 0;
+
+    // called for each directory which we couldn't open during our traversal
+    // of the directory tyree
+    //
+    // this method can also return either wxDIR_STOP, wxDIR_IGNORE or
+    // wxDIR_CONTINUE but the latter is treated specially: it means to retry
+    // opening the directory and so may lead to infinite loop if it is
+    // returned unconditionally, be careful with this!
+    //
+    // the base class version always returns wxDIR_IGNORE
+    virtual wxDirTraverseResult OnOpenError(const wxString& dirname);
 };
 
 // ----------------------------------------------------------------------------
 // wxDir: portable equivalent of {open/read/close}dir functions
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxDirData;
+class WXDLLIMPEXP_BASE wxDirData;
 
-class WXDLLEXPORT wxDir
+class WXDLLIMPEXP_BASE wxDir
 {
 public:
     // test for existence of a directory with the given name
@@ -129,9 +143,12 @@ public:
                               int flags = wxDIR_DEFAULT);
 
 private:
-    friend class WXDLLEXPORT wxDirData;
+    friend class wxDirData;
 
     wxDirData *m_data;
+
+    DECLARE_NO_COPY_CLASS(wxDir)
 };
 
 #endif // _WX_DIR_H_
+