Some doc corrections

[wxWidgets.git] / docs / latex / wx / filename.tex

diff --git a/docs/latex/wx/filename.tex b/docs/latex/wx/filename.tex
index a93a18c7ef96beb53aa9ea50b68213f677556b7a..d739dcd8dc8aed020b46a4eeae51ea9a58fb0b7a 100644 (file)
--- a/docs/latex/wx/filename.tex
+++ b/docs/latex/wx/filename.tex
@@ -38,18 +38,20 @@ enum wxPathFormat
 {
     wxPATH_NATIVE = 0,      // the path format for the current platform
     wxPATH_UNIX,
 {
     wxPATH_NATIVE = 0,      // the path format for the current platform
     wxPATH_UNIX,

+    wxPATH_BEOS = wxPATH_UNIX,

     wxPATH_MAC,
     wxPATH_DOS,
     wxPATH_MAC,
     wxPATH_DOS,

+    wxPATH_WIN = wxPATH_DOS,
+    wxPATH_OS2 = wxPATH_DOS,

     wxPATH_VMS,
 
     wxPATH_VMS,
 

-    wxPATH_BEOS = wxPATH_UNIX,
-    wxPATH_WIN = wxPATH_DOS,
-    wxPATH_OS2 = wxPATH_DOS
+    wxPATH_MAX // Not a valid value for specifying path format

 }
 \end{verbatim}
 
 \latexignore{\rtfignore{\wxheading{Function groups}}}
 
 }
 \end{verbatim}
 
 \latexignore{\rtfignore{\wxheading{Function groups}}}
 

+

 \membersection{File name format}
 
 wxFileName currently supports the file names in the Unix, DOS/Windows, Mac OS
 \membersection{File name format}
 
 wxFileName currently supports the file names in the Unix, DOS/Windows, Mac OS


@@ -81,10 +83,12 @@ class are \helpref{GetVolumeSeparator}{wxfilenamegetvolumeseparator},\rtfsp
 
 \helpref{IsRelative}{wxfilenameisrelative}
 
 
 \helpref{IsRelative}{wxfilenameisrelative}
 

+

 \membersection{File name construction}
 
 TODO.
 
 \membersection{File name construction}
 
 TODO.
 

+

 \membersection{File tests}
 
 Before doing the other tests you should use \helpref{IsOk}{wxfilenameisok} to
 \membersection{File tests}
 
 Before doing the other tests you should use \helpref{IsOk}{wxfilenameisok} to


@@ -96,6 +100,7 @@ with this name exists.
 File names should be compared using \helpref{SameAs}{wxfilenamesameas} method
 or \helpref{$==$}{wxfilenameoperatorequal}.
 
 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}
 
 These functions allow to examine and modify the directories of the path:


@@ -119,6 +124,7 @@ following functions:
 \helpref{SetName}{wxfilenamesetname}\\
 \helpref{SetVolume}{wxfilenamesetvolume}\\
 
 \helpref{SetName}{wxfilenamesetname}\\
 \helpref{SetVolume}{wxfilenamesetvolume}\\
 

+

 \membersection{Operations}
 
 These methods allow to work with the file creation, access and modification
 \membersection{Operations}
 
 These methods allow to work with the file creation, access and modification


@@ -139,6 +145,7 @@ Other file system operations functions are:
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

+

 \membersection{wxFileName::wxFileName}\label{wxfilenamewxfilename}
 
 \func{}{wxFileName}{\void}
 \membersection{wxFileName::wxFileName}\label{wxfilenamewxfilename}
 
 \func{}{wxFileName}{\void}


@@ -167,11 +174,16 @@ Constructor from a directory name, base file name and extension.
 
 Constructor from a volume name, 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}}
 
 \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}
 
 
 \membersection{wxFileName::Assign}\label{wxfilenameassign}
 


@@ -187,9 +199,10 @@ Appends a directory to the path.
 
 Creates the file name from various combinations of data.
 
 
 Creates the file name from various combinations of data.
 

