corrected the example of wxMessageBox() usage

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

diff --git a/docs/latex/wx/filename.tex b/docs/latex/wx/filename.tex
index a93a18c7ef96beb53aa9ea50b68213f677556b7a..8b2e26f54d93712caffd37dcbfcb9c9adcc0eeb0 100644 (file)
--- a/docs/latex/wx/filename.tex
+++ b/docs/latex/wx/filename.tex
@@ -38,13 +38,14 @@ 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}
 
 }
 \end{verbatim}
 


@@ -189,7 +190,7 @@ 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).


@@ -261,13 +262,15 @@ The full temporary file name or an empty string on error.
 
 \func{static bool}{DirExists}{\param{const wxString\& }{dir}}
 
 
 \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 +278,24 @@ 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


@@ -322,9 +328,15 @@ Returns the directories in string array form.
 
 Returns the file name extension.
 
 
 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.
 


@@ -342,7 +354,7 @@ 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.
 


@@ -366,7 +378,7 @@ 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,7 +386,8 @@ 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.}
 \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.}


@@ -382,7 +395,7 @@ the path.}
 
 \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


@@ -395,7 +408,7 @@ method.
 
 \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


@@ -441,7 +454,7 @@ 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.
 


@@ -449,19 +462,19 @@ Returns the string separating the volume from the path for this format.
 
 \constfunc{bool}{HasExt}{\void}
 
 
 \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}
 
 
 \membersection{wxFileName::InsertDir}\label{wxfilenameinsertdir}
 


@@ -473,13 +486,13 @@ Inserts a directory before the zero-based position in the directory list.
 
 \func{bool}{IsAbsolute}{\param{wxPathFormat }{format = wxPATH\_NATIVE}}
 
 
 \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 true if the file names of this type are case-sensitive.
+Returns {\tt true} if the file names of this type are case-sensitive.

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


@@ -492,7 +505,7 @@ 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.
 


@@ -527,7 +540,7 @@ Make the file name absolute. This is a shortcut for
 
 \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