X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/93ab511d108444758e8ec7b268c95278b590bdfe..c65650d7b5472d00da0a0516ff1a2ccf53746319:/docs/latex/wx/filename.tex?ds=sidebyside diff --git a/docs/latex/wx/filename.tex b/docs/latex/wx/filename.tex index 6a79a412d5..deef7473ff 100644 --- a/docs/latex/wx/filename.tex +++ b/docs/latex/wx/filename.tex @@ -56,7 +56,7 @@ enum wxPathFormat \latexignore{\rtfignore{\wxheading{Function groups}}} -\membersection{File name format} +\membersection{File name format}\label{filenameformat} wxFileName currently supports the file names in the Unix, DOS/Windows, Mac OS and VMS formats. Although these formats are quite different, wxFileName tries @@ -88,12 +88,12 @@ class are \helpref{GetVolumeSeparator}{wxfilenamegetvolumeseparator},\rtfsp \helpref{IsRelative}{wxfilenameisrelative} -\membersection{File name construction} +\membersection{File name construction}\label{filenameconstruction} TODO. -\membersection{File tests} +\membersection{File tests}\label{filetests} Before doing the other tests you should use \helpref{IsOk}{wxfilenameisok} to verify that the filename is well defined. If it is, @@ -105,7 +105,7 @@ File names should be compared using \helpref{SameAs}{wxfilenamesameas} method or \helpref{$==$}{wxfilenameoperatorequal}. -\membersection{File name components} +\membersection{File name components}\label{filenamecomponents} These functions allow to examine and modify the directories of the path: @@ -129,7 +129,7 @@ following functions: \helpref{SetVolume}{wxfilenamesetvolume}\\ -\membersection{Operations} +\membersection{Operations}\label{filenameoperations} These methods allow to work with the file creation, access and modification times. Note that not all filesystems under all platforms implement these times @@ -460,6 +460,15 @@ separators. \helpref{GetPathSeparator}{wxfilenamegetpathseparator} +\membersection{wxFileName::GetPathTerminators}\label{wxfilenamegetpathterminators} + +\func{static wxString}{GetPathTerminators}{\param{wxPathFormat }{format = wxPATH\_NATIVE}} + +Returns the string of characters which may terminate the path part. This is the +same as \helpref{GetPathSeparators}{wxfilenamegetpathseparators} except for VMS +path format where $]$ is used at the end of the path part. + + \membersection{wxFileName::GetShortPath}\label{wxfilenamegetshortpath} \constfunc{wxString}{GetShortPath}{\void} @@ -491,7 +500,7 @@ needed. \constfunc{wxString}{GetVolume}{\void} -Returns the string containing the volume for this file name, mepty if it +Returns the string containing the volume for this file name, empty if it doesn't have one or if the file system doesn't support volumes at all (for example, Unix). @@ -763,6 +772,18 @@ component is. The old contents of the strings pointed to by these parameters will be overwritten in any case (if the pointers are not {\tt NULL}). +\membersection{wxFileName::SplitVolume}\label{wxfilenamesplitvolume} + +\func{static void}{SplitVolume}{\param{const wxString\& }{fullpath}, \param{wxString* }{volume}, \param{wxString* }{path}, \param{wxPathFormat }{format = wxPATH\_NATIVE}} + +Splits the given \arg{fullpath} into the volume part (which may be empty) and +the pure path part, not containing any volume. + +\wxheading{See also} + +\helpref{SplitPath}{wxfilenamesplitpath} + + \membersection{wxFileName::Touch}\label{wxfilenametouch} \func{bool}{Touch}{\void}