wxMemoryDC constructor now optionally accepts a wxBitmap parameter,

[wxWidgets.git] / docs / latex / wx / pathlist.tex

diff --git a/docs/latex/wx/pathlist.tex b/docs/latex/wx/pathlist.tex
index 6f04950e111156f524b90d03084f39db2c28d636..e1e90aa3fd067f4269ebcca42848792afd6d6409 100644 (file)
--- a/docs/latex/wx/pathlist.tex
+++ b/docs/latex/wx/pathlist.tex
@@ -6,13 +6,12 @@ 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}
 
@@ -20,19 +19,23 @@ from the path.
 
 \wxheading{See also}
 
-\helpref{wxList}{wxlist}
+\helpref{wxArrayString}{wxarraystring}, \helpref{wxStandardPaths}{wxstandardpaths}, \helpref{wxFileName}{wxfilename}
 
 \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}}
 
@@ -41,16 +44,24 @@ 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 
-\helpref{wxPathList::Member()}{wxpathlistmember} for this).
+\func{void}{Add}{\param{const wxArrayString\& }{arr}}
+
+The first form adds the given directory to the path list, if the path is not already in the list.
+The second form just calls the first form on all elements of the given array.
+
+The {\it path} is always considered a directory but no existence checks will be done on it
+(because if it doesn't exist, it could be created later and thus result a valid path when
+\helpref{FindValidPath}{wxpathlistfindvalidpath} is called).
 
+{\bf Note:} if the given path is relative, it won't be made absolute before adding it
+(this is why \helpref{FindValidPath}{wxpathlistfindvalidpath} may return relative paths).
 
-\membersection{wxPathList::EnsureFileAccessible}
+
+\membersection{wxPathList::EnsureFileAccessible}\label{wxpathlistensurefileaccessible}
 
 \func{void}{EnsureFileAccessible}{\param{const wxString\& }{filename}}
 
@@ -59,27 +70,27 @@ 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}
+\membersection{wxPathList::FindAbsoluteValidPath}\label{wxpathlistfindabsolutepath}
 
-\func{wxString}{FindAbsoluteValidPath}{\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
+Searches for a full (i.e. absolute) 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.
 
 
-\membersection{wxPathList::FindValidPath}
-
-\func{wxString}{FindValidPath}{\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 wasn't found, an empty string
-is returned. This path may be relative to the current working directory.
+\membersection{wxPathList::FindValidPath}\label{wxpathlistfindvalidpath}
 
+\constfunc{wxString}{FindValidPath}{\param{const wxString\& }{file}}
 
-\membersection{wxPathList::Member}\label{wxpathlistmember}
+Searches for a 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.
 
-\func{bool}{Member}{\param{const wxString\& }{file}}
+The returned path may be relative to the current working directory.
 
-true if the path is in the path list (ignoring case).
+The given string must be a file name, eventually with a path prefix (if the path
+prefix is absolute, only its name will be searched); i.e. it must not end with
+a directory separator (see \helpref{wxFileName::GetPathSeparator}{wxfilenamegetpathseparator})
+otherwise an assertion will fail.