+

 \membersection{wxFileName::AssignCwd}\label{wxfilenameassigncwd}
 
 \membersection{wxFileName::AssignCwd}\label{wxfilenameassigncwd}
 

-\func{void}{AssignCwd}{\param{const wxString\& }{volume = ""}}
+\func{static void}{AssignCwd}{\param{const wxString\& }{volume = wxEmptyString}}

 
 Makes this object refer to the current working directory on the specified
 volume (or current volume if {\it volume} is empty).
 
 Makes this object refer to the current working directory on the specified
 volume (or current volume if {\it volume} is empty).


@@ -198,6 +211,7 @@ volume (or current volume if {\it volume} is empty).
 
 \helpref{GetCwd}{wxfilenamegetcwd}
 
 
 \helpref{GetCwd}{wxfilenamegetcwd}
 

+

 \membersection{wxFileName::AssignDir}\label{wxfilenameassigndir}
 
 \func{void}{AssignDir}{\param{const wxString\& }{dir}, \param{wxPathFormat }{format = wxPATH\_NATIVE}}
 \membersection{wxFileName::AssignDir}\label{wxfilenameassigndir}
 
 \func{void}{AssignDir}{\param{const wxString\& }{dir}, \param{wxPathFormat }{format = wxPATH\_NATIVE}}


@@ -205,12 +219,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.
 
 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::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}}}
 \membersection{wxFileName::AssignTempFileName}\label{wxfilenameassigntempfilename}
 
 \func{void}{AssignTempFileName}{\param{const wxString\& }{prefix}, \param{wxFile *}{fileTemp = {\tt NULL}}}


@@ -220,12 +236,14 @@ 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.
 
 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::Clear}\label{wxfilenameclear}
 
 \func{void}{Clear}{\void}
 
 Reset all components to default, uninitialized state.
 

+

 \membersection{wxFileName::CreateTempFileName}\label{wxfilenamecreatetempfilename}
 
 \func{static wxString}{CreateTempFileName}{\param{const wxString\& }{prefix}, \param{wxFile *}{fileTemp = {\tt NULL}}}
 \membersection{wxFileName::CreateTempFileName}\label{wxfilenamecreatetempfilename}
 
 \func{static wxString}{CreateTempFileName}{\param{const wxString\& }{prefix}, \param{wxFile *}{fileTemp = {\tt NULL}}}


@@ -255,19 +273,24 @@ owner only to minimize the security problems.
 
 The full temporary file name or an empty string on error.
 
 
 The full temporary file name or an empty string on error.
 

+

 \membersection{wxFileName::DirExists}\label{wxfilenamedirexists}
 
 \constfunc{bool}{DirExists}{\void}
 
 \func{static bool}{DirExists}{\param{const wxString\& }{dir}}
 
 \membersection{wxFileName::DirExists}\label{wxfilenamedirexists}
 
 \constfunc{bool}{DirExists}{\void}
 
 \func{static bool}{DirExists}{\param{const wxString\& }{dir}}
 

-Returns true if the directory with this name exists.
+Returns {\tt true} if the directory with this name exists.
+

 
 \membersection{wxFileName::DirName}\label{wxfilenamedirname}
 
 
 \membersection{wxFileName::DirName}\label{wxfilenamedirname}
 

-\func{wxFileName}{DirName}{\param{const wxString\& }{dir}}
+\func{static wxFileName}{DirName}{\param{const wxString\& }{dir}, \param{wxPathFormat }{format = wxPATH\_NATIVE}}
+
+Returns the object corresponding to the directory with the given name.
+The {\it dir} parameter may have trailing path separator or not.
+

 
 

-Returns the directory name.

 
 \membersection{wxFileName::FileExists}\label{wxfilenamefileexists}
 
 
 \membersection{wxFileName::FileExists}\label{wxfilenamefileexists}
 


