X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/33b97389e59de9b2acd902a334c08976c7d83d44..146ba0feacf1222ec8a45dfd69dae77b063bf2cf:/docs/latex/wx/filename.tex?ds=sidebyside

diff --git a/docs/latex/wx/filename.tex b/docs/latex/wx/filename.tex
index 8bc66c81c0..6ef816952b 100644
--- a/docs/latex/wx/filename.tex
+++ b/docs/latex/wx/filename.tex
@@ -379,11 +379,11 @@ convenience wrapper: get just the last mod time of the file
 Return the path part of the filename (without the name nor extension). The
 possible flags values are:
 
-\twocolwidtha{5cm}%
+\twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt
-\twocolitem{\tt wxPATH\_GET\_VOLUME}{Return the path with the volume (does
+\twocolitem{{\bf 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
+\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}
@@ -407,7 +407,7 @@ method.
 
 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
+DOS and Windows both {\tt '/'} and {\tt '\textbackslash'} may be used as
 separators.
 
 \wxheading{See also}
@@ -432,14 +432,28 @@ Return the short form of the path (returns identity on non-Windows platforms)
 
 \constfunc{bool}{GetTimes}{\param{wxDateTime* }{dtAccess}, \param{wxDateTime* }{dtMod}, \param{wxDateTime* }{dtCreate}}
 
-return the last access, last modification and creation times
-(any of the pointers may be NULL)
+Return the last access, last modification and creation times. The last access
+time is updated whenever the file is read or written (or executed in the case
+of Windows), last modification time is only changed when the file is written
+to. Finally, the creation time is indeed the time when the file was created
+under Windows and the inode change time under Unix (as it is impossible to
+retrieve the real file creation time there anyhow) which can also be changed
+by many operations after the file creation.
+
+Aany of the pointers may be {\tt NULL} if the corresponding time is not
+needed.
 
+\wxheading{Return value}
+
+{\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
+doesn't have one or if the file system doesn't support volumes at all (for
+example, Unix).
 
 \membersection{wxFileName::GetVolumeSeparator}\label{wxfilenamegetvolumeseparator}
 
@@ -539,15 +553,17 @@ different from the volume specified by {\it pathBase}).
 
 \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{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}
 
@@ -631,12 +647,21 @@ set the file creation and last access/mod times
 
 \membersection{wxFileName::SplitPath}\label{wxfilenamesplitpath}
 
-\func{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* }{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}}
 
-\func{void}{SplitPath}{\param{const wxString\& }{fullpath}, \param{wxString* }{path}, \param{wxString* }{name}, \param{wxString* }{ext}, \param{wxPathFormat }{format = wxPATH\_NATIVE}}
+This function splits a full file name into components: the volume (with the
+first version) path (including the volume in the second version), the base name
+and the extension. Any of the output parameters ({\it volume}, {\it path}, 
+{\it name} or {\it ext}) may be {\tt NULL} if you are not interested in the
+value of a particular component. Also, {\it fullpath} may be empty on entry.
 
-split a fullpath into the volume, path, (base) name and extension
-(all of the pointers can be NULL)
+On return, {\it path} contains the file path (without the trailing separator), 
+{\it name} contains the file name and {\it ext} contains the file extension
+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}).
 
 \membersection{wxFileName::Touch}\label{wxfilenametouch}