X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7af3ca164537ce06c7df5f9923a53a0d82e21cd0..9e967d5417d49764276cf121a32c35d5770b1332:/docs/latex/wx/dirtrav.tex diff --git a/docs/latex/wx/dirtrav.tex b/docs/latex/wx/dirtrav.tex index bf7ef9df13..eee84ce1c3 100644 --- a/docs/latex/wx/dirtrav.tex +++ b/docs/latex/wx/dirtrav.tex @@ -69,15 +69,12 @@ 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} @@ -88,4 +85,29 @@ 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}. +