]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/filesys.tex
escape underscores and don't use abbreviations in text
[wxWidgets.git] / docs / latex / wx / filesys.tex
index 10a5c6e082e7534bfca628a0a8459f4deebd14c6..8c8b0f62152ea1c40fd0529bff80c1f305a3eb6b 100644 (file)
@@ -53,33 +53,33 @@ care about it.
 
 \membersection{wxFileSystem::ChangePathTo}\label{wxfilesystemchangepathto}
 
-\func{void}{ChangePathTo}{\param{const wxString\& }{location}, \param{bool }{is\_dir = FALSE}}
+\func{void}{ChangePathTo}{\param{const wxString\& }{location}, \param{bool }{is\_dir = false}}
 
 Sets the current location. {\it location} parameter passed to 
 \helpref{OpenFile}{wxfilesystemopenfile} is relative to this path.
 
-{\bf Caution! } Unless {\it is\_dir} is TRUE the {\it location} parameter
+{\bf Caution! } Unless {\it is\_dir} is true the {\it location} parameter
 is not the directory name but the name of the file in this directory. All these
 commands change the path to "dir/subdir/":
 
 \begin{verbatim}
   ChangePathTo("dir/subdir/xh.htm");
-  ChangePathTo("dir/subdir", TRUE);
-C  hangePathTo("dir/subdir/", TRUE);
+  ChangePathTo("dir/subdir", true);
+  ChangePathTo("dir/subdir/", true);
 \end{verbatim}
 
 \wxheading{Parameters}
 
 \docparam{location}{the new location. Its meaning depends on the value of {\it is\_dir}}
 
-\docparam{is\_dir}{if TRUE {\it location} is new directory. If FALSE (default) 
+\docparam{is\_dir}{if true {\it location} is new directory. If false (default) 
 {\it location} is {\bf file in} the new directory.}
 
 \wxheading{Example}
 
 \begin{verbatim}
   f = fs -> OpenFile("hello.htm"); // opens file 'hello.htm'
-  fs -> ChangePathTo("subdir/folder", TRUE);
+  fs -> ChangePathTo("subdir/folder", true);
   f = fs -> OpenFile("hello.htm"); // opens file 'subdir/folder/hello.htm' !!
 \end{verbatim}
 
@@ -121,11 +121,12 @@ Returns the next filename that matches parameters passed to \helpref{FindFirst}{
 Opens the file and returns a pointer to a \helpref{wxFSFile}{wxfsfile} object
 or NULL if failed. It first tries to open the file in relative scope
 (based on value passed to ChangePathTo() method) and then as an
-absolute path.
+absolute path.  Note that the user is responsible for deleting the returned
+wxFSFile.  
 
 \membersection{wxFileSystem::URLToFileName}\label{wxfilesystemurltofilename}
 
-\func{static wxFileName}{URLToFileName}{\param{const wxString& }{url}}
+\func{static wxFileName}{URLToFileName}{\param{const wxString\& }{url}}
 
 Converts URL into a well-formed filename. The URL must use the {\tt file} 
 protocol.