X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ae3c17b4013e80b99976c750c19fca47729517f6..5b88a837ba75928cd3835a6b97ae2bf5ad983a6e:/interface/wx/dir.h diff --git a/interface/wx/dir.h b/interface/wx/dir.h index 82b40531ca..2a435bf818 100644 --- a/interface/wx/dir.h +++ b/interface/wx/dir.h @@ -18,7 +18,6 @@ enum wxDirTraverseResult /** @class wxDirTraverser - @wxheader{dir.h} wxDirTraverser is an abstract interface which must be implemented by objects passed to wxDir::Traverse() function. @@ -69,7 +68,7 @@ public: This is a pure virtual function and must be implemented in the derived class. */ - virtual wxDirTraverseResult OnDir(const wxString& dirname); + virtual wxDirTraverseResult OnDir(const wxString& dirname) = 0; /** This function is called for each file. It may return ::wxDIR_STOP to @@ -79,7 +78,7 @@ public: This is a pure virtual function and must be implemented in the derived class. */ - virtual wxDirTraverseResult OnFile(const wxString& filename); + virtual wxDirTraverseResult OnFile(const wxString& filename) = 0; /** This function is called for each directory which we failed to open for @@ -98,7 +97,7 @@ public: These flags define what kind of filenames are included in the list of files enumerated by wxDir::GetFirst() and wxDir::GetNext(). */ -enum +enum wxDirFlags { wxDIR_FILES = 0x0001, ///< Includes files. wxDIR_DIRS = 0x0002, ///< Includes directories. @@ -110,7 +109,6 @@ enum /** @class wxDir - @wxheader{dir.h} wxDir is a portable equivalent of Unix open/read/closedir functions which allow enumerating of the files in a directory. wxDir allows to enumerate @@ -179,6 +177,7 @@ public: includes ::wxDIR_DIRS and so the function recurses into the subdirectories but if this flag is not specified, the function restricts the search only to the directory @a dirname itself. + See ::wxDirFlags for the list of the possible flags. @see Traverse() */ @@ -195,6 +194,7 @@ public: The @a flags parameter should always include ::wxDIR_FILES or the array would be unchanged and should include ::wxDIR_DIRS flag to recurse into subdirectories (both flags are included in the value by default). + See ::wxDirFlags for the list of the possible flags. @see Traverse() */ @@ -205,6 +205,7 @@ public: /** Start enumerating all files matching @a filespec (or all files if it is empty) and @e flags, return @true on success. + See ::wxDirFlags for the list of the possible flags. */ bool GetFirst(wxString* filename, const wxString& filespec = wxEmptyString, @@ -274,6 +275,7 @@ public: @a flags contains ::wxDIR_DIRS flag. It will ignore the files (but still possibly recurse into subdirectories) if ::wxDIR_FILES flag is given. + See ::wxDirFlags for the list of the possible flags. For each found directory, @ref wxDirTraverser::OnDir() "sink.OnDir()" is called and @ref wxDirTraverser::OnFile() "sink.OnFile()" is called @@ -287,6 +289,6 @@ public: */ size_t Traverse(wxDirTraverser& sink, const wxString& filespec = wxEmptyString, - int flags = wxDIR_DEFAULT); + int flags = wxDIR_DEFAULT) const; };