compilation fix after TRUE/FALSE change

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

diff --git a/docs/latex/wx/filename.tex b/docs/latex/wx/filename.tex
index a713b4d068cb6f7b84274b6b1efdb5d68f034a01..3c0459e6489083b2415ff8b6fd104c899ef9d83a 100644 (file)
--- a/docs/latex/wx/filename.tex
+++ b/docs/latex/wx/filename.tex
@@ -94,8 +94,7 @@ does.
 
 Other functions returning information about the file format provided by this
 class are \helpref{GetVolumeSeparator}{wxfilenamegetvolumeseparator},\rtfsp
 
 Other functions returning information about the file format provided by this
 class are \helpref{GetVolumeSeparator}{wxfilenamegetvolumeseparator},\rtfsp

-\helpref{IsPathSeparator}{wxfilenameispathseparator} and\rtfsp
-\helpref{IsWild}{wxfilenameiswild}.
+\helpref{IsPathSeparator}{wxfilenameispathseparator}.

 
 \helpref{IsRelative}{wxfilenameisrelative}
 
 
 \helpref{IsRelative}{wxfilenameisrelative}
 


@@ -140,7 +139,10 @@ following functions:
 \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

-times:
+times. Note that not all filesystems under all platforms implement these times
+in the same way. For example, the access time under Windows has a resolution of
+one day (so it is really the access date and not time). The access time may be
+updated when the file is executed or not depending on the platform.

 
 \helpref{GetModificationTime}{wxfilenamegetmodificationtime}\\
 \helpref{GetTimes}{wxfilenamegettimes}\\
 
 \helpref{GetModificationTime}{wxfilenamegetmodificationtime}\\
 \helpref{GetTimes}{wxfilenamegettimes}\\


@@ -226,7 +228,7 @@ Set this file name object to the home directory.
 
 \membersection{wxFileName::AssignTempFileName}\label{wxfilenameassigntempfilename}
 
 
 \membersection{wxFileName::AssignTempFileName}\label{wxfilenameassigntempfilename}
 

-\func{void}{AssignTempFileName}{\param{const wxString\& }{prefix}}
+\func{void}{AssignTempFileName}{\param{const wxString\& }{prefix}, \param{wxFile *}{fileTemp = {\tt NULL}}}

 
 The function calls \helpref{CreateTempFileName}{wxfilenamecreatetempfilename} to
 create a temporary file and sets this object to the name of the file. If a
 
 The function calls \helpref{CreateTempFileName}{wxfilenamecreatetempfilename} to
 create a temporary file and sets this object to the name of the file. If a


@@ -241,16 +243,28 @@ Reset all components to default, uninitialized state.
 
 \membersection{wxFileName::CreateTempFileName}\label{wxfilenamecreatetempfilename}
 
 
 \membersection{wxFileName::CreateTempFileName}\label{wxfilenamecreatetempfilename}
 

-\func{static wxString}{CreateTempFileName}{\param{const wxString\& }{prefix}}
+\func{static wxString}{CreateTempFileName}{\param{const wxString\& }{prefix}, \param{wxFile *}{fileTemp = {\tt NULL}}}

 
 Returns a temporary file name starting with the given {\it prefix}. If
 the {\it prefix} is an absolute path, the temporary file is created in this
 directory, otherwise it is created in the default system directory for the
 temporary files or in the current directory.
 
 
 Returns a temporary file name starting with the given {\it prefix}. If
 the {\it prefix} is an absolute path, the temporary file is created in this
 directory, otherwise it is created in the default system directory for the
 temporary files or in the current directory.
 

-If the function succeeds, the temporary file is actually created (but not
-opened) as well. Under Unix, it will have read and write permissions for the
-owner only.
+If the function succeeds, the temporary file is actually created. If\rtfsp
+{\it fileTemp} is not {\tt NULL}, this file will be opened using the name of
+the temporary file. When possible, this is done in an atomic way ensuring that
+no race condition occurs between the temporary file name generation and opening
+it which could often lead to security compromise on the multiuser systems.
+If {\it fileTemp} is {\tt NULL}, the file is only created, but not opened.
+
+Under Unix, the temporary file will have read and write permissions for the
+owner only to minimize the security problems.
+
+\wxheading{Parameters}
+
+\docparam{prefix}{Prefix to use for the temporary file name construction}
+
+\docparam{fileTemp}{The file to open or {\tt NULL} to just get the name}

 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 


@@ -360,17 +374,45 @@ convenience wrapper: get just the last mod time of the file
 
 \membersection{wxFileName::GetPath}\label{wxfilenamegetpath}
 
 
 \membersection{wxFileName::GetPath}\label{wxfilenamegetpath}
 

-\constfunc{wxString}{GetPath}{\param{bool }{add\_separator = FALSE}, \param{wxPathFormat }{format = wxPATH\_NATIVE}}
+\constfunc{wxString}{GetPath}{\param{int }{flags = $0$}, \param{wxPathFormat }{format = wxPATH\_NATIVE}}
+
+Return the path part of the filename (without the name nor extension). The
+possible flags values are:
+
+\twocolwidtha{5cm}%
+\begin{twocollist}\itemsep=0pt
+\twocolitem{\tt wxPATH\_GET\_VOLUME}{Return the path with the volume (does
+nothing for the filename formats without volumes)}
+\twocolitem{\tt 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}

 
 

-Construct path only - possibly with the trailing separator
+\membersection{wxFileName::GetPathSeparator}\label{wxfilenamegetpathseparator}

 
 

