X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/8795498cd9ec480873e88fccbb63b94be3eddb92..fa1af598d62a71f7e7054a0dcc7b209e91e58873:/docs/latex/wx/filename.tex?ds=inline diff --git a/docs/latex/wx/filename.tex b/docs/latex/wx/filename.tex index 96bb35e213..27ced29111 100644 --- a/docs/latex/wx/filename.tex +++ b/docs/latex/wx/filename.tex @@ -127,6 +127,8 @@ following functions: \helpref{HasName}{wxfilenamehasname}\\ \helpref{HasVolume}{wxfilenamehasvolume}\\ \helpref{SetExt}{wxfilenamesetext}\\ +\helpref{ClearExt}{wxfilenameclearext}\\ +\helpref{SetEmptyExt}{wxfilenamesetemptyext}\\ \helpref{SetName}{wxfilenamesetname}\\ \helpref{SetVolume}{wxfilenamesetvolume}\\ @@ -197,6 +199,8 @@ assert failure in debug build). \func{void}{Assign}{\param{const wxString\& }{fullpath}, \param{wxPathFormat }{format = wxPATH\_NATIVE}} +\func{void}{Assign}{\param{const wxString\& }{volume}, \param{const wxString\& }{path}, \param{const wxString\& }{name}, \param{const wxString\& }{ext}, \param{bool }{hasExt}, \param{wxPathFormat }{format = wxPATH\_NATIVE}} + \func{void}{Assign}{\param{const wxString\& }{volume}, \param{const wxString\& }{path}, \param{const wxString\& }{name}, \param{const wxString\& }{ext}, \param{wxPathFormat }{format = wxPATH\_NATIVE}} \func{void}{Assign}{\param{const wxString\& }{path}, \param{const wxString\& }{name}, \param{wxPathFormat }{format = wxPATH\_NATIVE}} @@ -250,6 +254,18 @@ temporary file couldn't be created, the object is put into the\rtfsp Reset all components to default, uninitialized state. +\membersection{wxFileName::ClearExt}\label{wxfilenameclearext} + +\func{void}{SetClearExt}{\void} + +Removes the extension from the file name resulting in a +file name with no trailing dot. + +\wxheading{See also} + +\helpref{SetExt}{wxfilenamesetext} +\helpref{SetEmptyExt}{wxfilenamesetemptyext} + \membersection{wxFileName::CreateTempFileName}\label{wxfilenamecreatetempfilename} \func{static wxString}{CreateTempFileName}{\param{const wxString\& }{prefix}, \param{wxFile *}{fileTemp = {\tt NULL}}} @@ -326,7 +342,7 @@ function exists mainly for symmetry with \helpref{DirName}{wxfilenamedirname}. \func{static wxString}{GetCwd}{\param{const wxString\& }{volume = ""}} Retrieves the value of the current working directory on the specified volume. If -the volume is empty, the programs current working directory is returned for the +the volume is empty, the program's current working directory is returned for the current volume. \wxheading{Return value} @@ -752,8 +768,28 @@ Changes the current working directory. \func{void}{SetExt}{\param{const wxString\& }{ext}} -Sets the extension of this file name. +Sets the extension of the file name. Setting an empty string +as the extension will remove the extension resulting in a file +name without a trailing dot, unlike a call to +\helpref{SetEmptyExt}{wxfilenamesetemptyext}. + +\wxheading{See also} +\helpref{SetEmptyExt}{wxfilenamesetemptyext} +\helpref{ClearExt}{wxfilenameclearext} + +\membersection{wxFileName::SetEmptyExt}\label{wxfilenamesetemptyext} + +\func{void}{SetEmptyExt}{\void} + +Sets the extension of the file name to be an empty extension. +This is different from having no extension at all as the file +name will have a trailing dot after a call to this method. + +\wxheading{See also} + +\helpref{SetExt}{wxfilenamesetext} +\helpref{ClearExt}{wxfilenameclearext} \membersection{wxFileName::SetFullName}\label{wxfilenamesetfullname} @@ -785,6 +821,8 @@ Sets the volume specifier. \membersection{wxFileName::SplitPath}\label{wxfilenamesplitpath} +\func{static void}{SplitPath}{\param{const wxString\& }{fullpath}, \param{wxString* }{volume}, \param{wxString* }{path}, \param{wxString* }{name}, \param{wxString* }{ext}, \param{bool }{*hasExt = \texttt{NULL}}, \param{wxPathFormat }{format = wxPATH\_NATIVE}} + \func{static void}{SplitPath}{\param{const wxString\& }{fullpath}, \param{wxString* }{volume}, \param{wxString* }{path}, \param{wxString* }{name}, \param{wxString* }{ext}, \param{wxPathFormat }{format = wxPATH\_NATIVE}} \func{static void}{SplitPath}{\param{const wxString\& }{fullpath}, \param{wxString* }{path}, \param{wxString* }{name}, \param{wxString* }{ext}, \param{wxPathFormat }{format = wxPATH\_NATIVE}} @@ -801,6 +839,10 @@ without leading dot. All three of them may be empty if the corresponding 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}). +Note that for a filename ``foo.'' the extension is present, as indicated by the +trailing dot, but empty. If you need to cope with such cases, you should use +\arg{hasExt} instead of relying on testing whether \arg{ext} is empty or not. + \membersection{wxFileName::SplitVolume}\label{wxfilenamesplitvolume}