X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fc2171bd4c660b8554dae2a1cbf34ff09f3032a6..852b6c3ce7baa055da25f5254f6ee2eee0cd79b7:/docs/latex/wx/dir.tex diff --git a/docs/latex/wx/dir.tex b/docs/latex/wx/dir.tex index d92f7e95f7..ed5c9d44bf 100644 --- a/docs/latex/wx/dir.tex +++ b/docs/latex/wx/dir.tex @@ -6,14 +6,14 @@ %% Created: 04.04.00 %% RCS-ID: $Id$ %% Copyright: (c) Vadim Zeitlin -%% License: wxWidgets license +%% License: wxWindows license %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \section{\class{wxDir}}\label{wxdir} wxDir is a portable equivalent of Unix {open/read/close}dir functions which -allow enumerating of the files in a directory. wxDir allows enumerate files as -well as directories. +allow enumerating of the files in a directory. wxDir allows to enumerate files +as well as directories. wxDir also provides a flexible way to enumerate files recursively using \helpref{Traverse}{wxdirtraverse} or a simpler @@ -106,7 +106,7 @@ Test for existence of a directory with the given name \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 +to the array {\it files} (note that its old content is preserved). Only files matching the {\it filespec} are taken, with empty spec matching all the files. The {\it flags} parameter should always include {\tt wxDIR\_FILES} or the array @@ -136,8 +136,8 @@ trailing path separator (slash or backslash). \constfunc{bool}{GetNext}{\param{wxString* }{filename}} -Continue enumerating files satisfying the criteria specified by the last call -to \helpref{GetFirst}{wxdirgetfirst}. +Continue enumerating files which satisfy the criteria specified by the last +call to \helpref{GetFirst}{wxdirgetfirst}. \membersection{wxDir::HasFiles}\label{wxdirhasfiles} @@ -170,8 +170,8 @@ Returns true if the directory was successfully opened by a previous call to \func{bool}{Open}{\param{const wxString\& }{dir}} -Open the directory for enumerating, returns true on success or false if an -error occurred. +Open the directory for enumerating, returns {\tt true} on success +or {\tt false} if an error occurred. \membersection{wxDir::Traverse}\label{wxdirtraverse}