.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxDirTraverser 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxDirTraverser \- 
  Class used together with wxDir for recursively enumerating the files/subdirectories
 
.SH DESCRIPTION

  


   wxDirTraverser is an abstract interface which must be implemented by objects
   passed to
   Traverse
   function.
  
  


   Example of use (this works almost like
   GetAllFiles
   ):
  
  


  
    class wxDirTraverserSimple : public wxDirTraverser
    {
    public:
        wxDirTraverserSimple(wxArrayString& files) : m_files(files) { }

        virtual wxDirTraverseResult OnFile(const wxString& filename)
        {
            m_files.Add(filename);
            return wxDIR_CONTINUE;
        }

        virtual wxDirTraverseResult OnDir(const wxString& WXUNUSED(dirname))
        {
            return wxDIR_CONTINUE;
        }

    private:
        wxArrayString& m_files;
    };

    // get the names of all files in the array
    wxArrayString files;
    wxDirTraverserSimple traverser(files);

    wxDir dir(dirname);
    dir.Traverse(traverser);

  


 
.SH "PARENTS"

.SH "INCLUDE FILES"
wx/dir.h
.SH MEMBERS

  
.SS virtual wxDirTraverseResult OnDir (const wxString& dirname)

     


      This function is called for each directory. It may return
      wxSIR_STOP
      to abort traversing completely,
      wxDIR_IGNORE
      to skip this directory but continue with others or
      wxDIR_CONTINUE
      to enumerate all files and subdirectories in this directory.
     
     


      This is a pure virtual function and must be implemented in the derived
      class.
     
    
   
  
.SS virtual wxDirTraverseResult OnFile (const wxString& filename)

     


      This function is called for each file. It may return
      wxDIR_STOP
      to abort traversing (for example, if the file being searched is found) or
      wxDIR_CONTINUE
      to proceed.
     
     


      This is a pure virtual function and must be implemented in the derived
      class.
     
    
   
  
.SS virtual wxOpenErrorTraverseResult OnOpenError (const wxString& openerrorname)

     


      This function is called for each directory which we failed to open for
      enumerating. It may return
      wxSIR_STOP
      to abort traversing completely,
      wxDIR_IGNORE
      to skip this directory but continue with others or
      wxDIR_CONTINUE
      to retry opening this directory once again.
     
     


      The base class version always returns
      wxDIR_IGNORE
      .
     
    
 
.SH "SEE ALSO"

.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.