Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

documented return value of Find[Absolute]ValidPath() correctly

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@28087 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2004-06-29 07:53:03 +00:00
parent fc447c7f43
commit 4d01e350fe
1 changed files with 14 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/latex/wx/pathlist.tex
View File

@@ -24,12 +24,14 @@ from the path.
\latexignore{\rtfignore{\wxheading{Members}}} \latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxPathList::wxPathList} \membersection{wxPathList::wxPathList}
\func{}{wxPathList}{\void} \func{}{wxPathList}{\void}
Constructor. Constructor.
\membersection{wxPathList::AddEnvList} \membersection{wxPathList::AddEnvList}
\func{void}{AddEnvList}{\param{const wxString\& }{env\_variable}} \func{void}{AddEnvList}{\param{const wxString\& }{env\_variable}}
@@ -38,13 +40,15 @@ 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 to the path list. Useful for finding files in the PATH variable, for
example. example.
\membersection{wxPathList::Add} \membersection{wxPathList::Add}
\func{void}{Add}{\param{const wxString\& }{path}} \func{void}{Add}{\param{const wxString\& }{path}}
Adds the given directory to the path list, but does not Adds the given directory to the path list, but does not
check if the path was already on the list (use wxPathList::Member) check if the path was already on the list (use
for this). \helpref{wxPathList::Member()}{wxpathlistmember} for this).
\membersection{wxPathList::EnsureFileAccessible} \membersection{wxPathList::EnsureFileAccessible}
@@ -54,24 +58,26 @@ 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 can be accessed using the pathlist. It does this by stripping the
filename and adding the path to the list if not already there. filename and adding the path to the list if not already there.
\membersection{wxPathList::FindAbsoluteValidPath} \membersection{wxPathList::FindAbsoluteValidPath}
\func{wxString}{FindAbsoluteValidPath}{\param{const wxString\& }{file}} \func{wxString}{FindAbsoluteValidPath}{\param{const wxString\& }{file}}
Searches for a full path for an existing file by appending {\it file} to 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 successive members of the path list. If the file wasn't found, an empty
pointer to the absolute path is returned. string is returned.
\membersection{wxPathList::FindValidPath} \membersection{wxPathList::FindValidPath}
\func{wxString}{FindValidPath}{\param{const wxString\& }{file}} \func{wxString}{FindValidPath}{\param{const wxString\& }{file}}
Searches for a full path for an existing file by appending {\it file} to 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 successive members of the path list. If the file wasn't found, an empty string
pointer to the full path is returned. This path may be relative to the current is returned. This path may be relative to the current working directory.
working directory.
\membersection{wxPathList::Member}
\membersection{wxPathList::Member}\label{wxpathlistmember}
\func{bool}{Member}{\param{const wxString\& }{file}} \func{bool}{Member}{\param{const wxString\& }{file}}