/////////////////////////////////////////////////////////////////////////////
// Name: dir.h
-// Purpose: documentation for wxDirTraverser class
+// Purpose: interface of wxDirTraverser
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
{
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.
/**
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.
};
+
/**
@class wxDir
@wxheader{dir.h}
*/
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).
*/
- wxString GetName();
+ wxString GetName() const;
/**
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
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);
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
const wxString& filespec = wxEmptyString,
int flags = wxDIR_DEFAULT);
};
+