X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4d01e350fe2d8cb15c068d579c4022345f3ff0c0..b98bd6af23c1c73eb2cddf14da18455e5668de6d:/docs/latex/wx/pathlist.tex?ds=sidebyside diff --git a/docs/latex/wx/pathlist.tex b/docs/latex/wx/pathlist.tex index 6f04950e11..b74547fea1 100644 --- 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} \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,19 @@ 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 (the filename if present is removed) +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. -\membersection{wxPathList::EnsureFileAccessible} +\membersection{wxPathList::EnsureFileAccessible}\label{wxpathlistensurefileaccessible} \func{void}{EnsureFileAccessible}{\param{const wxString\& }{filename}} @@ -59,27 +65,20 @@ 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 successive members of the path list. If the file wasn't found, an empty string is returned. -\membersection{wxPathList::FindValidPath} +\membersection{wxPathList::FindValidPath}\label{wxpathlistfindvalidpath} -\func{wxString}{FindValidPath}{\param{const wxString\& }{file}} +\constfunc{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::Member}\label{wxpathlistmember} - -\func{bool}{Member}{\param{const wxString\& }{file}} - -true if the path is in the path list (ignoring case). -