@@ -275,21 +298,26 @@ Returns the directory name.
 
 \func{static bool}{FileExists}{\param{const wxString\& }{file}}
 
 
 \func{static bool}{FileExists}{\param{const wxString\& }{file}}
 

-Returns true if the file with this name exists.
+Returns {\tt true} if the file with this name exists.

 
 \wxheading{See also}
 
 \helpref{DirExists}{wxfilenamedirexists}
 
 
 \wxheading{See also}
 
 \helpref{DirExists}{wxfilenamedirexists}
 

+
+

 \membersection{wxFileName::FileName}\label{wxfilenamefilename}
 
 \membersection{wxFileName::FileName}\label{wxfilenamefilename}
 

-\func{wxFileName}{FileName}{\param{const wxString\& }{file}}
+\func{static wxFileName}{FileName}{\param{const wxString\& }{file}, \param{wxPathFormat }{format = wxPATH\_NATIVE}}
+
+Returns the file name object corresponding to the given {\it file}. This
+function exists mainly for symmetry with \helpref{DirName}{wxfilenamedirname}.
+

 
 

-Static pseudo constructors.

 
 \membersection{wxFileName::GetCwd}\label{wxfilenamegetcwd}
 
 
 \membersection{wxFileName::GetCwd}\label{wxfilenamegetcwd}
 

-\func{wxString}{GetCwd}{\param{const wxString\& }{volume = ""}}
+\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
 
 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


@@ -304,69 +332,87 @@ error.
 
 \helpref{AssignCwd}{wxfilenameassigncwd}
 
 
 \helpref{AssignCwd}{wxfilenameassigncwd}
 

+

 \membersection{wxFileName::GetDirCount}\label{wxfilenamegetdircount}
 
 \constfunc{size\_t}{GetDirCount}{\void}
 
 Returns the number of directories in the file name.
 
 \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::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::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}
 
 \membersection{wxFileName::GetFormat}\label{wxfilenamegetformat}
 

-\func{wxPathFormat}{GetFormat}{\param{wxPathFormat }{format = wxPATH\_NATIVE}}
+\func{static wxPathFormat}{GetFormat}{\param{wxPathFormat }{format = wxPATH\_NATIVE}}

 
 Returns the canonical path format for this platform.
 
 
 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::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::GetFullPath}\label{wxfilenamegetfullpath}
 
 \constfunc{wxString}{GetFullPath}{\param{wxPathFormat }{format = wxPATH\_NATIVE}}
 
 Returns the full path with name and extension.
 

+

 \membersection{wxFileName::GetHomeDir}\label{wxfilenamegethomedir}
 
 \membersection{wxFileName::GetHomeDir}\label{wxfilenamegethomedir}
 

-\func{wxString}{GetHomeDir}{\void}
+\func{static wxString}{GetHomeDir}{\void}

 
 Returns the home directory.
 
 
 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::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::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.
 
 \membersection{wxFileName::GetName}\label{wxfilenamegetname}
 
 \constfunc{wxString}{GetName}{\void}
 
 Returns the name part of the filename.
 

+

 \membersection{wxFileName::GetPath}\label{wxfilenamegetpath}
 
 \membersection{wxFileName::GetPath}\label{wxfilenamegetpath}
 

-\constfunc{wxString}{GetPath}{\param{int }{flags = $0$}, \param{wxPathFormat }{format = wxPATH\_NATIVE}}
+\constfunc{wxString}{GetPath}{\param{int }{flags = {\tt wxPATH\_GET\_VOLUME}}, \param{wxPathFormat }{format = wxPATH\_NATIVE}}

 
 Returns the path part of the filename (without the name or extension). The
 possible flags values are:
 
 Returns the path part of the filename (without the name or extension). The
 possible flags values are:


