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

added wxFileName::MakeRelativeTo() and the tests/docs for it

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@12861 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2001-12-04 15:13:56 +00:00
parent c942560f94
commit f7d886af3a
4 changed files with 124 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
docs/latex/wx/filename.tex
View File

@@ -87,7 +87,10 @@ File names can be case-sensitive or not, the function\rtfsp
The rules for determining if the file name is absolute or relative also depends
on the file name format and the only portable way to answer to this question is
to use \helpref{IsAbsolute}{wxfilenameisabsolute} method. To ensure that the
filename is absolute you may use \helpref{Normalize}{wxfilenamenormalize}.
filename is absolute you may use \helpref{Normalize}{wxfilenamenormalize}. There
is also an inverse function \helpref{MakeRelativeTo}{wxfilenamemakerelativeto}
which undoes what \helpref{Normalize(wxPATH\_NORM\_DOTS}{wxfilenamenormalize}
does.
Other functions returning information about the file format provided by this
class are \helpref{GetVolumeSeparator}{wxfilenamegetvolumeseparator},\rtfsp
@@ -451,15 +454,13 @@ invalid state (the former only do it on failure).
\func{bool}{IsPathSeparator}{\param{wxChar }{ch}, \param{wxPathFormat }{format = wxPATH\_NATIVE}}
is the char a path separator for this format?
Returns {\tt TRUE} if the char is a path separator for this format.
\membersection{wxFileName::IsRelative}\label{wxfilenameisrelative}
\func{bool}{IsRelative}{\param{wxPathFormat }{format = wxPATH\_NATIVE}}
is this filename relative?
Returns {\tt TRUE} if this filename is not absolute.
\membersection{wxFileName::IsWild}\label{wxfilenameiswild}
@@ -467,6 +468,28 @@ is this filename relative?
FIXME: what exactly does this do?
\membersection{wxFileName::MakeRelativeTo}\label{wxfilenamemakerelativeto}
\func{bool}{MakeRelativeTo}{\param{const wxString\& }{pathBase = ""}, \param{wxPathFormat }{format = wxPATH\_NATIVE}}
This function tries to put this file name in a form relative to {\it pathBase}.
In other words, it returns the file name which should be used to access this
file if the current directory were {\it pathBase}.
\docparam{pathBase}{the directory to use as root, current directory is used by
default}
\docparam{format}{the file name format, native by default}
\wxheading{Return value}
{\tt TRUE} if the file name has been changed, {\tt FALSE} if we failed to do
anything with it (currently this only happens if the file name is on a volume
different from the volume specified by {\it pathBase}).
\wxheading{See also}
\helpref{Normalize}{wxfilenamenormalize}
\membersection{wxFileName::Mkdir}\label{wxfilenamemkdir}