X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6dbb903bb9410e2a2a977ad349ba7b4b3b12ac78..a84ece11fffdde5d1bbd254ba58ac3cee79c2e77:/docs/latex/wx/filename.tex diff --git a/docs/latex/wx/filename.tex b/docs/latex/wx/filename.tex index 2e2b4ce538..3c0459e648 100644 --- a/docs/latex/wx/filename.tex +++ b/docs/latex/wx/filename.tex @@ -94,8 +94,7 @@ does. Other functions returning information about the file format provided by this class are \helpref{GetVolumeSeparator}{wxfilenamegetvolumeseparator},\rtfsp -\helpref{IsPathSeparator}{wxfilenameispathseparator} and\rtfsp -\helpref{IsWild}{wxfilenameiswild}. +\helpref{IsPathSeparator}{wxfilenameispathseparator}. \helpref{IsRelative}{wxfilenameisrelative} @@ -375,17 +374,45 @@ convenience wrapper: get just the last mod time of the file \membersection{wxFileName::GetPath}\label{wxfilenamegetpath} -\constfunc{wxString}{GetPath}{\param{bool }{add\_separator = FALSE}, \param{wxPathFormat }{format = wxPATH\_NATIVE}} +\constfunc{wxString}{GetPath}{\param{int }{flags = $0$}, \param{wxPathFormat }{format = wxPATH\_NATIVE}} -Construct path only - possibly with the trailing separator +Return the path part of the filename (without the name nor extension). The +possible flags values are: +\twocolwidtha{5cm}% +\begin{twocollist}\itemsep=0pt +\twocolitem{\tt wxPATH\_GET\_VOLUME}{Return the path with the volume (does +nothing for the filename formats without volumes)} +\twocolitem{\tt wxPATH\_GET\_SEPARATOR}{Return the path with the trailing +separator, if this flag is not given there will be no separator at the end of +the path.} +\end{twocollist} + +\membersection{wxFileName::GetPathSeparator}\label{wxfilenamegetpathseparator} + +\func{wxChar}{GetPathSeparator}{\param{wxPathFormat }{format = wxPATH\_NATIVE}} + +Return the usually used path separator for this format. For all formats but +{\tt wxPATH\_DOS} there is only one path separator anyhow, but for DOS there +are two of them and the native one, i.e. the backslash is returned by this +method. + +\wxheading{See also} + +\helpref{GetPathSeparators}{wxfilenamegetpathseparators} \membersection{wxFileName::GetPathSeparators}\label{wxfilenamegetpathseparators} \func{wxString}{GetPathSeparators}{\param{wxPathFormat }{format = wxPATH\_NATIVE}} -get the string of path separators for this format +Get the string containing all the path separators for this format. For all +formats but {\tt wxPATH\_DOS} this string contains only one character but for +DOS and Windows both {\tt '/'} and {\tt '\backslash'} may be used as +separators. + +\wxheading{See also} +\helpref{GetPathSeparator}{wxfilenamegetpathseparator} \membersection{wxFileName::GetPathWithSep}\label{wxfilenamegetpathwithsep} @@ -477,11 +504,15 @@ Returns {\tt TRUE} if the char is a path separator for this format. Returns {\tt TRUE} if this filename is not absolute. -\membersection{wxFileName::IsWild}\label{wxfilenameiswild} +\membersection{wxFileName::IsDir}\label{wxfilenameisdir} -\func{bool}{IsWild}{\param{wxPathFormat }{format = wxPATH\_NATIVE}} +\constfunc{bool}{IsDir}{\void} -FIXME: what exactly does this do? +Returns {\tt TRUE} if this object represents a directory, {\tt FALSE} otherwise +(i.e. if it is a file). Note that this method doesn't test whether the +directory or file really exists, you should use +\helpref{DirExists}{wxfilenamedirexists} or +\helpref{FileExists}{wxfilenamefileexists} for this. \membersection{wxFileName::MakeRelativeTo}\label{wxfilenamemakerelativeto} @@ -508,15 +539,17 @@ different from the volume specified by {\it pathBase}). \membersection{wxFileName::Mkdir}\label{wxfilenamemkdir} -\func{bool}{Mkdir}{\param{int }{perm = 0777}, \param{bool }{full = FALSE}} +\func{bool}{Mkdir}{\param{int }{perm = 0777}, \param{int }{flags = $0$}} -\func{static bool}{Mkdir}{\param{const wxString\& }{dir}, \param{int }{perm = 0777}, \param{bool }{full = FALSE}} +\func{static bool}{Mkdir}{\param{const wxString\& }{dir}, \param{int }{perm = 0777}, \param{int }{flags = $0$}} \docparam{dir}{the directory to create} \docparam{parm}{the permissions for the newly created directory} -\docparam{full}{if {\tt TRUE}, will try to make each directory in the path} +\docparam{flags}{if the flags contain {\tt wxPATH\_MKDIR\_FULL} flag, +try to create each directory in the path and also don't return an error +if the target directory already exists.} \wxheading{Return value}