@@ -374,15 +420,17 @@ possible flags values are:
 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf wxPATH\_GET\_VOLUME}}{Return the path with the volume (does
 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf wxPATH\_GET\_VOLUME}}{Return the path with the volume (does

-nothing for the filename formats without volumes)}
+nothing for the filename formats without volumes), otherwise the path without
+volume part is returned.}

 \twocolitem{{\bf 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}
 
 \twocolitem{{\bf 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}
 
 \membersection{wxFileName::GetPathSeparator}\label{wxfilenamegetpathseparator}
 

-\func{wxChar}{GetPathSeparator}{\param{wxPathFormat }{format = wxPATH\_NATIVE}}
+\func{static wxChar}{GetPathSeparator}{\param{wxPathFormat }{format = wxPATH\_NATIVE}}

 
 Returns 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
 
 Returns 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


@@ -393,9 +441,10 @@ method.
 
 \helpref{GetPathSeparators}{wxfilenamegetpathseparators}
 
 
 \helpref{GetPathSeparators}{wxfilenamegetpathseparators}
 

+

 \membersection{wxFileName::GetPathSeparators}\label{wxfilenamegetpathseparators}
 
 \membersection{wxFileName::GetPathSeparators}\label{wxfilenamegetpathseparators}
 

-\func{wxString}{GetPathSeparators}{\param{wxPathFormat }{format = wxPATH\_NATIVE}}
+\func{static wxString}{GetPathSeparators}{\param{wxPathFormat }{format = wxPATH\_NATIVE}}

 
 Returns 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
 
 Returns 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


@@ -406,12 +455,14 @@ separators.
 
 \helpref{GetPathSeparator}{wxfilenamegetpathseparator}
 
 
 \helpref{GetPathSeparator}{wxfilenamegetpathseparator}
 

+

 \membersection{wxFileName::GetShortPath}\label{wxfilenamegetshortpath}
 
 \constfunc{wxString}{GetShortPath}{\void}
 
 Return the short form of the path (returns identity on non-Windows platforms).
 
 \membersection{wxFileName::GetShortPath}\label{wxfilenamegetshortpath}
 
 \constfunc{wxString}{GetShortPath}{\void}
 
 Return the short form of the path (returns identity on non-Windows platforms).
 

+

 \membersection{wxFileName::GetTimes}\label{wxfilenamegettimes}
 
 \constfunc{bool}{GetTimes}{\param{wxDateTime* }{dtAccess}, \param{wxDateTime* }{dtMod}, \param{wxDateTime* }{dtCreate}}
 \membersection{wxFileName::GetTimes}\label{wxfilenamegettimes}
 
 \constfunc{bool}{GetTimes}{\param{wxDateTime* }{dtAccess}, \param{wxDateTime* }{dtMod}, \param{wxDateTime* }{dtCreate}}


@@ -431,6 +482,7 @@ needed.
 
 {\tt true} on success, {\tt false} if we failed to retrieve the times.
 
 
 {\tt true} on success, {\tt false} if we failed to retrieve the times.
 

+

 \membersection{wxFileName::GetVolume}\label{wxfilenamegetvolume}
 
 \constfunc{wxString}{GetVolume}{\void}
 \membersection{wxFileName::GetVolume}\label{wxfilenamegetvolume}
 
 \constfunc{wxString}{GetVolume}{\void}


@@ -439,47 +491,56 @@ Returns the string containing the volume for this file name, mepty if it
 doesn't have one or if the file system doesn't support volumes at all (for
 example, Unix).
 
 doesn't have one or if the file system doesn't support volumes at all (for
 example, Unix).
 

+

 \membersection{wxFileName::GetVolumeSeparator}\label{wxfilenamegetvolumeseparator}
 
 \membersection{wxFileName::GetVolumeSeparator}\label{wxfilenamegetvolumeseparator}
 

-\func{wxString}{GetVolumeSeparator}{\param{wxPathFormat }{format = wxPATH\_NATIVE}}
+\func{static wxString}{GetVolumeSeparator}{\param{wxPathFormat }{format = wxPATH\_NATIVE}}

 
 Returns the string separating the volume from the path for this format.
 
 
 Returns the string separating the volume from the path for this format.
 

+

 \membersection{wxFileName::HasExt}\label{wxfilenamehasext}
 
 \constfunc{bool}{HasExt}{\void}
 
 \membersection{wxFileName::HasExt}\label{wxfilenamehasext}
 
 \constfunc{bool}{HasExt}{\void}
 

-Returns true if an extension is present.
+Returns {\tt true} if an extension is present.
+

 
 \membersection{wxFileName::HasName}\label{wxfilenamehasname}
 
 \constfunc{bool}{HasName}{\void}
 
 
 \membersection{wxFileName::HasName}\label{wxfilenamehasname}
 
 \constfunc{bool}{HasName}{\void}
 

-Returns true if a name is present.
+Returns {\tt true} if a name is present.
+

 
 \membersection{wxFileName::HasVolume}\label{wxfilenamehasvolume}
 
 \constfunc{bool}{HasVolume}{\void}
 
 
 \membersection{wxFileName::HasVolume}\label{wxfilenamehasvolume}
 
 \constfunc{bool}{HasVolume}{\void}
 

-Returns true if a volume specifier is present.
+Returns {\tt true} if a volume specifier is present.
+

 
 \membersection{wxFileName::InsertDir}\label{wxfilenameinsertdir}
 
 \func{void}{InsertDir}{\param{int }{before}, \param{const wxString\& }{dir}}
 
 
 \membersection{wxFileName::InsertDir}\label{wxfilenameinsertdir}
 
 \func{void}{InsertDir}{\param{int }{before}, \param{const wxString\& }{dir}}
 

-Inserts a directory before the zero-based position in the directory list.
+Inserts a directory component before the zero-based position in the directory
+list. Please see \helpref{AppendDir}{wxfilenameappenddir} for important notes.
+

 
 \membersection{wxFileName::IsAbsolute}\label{wxfilenameisabsolute}
 
 \func{bool}{IsAbsolute}{\param{wxPathFormat }{format = wxPATH\_NATIVE}}
 
 
 \membersection{wxFileName::IsAbsolute}\label{wxfilenameisabsolute}
 
 \func{bool}{IsAbsolute}{\param{wxPathFormat }{format = wxPATH\_NATIVE}}
 

-Returns true if this filename is absolute.
+Returns {\tt true} if this filename is absolute.
+

 
 \membersection{wxFileName::IsCaseSensitive}\label{wxfilenameiscasesensitive}
 
 
 \membersection{wxFileName::IsCaseSensitive}\label{wxfilenameiscasesensitive}
 

-\func{bool}{IsCaseSensitive}{\param{wxPathFormat }{format = wxPATH\_NATIVE}}
+\func{static bool}{IsCaseSensitive}{\param{wxPathFormat }{format = wxPATH\_NATIVE}}
+
+Returns {\tt true} if the file names of this type are case-sensitive.

 
 

-Returns true if the file names of this type are case-sensitive.

 
 \membersection{wxFileName::IsOk}\label{wxfilenameisok}
 
 
 \membersection{wxFileName::IsOk}\label{wxfilenameisok}
 


@@ -490,18 +551,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).
 
 \helpref{Clear}{wxfilenameclear} may reset the object to the uninitialized,
 invalid state (the former only do it on failure).
 

+

 \membersection{wxFileName::IsPathSeparator}\label{wxfilenameispathseparator}
 
 \membersection{wxFileName::IsPathSeparator}\label{wxfilenameispathseparator}
 

-\func{bool}{IsPathSeparator}{\param{wxChar }{ch}, \param{wxPathFormat }{format = wxPATH\_NATIVE}}
+\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.
 
 
 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::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}
 \membersection{wxFileName::IsDir}\label{wxfilenameisdir}
 
 \constfunc{bool}{IsDir}{\void}


