added GetName(), rearranged methods in alphabetic order

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@19702 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2003-03-22 13:42:16 +00:00
parent ac4eaadf80
commit 55427034af

View File

@@ -74,12 +74,6 @@ enum
\latexignore{\rtfignore{\wxheading{Members}}} \latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxDir::Exists}\label{wxdirexists}
\func{static bool}{Exists}{\param{const wxString\& }{dir}}
Test for existence of a directory with the given name
\membersection{wxDir::wxDir}\label{wxdirwxdir} \membersection{wxDir::wxDir}\label{wxdirwxdir}
\func{}{wxDir}{\void} \func{}{wxDir}{\void}
@@ -91,6 +85,7 @@ Default constructor, use \helpref{Open()}{wxdiropen} afterwards.
Opens the directory for enumeration, use \helpref{IsOpened()}{wxdirisopened} Opens the directory for enumeration, use \helpref{IsOpened()}{wxdirisopened}
to test for errors. to test for errors.
\membersection{wxDir::\destruct{wxDir}}\label{wxdirdtor} \membersection{wxDir::\destruct{wxDir}}\label{wxdirdtor}
\func{}{\destruct{wxDir}}{\void} \func{}{\destruct{wxDir}}{\void}
@@ -98,19 +93,28 @@ to test for errors.
Destructor cleans up the associated resources. 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. class is not meant to be used polymorphically.
\membersection{wxDir::Open}\label{wxdiropen}
\func{bool}{Open}{\param{const wxString\& }{dir}} \membersection{wxDir::Exists}\label{wxdirexists}
Open the directory for enumerating, returns true on success or false if an \func{static bool}{Exists}{\param{const wxString\& }{dir}}
error occurred.
\membersection{wxDir::IsOpened}\label{wxdirisopened} Test for existence of a directory with the given name
\constfunc{bool}{IsOpened}{\void}
Returns true if the directory was successfully opened by a previous call to \membersection{wxDir::GetAllFiles}\label{wxdirgetallfiles}
\helpref{Open}{wxdiropen}.
\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
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
would be unchanged and should include {\tt wxDIR\_DIRS} flag to recurse into
subdirectories (both flags are included in the value by default).
See also: \helpref{Traverse}{wxdirtraverse}
\membersection{wxDir::GetFirst}\label{wxdirgetfirst} \membersection{wxDir::GetFirst}\label{wxdirgetfirst}
@@ -119,6 +123,15 @@ Returns true if the directory was successfully opened by a previous call to
Start enumerating all files matching {\it filespec} (or all files if it is 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::GetName}\label{wxdirgetname}
\constfunc{wxString}{GetName}{\void}
Returns the name of the directory itself. The returned string does not have the
trailing path separator (slash or backslash).
\membersection{wxDir::GetNext}\label{wxdirgetnext} \membersection{wxDir::GetNext}\label{wxdirgetnext}
\constfunc{bool}{GetNext}{\param{wxString* }{filename}} \constfunc{bool}{GetNext}{\param{wxString* }{filename}}
@@ -126,6 +139,7 @@ empty) and flags, return true on success.
Continue enumerating files satisfying the criteria specified by the last call Continue enumerating files satisfying the criteria specified by the last call
to \helpref{GetFirst}{wxdirgetfirst}. to \helpref{GetFirst}{wxdirgetfirst}.
\membersection{wxDir::HasFiles}\label{wxdirhasfiles} \membersection{wxDir::HasFiles}\label{wxdirhasfiles}
\func{bool}{HasFiles}{\param{const wxString\& }{filespec = wxEmptyString}} \func{bool}{HasFiles}{\param{const wxString\& }{filespec = wxEmptyString}}
@@ -134,6 +148,7 @@ 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 {\it filespec}. If {\it filespec} is empty, look for any files at all. In any
case, even hidden files are taken into account. case, even hidden files are taken into account.
\membersection{wxDir::HasSubDirs}\label{wxdirhassubdirs} \membersection{wxDir::HasSubDirs}\label{wxdirhassubdirs}
\func{bool}{HasSubDirs}{\param{const wxString\& }{dirspec = wxEmptyString}} \func{bool}{HasSubDirs}{\param{const wxString\& }{dirspec = wxEmptyString}}
@@ -142,6 +157,23 @@ Returns {\tt true} if the directory contains any subdirectories (if a non
empty {\it filespec} is given, only check for directories matching it). empty {\it filespec} is given, only check for directories matching it).
The hidden subdirectories are taken into account as well. The hidden subdirectories are taken into account as well.
\membersection{wxDir::IsOpened}\label{wxdirisopened}
\constfunc{bool}{IsOpened}{\void}
Returns true if the directory was successfully opened by a previous call to
\helpref{Open}{wxdiropen}.
\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
error occurred.
\membersection{wxDir::Traverse}\label{wxdirtraverse} \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}}
@@ -164,17 +196,3 @@ error.
See also: \helpref{GetAllFiles}{wxdirgetallfiles} 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}}
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
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
would be unchanged and should include {\tt wxDIR\_DIRS} flag to recurse into
subdirectories (both flags are included in the value by default).
See also: \helpref{Traverse}{wxdirtraverse}