renamed HasFocus() to IsActive() to avoid confusion with FindFocus(); documented...

[wxWidgets.git] / docs / latex / wx / dirtrav.tex

diff --git a/docs/latex/wx/dirtrav.tex b/docs/latex/wx/dirtrav.tex
index bf7ef9df1368dc392151668a13f3885b041da1c7..aaeac23c7ae09cfb7e9132914254c2835fb64e0e 100644 (file)
--- a/docs/latex/wx/dirtrav.tex
+++ b/docs/latex/wx/dirtrav.tex
@@ -6,7 +6,7 @@
 %% Created:     14.01.02 (extracted from dir.tex)
 %% RCS-ID:      $Id$
 %% Copyright:   (c) Vadim Zeitlin
 %% Created:     14.01.02 (extracted from dir.tex)
 %% RCS-ID:      $Id$
 %% Copyright:   (c) Vadim Zeitlin

-%% License:     wxWindows license
+%% License:     wxWidgets license

 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxDirTraverser}}\label{wxdirtraverser}
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxDirTraverser}}\label{wxdirtraverser}


@@ -71,6 +71,17 @@ enum wxDirTraverseResult
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \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}}
 \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.
 
 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}.