@@ -512,6 +576,7 @@ directory or file really exists, you should use
 \helpref{DirExists}{wxfilenamedirexists} or 
 \helpref{FileExists}{wxfilenamefileexists} for this.
 
 \helpref{DirExists}{wxfilenamedirexists} or 
 \helpref{FileExists}{wxfilenamefileexists} for this.
 

+

 \membersection{wxFileName::MakeAbsolute}\label{wxfilenamemakeabsolute}
 
 \func{bool}{MakeAbsolute}{\param{const wxString\& }{cwd = wxEmptyString}, \param{wxPathFormat }{format = wxPATH\_NATIVE}}
 \membersection{wxFileName::MakeAbsolute}\label{wxfilenamemakeabsolute}
 
 \func{bool}{MakeAbsolute}{\param{const wxString\& }{cwd = wxEmptyString}, \param{wxPathFormat }{format = wxPATH\_NATIVE}}


@@ -525,9 +590,10 @@ Make the file name absolute. This is a shortcut for
 \helpref{Normalize}{wxfilenamenormalize},
 \helpref{IsAbsolute}{wxfilenameisabsolute}
 
 \helpref{Normalize}{wxfilenamenormalize},
 \helpref{IsAbsolute}{wxfilenameisabsolute}
 

+

 \membersection{wxFileName::MakeRelativeTo}\label{wxfilenamemakerelativeto}
 
 \membersection{wxFileName::MakeRelativeTo}\label{wxfilenamemakerelativeto}
 

