X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a660d684eda27638bca0384b2058911a31c8e845..dd7d379ebc6d8f86faff623e0378c0f12bcc9601:/docs/latex/wx/pathlist.tex

diff --git a/docs/latex/wx/pathlist.tex b/docs/latex/wx/pathlist.tex
index 8310d24e3f..b74547fea1 100644
--- a/docs/latex/wx/pathlist.tex
+++ b/docs/latex/wx/pathlist.tex
@@ -6,27 +6,36 @@ in those directories.  Storing the filename only in an application's files and
 using a locally-defined list of directories makes the application and its files more
 portable.
 
-Use the {\it wxFileNameFromPath} global function to extract the filename
-from the path.
+Use the \helpref{wxFileName::SplitPath}{wxfilenamesplitpath} global function 
+to extract the filename from the path.
 
 \wxheading{Derived from}
 
-\helpref{wxList}{wxlist}\\
-\helpref{wxObject}{wxobject}
+\helpref{wxArrayString}{wxarraystring}
+
+\wxheading{Include files}
+
+<wx/filefn.h>
 
 \wxheading{See also}
 
-\helpref{wxList}{wxlist}
+\helpref{wxArrayString}{wxarraystring}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxPathList::wxPathList}
+
+\membersection{wxPathList::wxPathList}\label{wxpathlistctor}
 
 \func{}{wxPathList}{\void}
 
-Constructor.
+Empty constructor.
+
+\func{}{wxPathList}{\param{const wxArrayString\& }{arr}}
 
-\membersection{wxPathList::AddEnvList}
+Constructs the object calling the \helpref{Add}{wxpathlistadd} function.
+
+
+\membersection{wxPathList::AddEnvList}\label{wxpathlistaddenvlist}
 
 \func{void}{AddEnvList}{\param{const wxString\& }{env\_variable}}
 
@@ -34,15 +43,20 @@ Finds the value of the given environment variable, and adds all paths
 to the path list. Useful for finding files in the PATH variable, for
 example.
 
-\membersection{wxPathList::Add}
+
+\membersection{wxPathList::Add}\label{wxpathlistadd}
 
 \func{void}{Add}{\param{const wxString\& }{path}}
 
-Adds the given directory to the path list, but does not
-check if the path was already on the list (use wxPathList::Member)
-for this).
+\func{void}{Add}{\param{const wxArrayString\& }{arr}}
+
+The first form adds the given directory (the filename if present is removed)
+to the path list, if the path is not already in the list.
 
-\membersection{wxPathList::EnsureFileAccessible}
+The second form just calls the first form on all elements of the given array.
+
+
+\membersection{wxPathList::EnsureFileAccessible}\label{wxpathlistensurefileaccessible}
 
 \func{void}{EnsureFileAccessible}{\param{const wxString\& }{filename}}
 
@@ -50,26 +64,21 @@ Given a full filename (with path), ensures that files in the same path
 can be accessed using the pathlist. It does this by stripping the
 filename and adding the path to the list if not already there.
 
-\membersection{wxPathList::FindAbsoluteValidPath}
 
-\func{wxString}{FindAbsoluteValidPath}{\param{const wxString\& }{file}}
-
-Searches for a full path for an existing file by appending {\it file} to
-successive members of the path list.  If the file exists, a temporary
-pointer to the absolute path is returned.
+\membersection{wxPathList::FindAbsoluteValidPath}\label{wxpathlistfindabsolutepath}
 
-\membersection{wxPathList::FindValidPath}
-
-\func{wxString}{FindValidPath}{\param{const wxString\& }{file}}
+\constfunc{wxString}{FindAbsoluteValidPath}{\param{const wxString\& }{file}}
 
 Searches for a full path for an existing file by appending {\it file} to
-successive members of the path list.  If the file exists, a temporary
-pointer to the full path is returned. This path may be relative to the current
-working directory.
+successive members of the path list.  If the file wasn't found, an empty
+string is returned.
+
 
-\membersection{wxPathList::Member}
+\membersection{wxPathList::FindValidPath}\label{wxpathlistfindvalidpath}
 
-\func{bool}{Member}{\param{const wxString\& }{file}}
+\constfunc{wxString}{FindValidPath}{\param{const wxString\& }{file}}
 
-TRUE if the path is in the path list (ignoring case).
+Searches for a full path for an existing file by appending {\it file} to
+successive members of the path list.  If the file wasn't found, an empty string
+is returned. This path may be relative to the current working directory.
 
