X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/08890e275cae4fa8c5028df5d2b04bb4b0c07525..410bfc938346c4326f455631dd795e7d12cbc43e:/docs/latex/wx/filename.tex?ds=sidebyside diff --git a/docs/latex/wx/filename.tex b/docs/latex/wx/filename.tex index 0c0d22dc1e..16dc6935b2 100644 --- a/docs/latex/wx/filename.tex +++ b/docs/latex/wx/filename.tex @@ -73,20 +73,23 @@ state and \helpref{IsOk}{wxfilenameisok} returns {\tt false} for it. File names can be case-sensitive or not, the function\rtfsp \helpref{IsCaseSensitive}{wxfilenameiscasesensitive} allows to determine this. -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{MakeAbsolute}{wxfilenamemakeabsolute}. -There is also an inverse function -\helpref{MakeRelativeTo}{wxfilenamemakerelativeto} which undoes what -\helpref{Normalize(wxPATH\_NORM\_DOTS)}{wxfilenamenormalize} does. +The rules for determining whether the file name is absolute or relative also +depend on the file name format and the only portable way to answer this +question is to use \helpref{IsAbsolute}{wxfilenameisabsolute} or\rtfsp +\helpref{IsRelative}{wxfilenameisrelative} method. Note that on Windows, "X:" +refers to the current working directory on drive X. Therefore, a wxFileName +instance constructed from for example "X:dir/file.ext" treats the portion +beyond drive separator as being relative to that directory. + +To ensure that the filename is absolute, you may use\rtfsp +\helpref{MakeAbsolute}{wxfilenamemakeabsolute}. 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 \helpref{IsPathSeparator}{wxfilenameispathseparator}. -\helpref{IsRelative}{wxfilenameisrelative} - \membersection{File name construction}\label{filenameconstruction} @@ -95,11 +98,11 @@ TODO. \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, -\helpref{FileExists}{wxfilenamefileexists} can be used to test if a file with -such name exists and \helpref{DirExists}{wxfilenamedirexists} - if a directory -with this name exists. +Before doing other tests, you should use \helpref{IsOk}{wxfilenameisok} to +verify that the filename is well defined. If it is,\rtfsp +\helpref{FileExists}{wxfilenamefileexists} can be used to test whether a file +with such name exists and \helpref{DirExists}{wxfilenamedirexists} can be used +to test for directory existence. File names should be compared using \helpref{SameAs}{wxfilenamesameas} method or \helpref{$==$}{wxfilenameoperatorequal}. @@ -429,7 +432,12 @@ Returns the last time the file was last modified. \constfunc{wxString}{GetName}{\void} -Returns the name part of the filename. +Returns the name part of the filename (without extension). + +\wxheading{See also} + +\helpref{GetFullName}{wxfilenamegetfullname} + \membersection{wxFileName::GetPath}\label{wxfilenamegetpath} @@ -487,6 +495,17 @@ same as \helpref{GetPathSeparators}{wxfilenamegetpathseparators} except for VMS path format where $]$ is used at the end of the path part. +\membersection{wxFileName::GetPathWithSep}\label{wxfilenamegetpathwithsep} + +\constfunc{wxString}{GetPathWithSep}{\param{wxPathFormat }{format = wxPATH\_NATIVE}} + +Returns the path with the trailing separator, useful for appending the name to +the given path. + +This is the same as calling \helpref{GetPath}{wxfilenamegetpath} +\texttt{(wxPATH\_GET\_VOLUME | wxPATH\_GET\_SEPARATOR, format)}. + + \membersection{wxFileName::GetShortPath}\label{wxfilenamegetshortpath} \constfunc{wxString}{GetShortPath}{\void} @@ -802,7 +821,11 @@ The full name is the file name and extension (but without the path). \func{void}{SetName}{\param{const wxString\& }{name}} -Sets the name. +Sets the name part (without extension). + +\wxheading{See also} + +\helpref{SetFullName}{wxfilenamesetfullname} \membersection{wxFileName::SetTimes}\label{wxfilenamesettimes}