+\func{wxChar}{GetPathSeparator}{\param{wxPathFormat }{format = wxPATH\_NATIVE}}
+
+Return 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
+are two of them and the native one, i.e. the backslash is returned by this
+method.
+
+\wxheading{See also}
+
+\helpref{GetPathSeparators}{wxfilenamegetpathseparators}

 
 \membersection{wxFileName::GetPathSeparators}\label{wxfilenamegetpathseparators}
 
 \func{wxString}{GetPathSeparators}{\param{wxPathFormat }{format = wxPATH\_NATIVE}}
 
 
 \membersection{wxFileName::GetPathSeparators}\label{wxfilenamegetpathseparators}
 
 \func{wxString}{GetPathSeparators}{\param{wxPathFormat }{format = wxPATH\_NATIVE}}
 

-get the string of path separators for this format
+Get 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
+DOS and Windows both {\tt '/'} and {\tt '\backslash'} may be used as
+separators.
+
+\wxheading{See also}

 
 

+\helpref{GetPathSeparator}{wxfilenamegetpathseparator}

 
 \membersection{wxFileName::GetPathWithSep}\label{wxfilenamegetpathwithsep}
 
 
 \membersection{wxFileName::GetPathWithSep}\label{wxfilenamegetpathwithsep}
 


@@ -388,9 +430,9 @@ Return the short form of the path (returns identity on non-Windows platforms)
 
 \membersection{wxFileName::GetTimes}\label{wxfilenamegettimes}
 
 
 \membersection{wxFileName::GetTimes}\label{wxfilenamegettimes}
 

-\constfunc{bool}{GetTimes}{\param{wxDateTime* }{dtAccess}, \param{wxDateTime* }{dtMod}, \param{wxDateTime* }{dtChange}}
+\constfunc{bool}{GetTimes}{\param{wxDateTime* }{dtAccess}, \param{wxDateTime* }{dtMod}, \param{wxDateTime* }{dtCreate}}

 
 

-return the last access, last modification and last change times
+return the last access, last modification and creation times

 (any of the pointers may be NULL)
 
 
 (any of the pointers may be NULL)
 
 


@@ -462,11 +504,15 @@ Returns {\tt TRUE} if the char is a path separator for this format.
 
 Returns {\tt TRUE} if this filename is not absolute.
 
 
 Returns {\tt TRUE} if this filename is not absolute.
 

-\membersection{wxFileName::IsWild}\label{wxfilenameiswild}
+\membersection{wxFileName::IsDir}\label{wxfilenameisdir}

 
 

-\func{bool}{IsWild}{\param{wxPathFormat }{format = wxPATH\_NATIVE}}
+\constfunc{bool}{IsDir}{\void}

 
 

-FIXME: what exactly does this do?
+Returns {\tt TRUE} if this object represents a directory, {\tt FALSE} otherwise
+(i.e. if it is a file). Note that this method doesn't test whether the
+directory or file really exists, you should use 
+\helpref{DirExists}{wxfilenamedirexists} or 
+\helpref{FileExists}{wxfilenamefileexists} for this.

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


@@ -493,15 +539,17 @@ different from the volume specified by {\it pathBase}).
 
 \membersection{wxFileName::Mkdir}\label{wxfilenamemkdir}
 
 
 \membersection{wxFileName::Mkdir}\label{wxfilenamemkdir}
 

-\func{bool}{Mkdir}{\param{int }{perm = 0777}, \param{bool }{full = FALSE}}
+\func{bool}{Mkdir}{\param{int }{perm = 0777}, \param{int }{flags = $0$}}

 
 

-\func{static bool}{Mkdir}{\param{const wxString\& }{dir}, \param{int }{perm = 0777}, \param{bool }{full = FALSE}}
+\func{static bool}{Mkdir}{\param{const wxString\& }{dir}, \param{int }{perm = 0777}, \param{int }{flags = $0$}}

 
 \docparam{dir}{the directory to create}
 
 \docparam{parm}{the permissions for the newly created directory}
 
 
 \docparam{dir}{the directory to create}
 
 \docparam{parm}{the permissions for the newly created directory}
 

-\docparam{full}{if {\tt TRUE}, will try to make each directory in the path}
+\docparam{flags}{if the flags contain {\tt wxPATH\_MKDIR\_FULL} flag,
+try to create each directory in the path and also don't return an error
+if the target directory already exists.}

 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 


@@ -510,7 +558,7 @@ otherwise.
 
 \membersection{wxFileName::Normalize}\label{wxfilenamenormalize}
 
 
 \membersection{wxFileName::Normalize}\label{wxfilenamenormalize}
 

-\func{bool}{Normalize}{\param{wxPathNormalize }{flags = wxPATH\_NORM\_ALL}, \param{const wxString\& }{cwd = wxEmptyString}, \param{wxPathFormat }{format = wxPATH\_NATIVE}}
+\func{bool}{Normalize}{\param{int }{flags = wxPATH\_NORM\_ALL}, \param{const wxString\& }{cwd = wxEmptyString}, \param{wxPathFormat }{format = wxPATH\_NATIVE}}

 
 operations on the path
 normalize the path: with the default flags value, the path will be
 
 operations on the path
 normalize the path: with the default flags value, the path will be


@@ -572,7 +620,7 @@ full name is the file name + extension (but without the path)
 
 \membersection{wxFileName::SetTimes}\label{wxfilenamesettimes}
 
 
 \membersection{wxFileName::SetTimes}\label{wxfilenamesettimes}
 

-\func{bool}{SetTimes}{\param{const wxDateTime* }{dtCreate}, \param{const wxDateTime* }{dtAccess}, \param{const wxDateTime* }{dtMod}}
+\func{bool}{SetTimes}{\param{const wxDateTime* }{dtAccess}, \param{const wxDateTime* }{dtMod}, \param{const wxDateTime* }{dtCreate}}

 
 set the file creation and last access/mod times
 (any of the pointers may be NULL)
 
 set the file creation and last access/mod times
 (any of the pointers may be NULL)