]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/dirtrav.tex
wxDataViewCtrl DnD stubs, some reformating
[wxWidgets.git] / docs / latex / wx / dirtrav.tex
index bf7ef9df1368dc392151668a13f3885b041da1c7..eee84ce1c31b3b6bac1cb20b7891ee1968ea7286 100644 (file)
@@ -69,15 +69,12 @@ enum wxDirTraverseResult
 
 <wx/dir.h>
 
-\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}.
+