X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ef92f440977f4aaaf7c252c0646b29e35e2c8b50..cec5ffc46da1cf66cb3e61567006a8c0f4b84f81:/docs/latex/wx/filename.tex?ds=inline diff --git a/docs/latex/wx/filename.tex b/docs/latex/wx/filename.tex index 47d44b6ec0..311783e728 100644 --- a/docs/latex/wx/filename.tex +++ b/docs/latex/wx/filename.tex @@ -14,7 +14,7 @@ wxFileName encapsulates a file name. This class serves two purposes: first, it provides the functions to split the file names into components and to recombine these components in the full file name which can then be passed to the OS file -functions (and \helpref{wxWindows functions}{filefunctions} wrapping them). +functions (and \helpref{wxWidgets functions}{filefunctions} wrapping them). Second, it includes the functions for working with the files itself. Note that to change the file data you should use \helpref{wxFile}{wxfile} class instead. wxFileName provides functions for working with the file attributes. @@ -23,6 +23,10 @@ wxFileName provides functions for working with the file attributes. No base class +\wxheading{Include files} + + + \wxheading{Data structures} Many wxFileName methods accept the path format argument which is by\rtfsp @@ -51,7 +55,8 @@ 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 @@ -68,44 +73,52 @@ 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} +\membersection{File name construction}\label{filenameconstruction} TODO. -\membersection{File tests} -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. +\membersection{File tests}\label{filetests} + +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}. -\membersection{File name components} -These functions allow to examine and modify the directories of the path: +\membersection{File name components}\label{filenamecomponents} + +These functions allow to examine and modify the individual directories of the +path: \helpref{AppendDir}{wxfilenameappenddir}\\ \helpref{InsertDir}{wxfilenameinsertdir}\\ \helpref{GetDirCount}{wxfilenamegetdircount} \helpref{PrependDir}{wxfilenameprependdir}\\ -\helpref{RemoveDir}{wxfilenameremovedir} +\helpref{RemoveDir}{wxfilenameremovedir}\\ +\helpref{RemoveLastDir}{wxfilenameremovelastdir} To change the components of the file name individually you can use the following functions: @@ -117,10 +130,13 @@ following functions: \helpref{HasName}{wxfilenamehasname}\\ \helpref{HasVolume}{wxfilenamehasvolume}\\ \helpref{SetExt}{wxfilenamesetext}\\ +\helpref{ClearExt}{wxfilenameclearext}\\ +\helpref{SetEmptyExt}{wxfilenamesetemptyext}\\ \helpref{SetName}{wxfilenamesetname}\\ \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 @@ -140,6 +156,7 @@ Other file system operations functions are: \latexignore{\rtfignore{\wxheading{Members}}} + \membersection{wxFileName::wxFileName}\label{wxfilenamewxfilename} \func{}{wxFileName}{\void} @@ -168,11 +185,16 @@ Constructor from a directory name, base file name and extension. Constructor from a volume name, a directory name, base file name and extension. + \membersection{wxFileName::AppendDir}\label{wxfilenameappenddir} \func{void}{AppendDir}{\param{const wxString\& }{dir}} -Appends a directory to the path. +Appends a directory component to the path. This component should contain a +single directory name level, i.e. not contain any path or volume separators nor +should it be empty, otherwise the function does nothing (and generates an +assert failure in debug build). + \membersection{wxFileName::Assign}\label{wxfilenameassign} @@ -180,6 +202,8 @@ Appends a directory to the path. \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}} @@ -188,6 +212,7 @@ Appends a directory to the path. Creates the file name from various combinations of data. + \membersection{wxFileName::AssignCwd}\label{wxfilenameassigncwd} \func{static void}{AssignCwd}{\param{const wxString\& }{volume = wxEmptyString}} @@ -199,6 +224,7 @@ volume (or current volume if {\it volume} is empty). \helpref{GetCwd}{wxfilenamegetcwd} + \membersection{wxFileName::AssignDir}\label{wxfilenameassigndir} \func{void}{AssignDir}{\param{const wxString\& }{dir}, \param{wxPathFormat }{format = wxPATH\_NATIVE}} @@ -206,12 +232,14 @@ volume (or current volume if {\it volume} is empty). Sets this file name object to the given directory name. The name and extension will be empty. + \membersection{wxFileName::AssignHomeDir}\label{wxfilenameassignhomedir} \func{void}{AssignHomeDir}{\void} Sets this file name object to the home directory. + \membersection{wxFileName::AssignTempFileName}\label{wxfilenameassigntempfilename} \func{void}{AssignTempFileName}{\param{const wxString\& }{prefix}, \param{wxFile *}{fileTemp = {\tt NULL}}} @@ -221,12 +249,26 @@ create a temporary file and sets this object to the name of the file. If a temporary file couldn't be created, the object is put into the\rtfsp \helpref{invalid}{wxfilenameisok} state. + \membersection{wxFileName::Clear}\label{wxfilenameclear} \func{void}{Clear}{\void} 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}}} @@ -256,6 +298,7 @@ owner only to minimize the security problems. The full temporary file name or an empty string on error. + \membersection{wxFileName::DirExists}\label{wxfilenamedirexists} \constfunc{bool}{DirExists}{\void} @@ -264,6 +307,7 @@ The full temporary file name or an empty string on error. Returns {\tt true} if the directory with this name exists. + \membersection{wxFileName::DirName}\label{wxfilenamedirname} \func{static wxFileName}{DirName}{\param{const wxString\& }{dir}, \param{wxPathFormat }{format = wxPATH\_NATIVE}} @@ -272,6 +316,7 @@ Returns the object corresponding to the directory with the given name. The {\it dir} parameter may have trailing path separator or not. + \membersection{wxFileName::FileExists}\label{wxfilenamefileexists} \constfunc{bool}{FileExists}{\void} @@ -285,6 +330,7 @@ Returns {\tt true} if the file with this name exists. \helpref{DirExists}{wxfilenamedirexists} + \membersection{wxFileName::FileName}\label{wxfilenamefilename} \func{static wxFileName}{FileName}{\param{const wxString\& }{file}, \param{wxPathFormat }{format = wxPATH\_NATIVE}} @@ -293,12 +339,13 @@ Returns the file name object corresponding to the given {\it file}. This function exists mainly for symmetry with \helpref{DirName}{wxfilenamedirname}. + \membersection{wxFileName::GetCwd}\label{wxfilenamegetcwd} \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} @@ -310,71 +357,88 @@ error. \helpref{AssignCwd}{wxfilenameassigncwd} + \membersection{wxFileName::GetDirCount}\label{wxfilenamegetdircount} \constfunc{size\_t}{GetDirCount}{\void} Returns the number of directories in the file name. + \membersection{wxFileName::GetDirs}\label{wxfilenamegetdirs} \constfunc{const wxArrayString\&}{GetDirs}{\void} Returns the directories in string array form. + \membersection{wxFileName::GetExt}\label{wxfilenamegetext} \constfunc{wxString}{GetExt}{\void} Returns the file name extension. + \membersection{wxFileName::GetForbiddenChars}\label{wxfilenamegetforbiddenchars} \func{static wxString}{GetForbiddenChars}{\param{wxPathFormat }{format = wxPATH\_NATIVE}} Returns the characters that can't be used in filenames and directory names for the specified format. + \membersection{wxFileName::GetFormat}\label{wxfilenamegetformat} \func{static wxPathFormat}{GetFormat}{\param{wxPathFormat }{format = wxPATH\_NATIVE}} Returns the canonical path format for this platform. + \membersection{wxFileName::GetFullName}\label{wxfilenamegetfullname} \constfunc{wxString}{GetFullName}{\void} Returns the full name (including extension but excluding directories). + \membersection{wxFileName::GetFullPath}\label{wxfilenamegetfullpath} \constfunc{wxString}{GetFullPath}{\param{wxPathFormat }{format = wxPATH\_NATIVE}} Returns the full path with name and extension. + \membersection{wxFileName::GetHomeDir}\label{wxfilenamegethomedir} \func{static wxString}{GetHomeDir}{\void} Returns the home directory. + \membersection{wxFileName::GetLongPath}\label{wxfilenamegetlongpath} \constfunc{wxString}{GetLongPath}{\void} Return the long form of the path (returns identity on non-Windows platforms) + \membersection{wxFileName::GetModificationTime}\label{wxfilenamegetmodificationtime} \constfunc{wxDateTime}{GetModificationTime}{\void} Returns the last time the file was last modified. + \membersection{wxFileName::GetName}\label{wxfilenamegetname} \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} @@ -393,6 +457,7 @@ 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{static wxChar}{GetPathSeparator}{\param{wxPathFormat }{format = wxPATH\_NATIVE}} @@ -406,6 +471,7 @@ method. \helpref{GetPathSeparators}{wxfilenamegetpathseparators} + \membersection{wxFileName::GetPathSeparators}\label{wxfilenamegetpathseparators} \func{static wxString}{GetPathSeparators}{\param{wxPathFormat }{format = wxPATH\_NATIVE}} @@ -419,12 +485,61 @@ 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::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} Return the short form of the path (returns identity on non-Windows platforms). + +\membersection{wxFileName::GetSize}\label{wxfilenamegetsize} + +\constfunc{wxULongLong}{GetSize}{\void} + +\func{static wxULongLong}{GetSize}{\param{const wxString\& }{filename}} + +Returns the size of this file (first form) or the size of the given file (second form). +If the file does not exist or its size could not be read (because e.g. the file is locked +by another process) the returned value is {\tt wxInvalidSize}. + + +\membersection{wxFileName::GetHumanReadableSize}\label{wxfilenamegethumanreadablesize} + +\constfunc{wxString}{GetHumanReadableSize}{\param{const wxString\& }{failmsg = "Not available"}, \param{int }{precision = 1}} + +\func{static wxString}{GetHumanReadableSize}{\param{const wxULongLong\& }{bytes}, \param{const wxString\& }{nullsize = "Not available"}, \param{int }{precision = 1}} + +Returns the size of this file (first form) or the given number of bytes (second form) +in a human-readable form. + +If the size could not be retrieved the {\tt failmsg} string is returned (first form). +If {\tt bytes} is {\tt wxInvalidSize} or zero, then {\tt nullsize} is returned (second form). + +In case of success, the returned string is a floating-point number with {\tt precision} decimal digits +followed by the size unit (B, kB, MB, GB, TB: respectively bytes, kilobytes, megabytes, gigabytes, terabytes). + + \membersection{wxFileName::GetTimes}\label{wxfilenamegettimes} \constfunc{bool}{GetTimes}{\param{wxDateTime* }{dtAccess}, \param{wxDateTime* }{dtMod}, \param{wxDateTime* }{dtCreate}} @@ -444,43 +559,51 @@ needed. {\tt true} on success, {\tt false} if we failed to retrieve the times. + \membersection{wxFileName::GetVolume}\label{wxfilenamegetvolume} \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). + \membersection{wxFileName::GetVolumeSeparator}\label{wxfilenamegetvolumeseparator} \func{static wxString}{GetVolumeSeparator}{\param{wxPathFormat }{format = wxPATH\_NATIVE}} Returns the string separating the volume from the path for this format. + \membersection{wxFileName::HasExt}\label{wxfilenamehasext} \constfunc{bool}{HasExt}{\void} Returns {\tt true} if an extension is present. + \membersection{wxFileName::HasName}\label{wxfilenamehasname} \constfunc{bool}{HasName}{\void} Returns {\tt true} if a name is present. + \membersection{wxFileName::HasVolume}\label{wxfilenamehasvolume} \constfunc{bool}{HasVolume}{\void} Returns {\tt true} if a volume specifier is present. + \membersection{wxFileName::InsertDir}\label{wxfilenameinsertdir} -\func{void}{InsertDir}{\param{int }{before}, \param{const wxString\& }{dir}} +\func{void}{InsertDir}{\param{size\_t }{before}, \param{const wxString\& }{dir}} + +Inserts a directory component before the zero-based position in the directory +list. Please see \helpref{AppendDir}{wxfilenameappenddir} for important notes. -Inserts a directory before the zero-based position in the directory list. \membersection{wxFileName::IsAbsolute}\label{wxfilenameisabsolute} @@ -488,12 +611,14 @@ Inserts a directory before the zero-based position in the directory list. Returns {\tt true} if this filename is absolute. + \membersection{wxFileName::IsCaseSensitive}\label{wxfilenameiscasesensitive} \func{static bool}{IsCaseSensitive}{\param{wxPathFormat }{format = wxPATH\_NATIVE}} Returns {\tt true} if the file names of this type are case-sensitive. + \membersection{wxFileName::IsOk}\label{wxfilenameisok} \constfunc{bool}{IsOk}{\void} @@ -503,18 +628,21 @@ initialized yet. The assignment functions and \helpref{Clear}{wxfilenameclear} may reset the object to the uninitialized, invalid state (the former only do it on failure). + \membersection{wxFileName::IsPathSeparator}\label{wxfilenameispathseparator} \func{static bool}{IsPathSeparator}{\param{wxChar }{ch}, \param{wxPathFormat }{format = wxPATH\_NATIVE}} 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}} Returns {\tt true} if this filename is not absolute. + \membersection{wxFileName::IsDir}\label{wxfilenameisdir} \constfunc{bool}{IsDir}{\void} @@ -525,6 +653,24 @@ directory or file really exists, you should use \helpref{DirExists}{wxfilenamedirexists} or \helpref{FileExists}{wxfilenamefileexists} for this. +\membersection{wxFileName::MacFindDefaultTypeAndCreator}\label{wxfilenamemacfinddefaulttypeandcreator} + +\func{static bool}{MacFindDefaultTypeAndCreator}{\param{const wxString\& }{ext}, \param{wxUint32* }{type}, \param{wxUint32* }{creator}} + +On Mac OS, gets the common type and creator for the given extension. + +\membersection{wxFileName::MacRegisterDefaultTypeAndCreator}\label{wxfilenamemacregisterdefaulttypeandcreator} + +\func{static void}{MacRegisterDefaultTypeAndCreator}{\param{const wxString\& }{ext}, \param{wxUint32 }{type}, \param{wxUint32 }{creator}} + +On Mac OS, registers application defined extensions and their default type and creator. + +\membersection{wxFileName::MacSetDefaultTypeAndCreator}\label{wxfilenamemacsetdefaulttypeandcreator} + +\func{bool}{MacSetDefaultTypeAndCreator}{\void} + +On Mac OS, looks up the appropriate type and creator from the registration and then sets it. + \membersection{wxFileName::MakeAbsolute}\label{wxfilenamemakeabsolute} \func{bool}{MakeAbsolute}{\param{const wxString\& }{cwd = wxEmptyString}, \param{wxPathFormat }{format = wxPATH\_NATIVE}} @@ -538,6 +684,7 @@ Make the file name absolute. This is a shortcut for \helpref{Normalize}{wxfilenamenormalize}, \helpref{IsAbsolute}{wxfilenameisabsolute} + \membersection{wxFileName::MakeRelativeTo}\label{wxfilenamemakerelativeto} \func{bool}{MakeRelativeTo}{\param{const wxString\& }{pathBase = wxEmptyString}, \param{wxPathFormat }{format = wxPATH\_NATIVE}} @@ -561,6 +708,7 @@ different from the volume specified by {\it pathBase}). \helpref{Normalize}{wxfilenamenormalize} + \membersection{wxFileName::Mkdir}\label{wxfilenamemkdir} \func{bool}{Mkdir}{\param{int }{perm = 0777}, \param{int }{flags = $0$}} @@ -580,6 +728,7 @@ if the target directory already exists.} Returns {\tt true} if the directory was successfully created, {\tt false} otherwise. + \membersection{wxFileName::Normalize}\label{wxfilenamenormalize} \func{bool}{Normalize}{\param{int }{flags = wxPATH\_NORM\_ALL}, \param{const wxString\& }{cwd = wxEmptyString}, \param{wxPathFormat }{format = wxPATH\_NATIVE}} @@ -590,33 +739,51 @@ variables will be expanded in it. \docparam{flags}{The kind of normalization to do with the file name. It can be any or-combination of the following constants: + \begin{twocollist} \twocolitem{{\bf wxPATH\_NORM\_ENV\_VARS}}{replace env vars with their values} \twocolitem{{\bf wxPATH\_NORM\_DOTS}}{squeeze all .. and . and prepend cwd} \twocolitem{{\bf wxPATH\_NORM\_TILDE}}{Unix only: replace ~ and ~user} -\twocolitem{{\bf wxPATH\_NORM\_CASE}}{if filesystem is case insensitive, transform to tolower case} +\twocolitem{{\bf wxPATH\_NORM\_CASE}}{if filesystem is case insensitive, transform to lower case} \twocolitem{{\bf wxPATH\_NORM\_ABSOLUTE}}{make the path absolute} \twocolitem{{\bf wxPATH\_NORM\_LONG}}{make the path the long form} +\twocolitem{{\bf wxPATH\_NORM\_SHORTCUT}}{resolve if it is a shortcut (Windows only)} \twocolitem{{\bf wxPATH\_NORM\_ALL}}{all of previous flags except \texttt{wxPATH\_NORM\_CASE}} \end{twocollist} -} +}% \docparam{cwd}{If not empty, this directory will be used instead of current working directory in normalization.} \docparam{format}{The file name format, native by default.} + \membersection{wxFileName::PrependDir}\label{wxfilenameprependdir} \func{void}{PrependDir}{\param{const wxString\& }{dir}} -Prepends a directory name. +Prepends a directory to the file path. Please see +\helpref{AppendDir}{wxfilenameappenddir} for important notes. + + \membersection{wxFileName::RemoveDir}\label{wxfilenameremovedir} -\func{void}{RemoveDir}{\param{int }{pos}} +\func{void}{RemoveDir}{\param{size\_t }{pos}} + +Removes the specified directory component from the path. + +\wxheading{See also} + +\helpref{GetDirCount}{wxfilenamegetdircount} + + +\membersection{wxFileName::RemoveLastDir}\label{wxfilenameremovelastdir} + +\func{void}{RemoveLastDir}{\void} + +Removes last directory component from the path. -Removes a directory name. \membersection{wxFileName::Rmdir}\label{wxfilenamermdir} @@ -626,12 +793,14 @@ Removes a directory name. Deletes the specified directory from the file system. + \membersection{wxFileName::SameAs}\label{wxfilenamesameas} \constfunc{bool}{SameAs}{\param{const wxFileName\& }{filepath}, \param{wxPathFormat }{format = wxPATH\_NATIVE}} Compares the filename using the rules of this platform. + \membersection{wxFileName::SetCwd}\label{wxfilenamesetcwd} \func{bool}{SetCwd}{\void} @@ -640,11 +809,33 @@ Compares the filename using the rules of this platform. Changes the current working directory. + \membersection{wxFileName::SetExt}\label{wxfilenamesetext} \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} @@ -652,11 +843,17 @@ Sets the extension of this file name. The full name is the file name and extension (but without the path). + \membersection{wxFileName::SetName}\label{wxfilenamesetname} \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} @@ -664,14 +861,18 @@ Sets the name. Sets the file creation and last access/modification times (any of the pointers may be NULL). + \membersection{wxFileName::SetVolume}\label{wxfilenamesetvolume} \func{void}{SetVolume}{\param{const wxString\& }{volume}} 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}} @@ -688,12 +889,30 @@ 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} + +\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} Sets the access and modification times to the current moment. + \membersection{wxFileName::operator=}\label{wxfilenameoperatorassign} \func{wxFileName\& operator}{operator=}{\param{const wxFileName\& }{filename}} @@ -702,6 +921,7 @@ Sets the access and modification times to the current moment. Assigns the new value to this filename object. + \membersection{wxFileName::operator==}\label{wxfilenameoperatorequal} \constfunc{bool operator}{operator==}{\param{const wxFileName\& }{filename}} @@ -711,6 +931,7 @@ Assigns the new value to this filename object. Returns {\tt true} if the filenames are equal. The string {\it filenames} is interpreted as a path in the native filename format. + \membersection{wxFileName::operator!=}\label{wxfilenameoperatornotequal} \constfunc{bool operator}{operator!=}{\param{const wxFileName\& }{filename}}