added wxMenu::AppendSubMenu() to avoid having to specify a dummy id when adding a...

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

diff --git a/include/wx/dir.h b/include/wx/dir.h
index 9c652c91ac3f1df9fe62a5c412a113bccec48a36..c87b753f6d39be2084253ccac0f01d2aaabb87ae 100644 (file)
--- a/include/wx/dir.h
+++ b/include/wx/dir.h
@@ -6,19 +6,15 @@
 // Created:     08.12.99
 // RCS-ID:      $Id$
 // Copyright:   (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 // 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_
 
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_DIR_H_
 #define _WX_DIR_H_
 

-#ifdef __GNUG__
-    #pragma interface "dir.h"
-#endif
+#include "wx/string.h"

 
 

-#ifndef WX_PRECOMP
-    #include  "wx/string.h"
-#endif
+class WXDLLIMPEXP_BASE wxArrayString;

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


@@ -49,27 +45,41 @@ enum wxDirTraverseResult
 // wxDirTraverser: helper class for wxDir::Traverse()
 // ----------------------------------------------------------------------------
 
 // wxDirTraverser: helper class for wxDir::Traverse()
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxDirTraverser
+class WXDLLIMPEXP_BASE wxDirTraverser

 {
 public:
 {
 public:

+    /// a virtual dtor has been provided since this class has virtual members
+    virtual ~wxDirTraverser() { }

     // called for each file found by wxDir::Traverse()
     //
     // 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;
     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
 // ----------------------------------------------------------------------------
 
 };
 
 // ----------------------------------------------------------------------------
 // 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
 {
 public:
     // test for existence of a directory with the given name


@@ -90,7 +100,7 @@ public:
     // open the directory for enumerating
     bool Open(const wxString& dir);
 
     // open the directory for enumerating
     bool Open(const wxString& dir);
 

-    // returns TRUE if the directory was successfully opened
+    // returns true if the directory was successfully opened

     bool IsOpened() const;
 
     // get the full name of the directory (without '/' at the end)
     bool IsOpened() const;
 
     // get the full name of the directory (without '/' at the end)


@@ -100,7 +110,7 @@ public:
     // -------------------------
 
     // start enumerating all files matching filespec (or all files if it is
     // -------------------------
 
     // start enumerating all files matching filespec (or all files if it is

-    // empty) and flags, return TRUE on success
+    // empty) and flags, return true on success

     bool GetFirst(wxString *filename,
                   const wxString& filespec = wxEmptyString,
                   int flags = wxDIR_DEFAULT) const;
     bool GetFirst(wxString *filename,
                   const wxString& filespec = wxEmptyString,
                   int flags = wxDIR_DEFAULT) const;


@@ -129,9 +139,12 @@ public:
                               int flags = wxDIR_DEFAULT);
 
 private:
                               int flags = wxDIR_DEFAULT);
 
 private:

-    friend class WXDLLEXPORT wxDirData;
+    friend class wxDirData;

 
     wxDirData *m_data;
 
     wxDirData *m_data;

+
+    DECLARE_NO_COPY_CLASS(wxDir)

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

+