Added periods

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

diff --git a/docs/latex/wx/dir.tex b/docs/latex/wx/dir.tex
index ed5c9d44bf03772236bc8347a6f1a4eb3ac0686f..890afeb6e9d76b0d379501baec327037d6e069ea 100644 (file)
--- a/docs/latex/wx/dir.tex
+++ b/docs/latex/wx/dir.tex
@@ -72,6 +72,10 @@ enum
 
 <wx/dir.h>
 
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxDir::wxDir}\label{wxdirwxdir}
@@ -116,12 +120,28 @@ subdirectories (both flags are included in the value by default).
 See also: \helpref{Traverse}{wxdirtraverse}
 
 
+\membersection{wxDir::FindFirst}\label{wxdirfindfirst}
+
+\func{static wxString}{FindFirst}{\param{const wxString\& }{dirname}, \param{const wxString\& }{filespec}, \param{int }{flags = wxDIR\_DEFAULT}}
+
+The function returns the path of the first file matching the given \arg{filespec}
+or an empty string if there are no files matching it.
+
+The \arg{flags} parameter may or may not include {\tt wxDIR\_FILES}, the
+function always behaves as if it were specified. By default, \arg{flags} 
+includes {\tt wxDIR\_DIRS} and so the function recurses into the subdirectories
+but if this flag is not specified, the function restricts the search only to
+the directory \arg{dirname} itself.
+
+See also: \helpref{Traverse}{wxdirtraverse}
+
+
 \membersection{wxDir::GetFirst}\label{wxdirgetfirst}
 
 \constfunc{bool}{GetFirst}{\param{wxString* }{filename}, \param{const wxString\& }{filespec = wxEmptyString}, \param{int }{flags = wxDIR\_DEFAULT}}
 
 Start enumerating all files matching {\it filespec} (or all files if it is
-empty) and flags, return true on success.
+empty) and {\it flags}, return \true on success.
 
 
 \membersection{wxDir::GetName}\label{wxdirgetname}
@@ -140,6 +160,25 @@ Continue enumerating files which satisfy the criteria specified by the last
 call to \helpref{GetFirst}{wxdirgetfirst}.
 
 
+\membersection{wxDir::GetTotalSize}\label{wxdirgettotalsize}
+
+\func{static wxULongLong}{GetTotalSize}{\param{const wxString\& }{dir}, \param{wxArrayString* }{filesSkipped = NULL}}
+
+Returns the size (in bytes) of all files recursively found in {\tt dir} or
+{\tt wxInvalidSize} in case of error.
+
+In case it happens that while traversing folders a file's size can not be read,
+that file is added to the {\tt filesSkipped} array, if not \NULL, and then
+skipped.
+This usually happens with some special folders which are locked by the operating system
+or by another process. Remember that when {\tt filesSkipped->GetCount()} is not zero,
+then the returned value is not 100\% accurate and, if the skipped files were big, it could be
+far from real size of the directory.
+
+See also: \helpref{wxFileName::GetHumanReadableSize}{wxfilenamegethumanreadablesize},
+\helpref{wxGetDiskSpace}{wxgetdiskspace}
+
+
 \membersection{wxDir::HasFiles}\label{wxdirhasfiles}
 
 \func{bool}{HasFiles}{\param{const wxString\& }{filespec = wxEmptyString}}