X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7af3ca164537ce06c7df5f9923a53a0d82e21cd0..9c72cf7619064969b5c7f59cece74013789db4cf:/docs/latex/wx/dirtrav.tex

diff --git a/docs/latex/wx/dirtrav.tex b/docs/latex/wx/dirtrav.tex
index bf7ef9df13..f8fbbee806 100644
--- a/docs/latex/wx/dirtrav.tex
+++ b/docs/latex/wx/dirtrav.tex
@@ -71,6 +71,17 @@ enum wxDirTraverseResult
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
+\membersection{wxDirTraverser::OnDir}\label{wxdirtraverserondir}
+
+\func{virtual wxDirTraverseResult}{OnDir}{\param{const wxString\& }{dirname}}
+
+This function is called for each directory. It may return {\tt wxSIR\_STOP} 
+to abort traversing completely, {\tt wxDIR\_IGNORE} to skip this directory but
+continue with others or {\tt 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.
+
 \membersection{wxDirTraverser::OnFile}\label{wxdirtraverseronfile}
 
 \func{virtual wxDirTraverseResult}{OnFile}{\param{const wxString\& }{filename}}
@@ -79,13 +90,17 @@ This function is called for each file. It may return {\tt wxDIR\_STOP} to abort
 traversing (for example, if the file being searched is found) or 
 {\tt wxDIR\_CONTINUE} to proceed.
 
-\membersection{wxDirTraverser::OnDir}\label{wxdirtraverserondir}
+This is a pure virtual function and must be implemented in the derived class.
 
-\func{virtual wxDirTraverseResult}{OnDir}{\param{const wxString\& }{dirname}}
+\membersection{wxOpenErrorTraverser::OnOpenError}\label{wxopenerrortraverseronopenerror}
 
-This function is called for each directory. It may return {\tt wxSIR\_STOP} 
-to abort traversing completely, {\tt wxDIR\_IGNORE} to skip this directory but
-continue with others or {\tt wxDIR\_CONTINUE} to enumerate all files and
-subdirectories in this directory.
+\func{virtual wxOpenErrorTraverseResult}{OnOpenError}{\param{const wxString\& }{openerrorname}}
+
+This function is called for each directory which we failed to open for
+enumerating. It may return {\tt wxSIR\_STOP} to abort traversing completely,
+{\tt wxDIR\_IGNORE} to skip this directory but continue with others or 
+{\tt wxDIR\_CONTINUE} to retry opening this directory once again.
+
+The base class version always returns {\tt wxDIR\_IGNORE}.