X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f3845e889c7ccfe03d034a0aa79b4f4d19fbcb06..c266eff98c5e44012647f54f38a1e29ecabd8759:/docs/latex/wx/dirtrav.tex diff --git a/docs/latex/wx/dirtrav.tex b/docs/latex/wx/dirtrav.tex index 6def4ad3c8..eee84ce1c3 100644 --- a/docs/latex/wx/dirtrav.tex +++ b/docs/latex/wx/dirtrav.tex @@ -69,23 +69,45 @@ enum wxDirTraverseResult -\latexignore{\rtfignore{\wxheading{Members}}} +\wxheading{Library} -\membersection{wxDirTraverser::OnFile}\label{wxdirtraverseronfile} +\helpref{wxBase}{librarieslist} -\func{virtual wxDirTraverseResult}{OnFile}{\param{const wxString& }{filename}} +\latexignore{\rtfignore{\wxheading{Members}}} -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} -\func{virtual wxDirTraverseResult}{OnDir}{\param{const wxString& }{dirname}} +\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}} + +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. + +This is a pure virtual function and must be implemented in the derived class. + + +\membersection{wxDirTraverser::OnOpenError}\label{wxopenerrortraverseronopenerror} + +\func{virtual wxDirTraverseResult}{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}. +