X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f3845e889c7ccfe03d034a0aa79b4f4d19fbcb06..cba1c2ca127cbc8ce1aeb87b13b968caff0f995e:/docs/latex/wx/dirtrav.tex diff --git a/docs/latex/wx/dirtrav.tex b/docs/latex/wx/dirtrav.tex index 6def4ad3c8..f8fbbee806 100644 --- a/docs/latex/wx/dirtrav.tex +++ b/docs/latex/wx/dirtrav.tex @@ -71,21 +71,36 @@ 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}} +\func{virtual wxDirTraverseResult}{OnFile}{\param{const wxString\& }{filename}} 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}.