-\func{bool}{MakeRelativeTo}{\param{const wxString\& }{pathBase = ""}, \param{wxPathFormat }{format = wxPATH\_NATIVE}}
+\func{bool}{MakeRelativeTo}{\param{const wxString\& }{pathBase = wxEmptyString}, \param{wxPathFormat }{format = wxPATH\_NATIVE}}

 
 This function tries to put this file name in a form relative to {\it pathBase}.
 In other words, it returns the file name which should be used to access this
 
 This function tries to put this file name in a form relative to {\it pathBase}.
 In other words, it returns the file name which should be used to access this


@@ -548,6 +614,7 @@ different from the volume specified by {\it pathBase}).
 
 \helpref{Normalize}{wxfilenamenormalize}
 
 
 \helpref{Normalize}{wxfilenamenormalize}
 

+

 \membersection{wxFileName::Mkdir}\label{wxfilenamemkdir}
 
 \func{bool}{Mkdir}{\param{int }{perm = 0777}, \param{int }{flags = $0$}}
 \membersection{wxFileName::Mkdir}\label{wxfilenamemkdir}
 
 \func{bool}{Mkdir}{\param{int }{perm = 0777}, \param{int }{flags = $0$}}


@@ -567,6 +634,7 @@ if the target directory already exists.}
 Returns {\tt true} if the directory was successfully created, {\tt false}
 otherwise.
 
 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}}
 \membersection{wxFileName::Normalize}\label{wxfilenamenormalize}
 
 \func{bool}{Normalize}{\param{int }{flags = wxPATH\_NORM\_ALL}, \param{const wxString\& }{cwd = wxEmptyString}, \param{wxPathFormat }{format = wxPATH\_NATIVE}}


@@ -581,10 +649,11 @@ any or-combination of the following constants:
 \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\_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 case insensitive => tolower}
+\twocolitem{{\bf wxPATH\_NORM\_CASE}}{if filesystem is case insensitive, transform to tolower 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\_ABSOLUTE}}{make the path absolute}
 \twocolitem{{\bf wxPATH\_NORM\_LONG}}{make the path the long form}

-\twocolitem{{\bf wxPATH\_NORM\_ALL}}{all of previous flags}
+\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}
 }
 
 \end{twocollist}
 }
 


@@ -593,11 +662,15 @@ working directory in normalization.}
 
 \docparam{format}{The file name format, native by default.}
 
 
 \docparam{format}{The file name format, native by default.}
 

+

 \membersection{wxFileName::PrependDir}\label{wxfilenameprependdir}
 
 \func{void}{PrependDir}{\param{const wxString\& }{dir}}
 
 \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}
 
 
 \membersection{wxFileName::RemoveDir}\label{wxfilenameremovedir}
 


