]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/dir.tex
unified default values for conv arguments
[wxWidgets.git] / docs / latex / wx / dir.tex
index bc33378d334b371dfa5e4c3b6dbacaf60801f14e..48c550fccf118fa70018dfaffcb4a22734bf781f 100644 (file)
@@ -95,21 +95,21 @@ to test for errors.
 
 \func{}{\destruct{wxDir}}{\void}
 
-Destructor cleans up the associated ressources. It is not virtual and so this
+Destructor cleans up the associated resources. It is not virtual and so this
 class is not meant to be used polymorphically.
 
 \membersection{wxDir::Open}\label{wxdiropen}
 
 \func{bool}{Open}{\param{const wxString\& }{dir}}
 
-Open the directory for enumerating, returns TRUE on success or FALSE if an
+Open the directory for enumerating, returns true on success or false if an
 error occurred.
 
 \membersection{wxDir::IsOpened}\label{wxdirisopened}
 
 \constfunc{bool}{IsOpened}{\void}
 
-Returns TRUE if the directory was successfully opened by a previous call to 
+Returns true if the directory was successfully opened by a previous call to 
 \helpref{Open}{wxdiropen}.
 
 \membersection{wxDir::GetFirst}\label{wxdirgetfirst}
@@ -117,7 +117,7 @@ Returns TRUE if the directory was successfully opened by a previous call to
 \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 flags, return true on success.
 
 \membersection{wxDir::GetNext}\label{wxdirgetnext}
 
@@ -128,23 +128,23 @@ to \helpref{GetFirst}{wxdirgetfirst}.
 
 \membersection{wxDir::HasFiles}\label{wxdirhasfiles}
 
-\func{bool}{HasFiles}{\param{const wxString& }{filespec = wxEmptyString}}
+\func{bool}{HasFiles}{\param{const wxString\& }{filespec = wxEmptyString}}
 
-Returns {\tt TRUE} if the directory contains any files matching the given 
+Returns {\tt true} if the directory contains any files matching the given 
 {\it filespec}. If {\it filespec} is empty, look for any files at all. In any
 case, even hidden files are taken into account.
 
 \membersection{wxDir::HasSubDirs}\label{wxdirhassubdirs}
 
-\func{bool}{HasSubDirs}{\param{const wxString& }{dirspec = wxEmptyString}}
+\func{bool}{HasSubDirs}{\param{const wxString\& }{dirspec = wxEmptyString}}
 
-Returns {\tt TRUE} if the directory contains any subdirectories (if a non
+Returns {\tt true} if the directory contains any subdirectories (if a non
 empty {\it filespec} is given, only check for directories matching it).
 The hidden subdirectories are taken into account as well.
 
 \membersection{wxDir::Traverse}\label{wxdirtraverse}
 
-\func{size\_t}{Traverse}{\param{wxDirTraverser& }{sink}, \param{const wxString& }{filespec = wxEmptyString}, \param{int }{flags = wxDIR\_DEFAULT}}
+\func{size\_t}{Traverse}{\param{wxDirTraverser\& }{sink}, \param{const wxString\& }{filespec = wxEmptyString}, \param{int }{flags = wxDIR\_DEFAULT}}
 
 Enumerate all files and directories under the given directory recursively
 calling the element of the provided \helpref{wxDirTraverser}{wxdirtraverser} 
@@ -166,7 +166,7 @@ See also: \helpref{GetAllFiles}{wxdirgetallfiles}
 
 \membersection{wxDir::GetAllFiles}\label{wxdirgetallfiles}
 
-\func{static size\_t}{GetAllFiles}{\param{const wxString& }{dirname}, \param{wxArrayString *}{files}, \param{const wxString& }{filespec = wxEmptyString}, \param{int }{flags = wxDIR\_DEFAULT}}
+\func{static size\_t}{GetAllFiles}{\param{const wxString\& }{dirname}, \param{wxArrayString *}{files}, \param{const wxString\& }{filespec = wxEmptyString}, \param{int }{flags = wxDIR\_DEFAULT}}
 
 The function appends the names of all the files under directory {\it dirname} 
 to the array {\it files} (note that its old contents is preserved). Only files