X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/94f562a27908672661ad7720507bba0753ca3ac6..d7af2feac42c8b27a0823131dc2f4004c2472279:/docs/latex/wx/dir.tex?ds=sidebyside diff --git a/docs/latex/wx/dir.tex b/docs/latex/wx/dir.tex index cb9dca65d9..bc33378d33 100644 --- a/docs/latex/wx/dir.tex +++ b/docs/latex/wx/dir.tex @@ -126,6 +126,22 @@ empty) and flags, return TRUE on success. Continue enumerating files satisfying the criteria specified by the last call to \helpref{GetFirst}{wxdirgetfirst}. +\membersection{wxDir::HasFiles}\label{wxdirhasfiles} + +\func{bool}{HasFiles}{\param{const wxString& }{filespec = wxEmptyString}} + +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}} + +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}} @@ -146,9 +162,9 @@ Depending on the return value, the enumeration may continue or stop. The function returns the total number of files found or {\tt (size\_t)-1} on error. -See also: \helpref{GetAllFiles}\label{wxdirgetallfiles} +See also: \helpref{GetAllFiles}{wxdirgetallfiles} -\membersection{wxDir::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}} @@ -162,82 +178,3 @@ subdirectories (both flags are included in the value by default). See also: \helpref{Traverse}{wxdirtraverse} -\section{\class{wxDirTraverser}}\label{wxdirtraverser} - -wxDirTraverser is an abstract interface which must be implemented by objects -passed to \helpref{Traverse}{wxdirtraverse} function. - -Example of use (this works almost like \helpref{GetAllFiles}{wxdirgetallfiles}): - -\begin{verbatim} - class wxDirTraverserSimple : public wxDirTraverser - { - public: - wxDirTraverserSimple(wxArrayString& files) : m_files(files) { } - - virtual wxDirTraverseResult OnFile(const wxString& filename) - { - m_files.Add(filename); - return wxDIR_CONTINUE; - } - - virtual wxDirTraverseResult OnDir(const wxString& WXUNUSED(dirname)) - { - return wxDIR_CONTINUE; - } - - private: - wxArrayString& m_files; - }; - - // get the names of all files in the array - wxArrayString files; - wxDirTraverserSimple traverser(files); - - wxDir dir(dirname); - dir.Traverse(traverser); -\end{verbatim} - -\wxheading{Derived from} - -No base class - -\wxheading{Constants} - -The elements of {\tt wxDirTraverseResult} are the possible return values of the -callback functions: - -{\small -\begin{verbatim} -enum wxDirTraverseResult -{ - wxDIR_IGNORE = -1, // ignore this directory but continue with others - wxDIR_STOP, // stop traversing - wxDIR_CONTINUE // continue into this directory -}; -\end{verbatim} -} - -\wxheading{Include files} - - - -\latexignore{\rtfignore{\wxheading{Members}}} - -\membersection{wxDirTraverser::OnFile}\label{wxdirtraverseronfile} - -\func{virtual wxDirTraverseResult}{OnFile}{\param{const wxString& }{filename}} - -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. - -\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. -