@@ -605,6 +678,7 @@ Prepends a directory name.
 
 Removes a directory name.
 
 
 Removes a directory name.
 

+

 \membersection{wxFileName::Rmdir}\label{wxfilenamermdir}
 
 \func{bool}{Rmdir}{\void}
 \membersection{wxFileName::Rmdir}\label{wxfilenamermdir}
 
 \func{bool}{Rmdir}{\void}


@@ -613,12 +687,14 @@ Removes a directory name.
 
 Deletes the specified directory from the file system.
 
 
 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::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}
 \membersection{wxFileName::SetCwd}\label{wxfilenamesetcwd}
 
 \func{bool}{SetCwd}{\void}


@@ -627,36 +703,42 @@ Compares the filename using the rules of this platform.
 
 Changes the current working directory.
 
 
 Changes the current working directory.
 

+

 \membersection{wxFileName::SetExt}\label{wxfilenamesetext}
 
 \func{void}{SetExt}{\param{const wxString\& }{ext}}
 
 Sets the extension of this file name.
 
 \membersection{wxFileName::SetExt}\label{wxfilenamesetext}
 
 \func{void}{SetExt}{\param{const wxString\& }{ext}}
 
 Sets the extension of this file name.
 

+

 \membersection{wxFileName::SetFullName}\label{wxfilenamesetfullname}
 
 \func{void}{SetFullName}{\param{const wxString\& }{fullname}}
 
 The full name is the file name and extension (but without the path).
 
 \membersection{wxFileName::SetFullName}\label{wxfilenamesetfullname}
 
 \func{void}{SetFullName}{\param{const wxString\& }{fullname}}
 
 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.
 
 \membersection{wxFileName::SetName}\label{wxfilenamesetname}
 
 \func{void}{SetName}{\param{const wxString\& }{name}}
 
 Sets the name.
 

+

 \membersection{wxFileName::SetTimes}\label{wxfilenamesettimes}
 
 \func{bool}{SetTimes}{\param{const wxDateTime* }{dtAccess}, \param{const wxDateTime* }{dtMod}, \param{const wxDateTime* }{dtCreate}}
 
 Sets the file creation and last access/modification times (any of the pointers may be NULL).
 
 \membersection{wxFileName::SetTimes}\label{wxfilenamesettimes}
 
 \func{bool}{SetTimes}{\param{const wxDateTime* }{dtAccess}, \param{const wxDateTime* }{dtMod}, \param{const wxDateTime* }{dtCreate}}
 
 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::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{wxPathFormat }{format = wxPATH\_NATIVE}}
 \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{wxPathFormat }{format = wxPATH\_NATIVE}}


@@ -675,12 +757,14 @@ 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}).
 
 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::Touch}\label{wxfilenametouch}
 
 \func{bool}{Touch}{\void}
 
 Sets the access and modification times to the current moment.
 
 \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}}
 \membersection{wxFileName::operator=}\label{wxfilenameoperatorassign}
 
 \func{wxFileName\& operator}{operator=}{\param{const wxFileName\& }{filename}}


@@ -689,6 +773,7 @@ Sets the access and modification times to the current moment.
 
 Assigns the new value to this filename object.
 
 
 Assigns the new value to this filename object.
 

+

 \membersection{wxFileName::operator==}\label{wxfilenameoperatorequal}
 
 \constfunc{bool operator}{operator==}{\param{const wxFileName\& }{filename}}
 \membersection{wxFileName::operator==}\label{wxfilenameoperatorequal}
 
 \constfunc{bool operator}{operator==}{\param{const wxFileName\& }{filename}}


@@ -698,6 +783,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.
 
 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}}
 \membersection{wxFileName::operator!=}\label{wxfilenameoperatornotequal}
 
 \constfunc{bool operator}{operator!=}{\param{const wxFileName\& }{filename}}