]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/fsfile.tex
another patch bring the docs more up to date (patch 1717776)
[wxWidgets.git] / docs / latex / wx / fsfile.tex
index 0ce31a68b5586cd2b2afe36caff4d98390404305..50b13411d4d83b3ca409bea1ba1d2198f22b80b1 100644 (file)
@@ -9,10 +9,10 @@ This class represents a single file opened by \helpref{wxFileSystem}{wxfilesyste
 It provides more information than wxWindow's input stream 
 (stream, filename, mime type, anchor).
 
-{\bf Note:} Any pointer returned by wxFSFile's member is valid
-only as long as wxFSFile object exists. For example a call to GetStream()
+{\bf Note:} Any pointer returned by a method of wxFSFile is valid
+only as long as the wxFSFile object exists. For example a call to GetStream()
 doesn't {\it create} the stream but only returns the pointer to it. In
-other words after 10 calls to GetStream() you'll obtain ten identical
+other words after 10 calls to GetStream() you will have obtained ten identical
 pointers.
 
 \wxheading{Derived from}
@@ -33,7 +33,7 @@ pointers.
 
 \membersection{wxFSFile::wxFSFile}\label{wxfsfilewxfsfile}
 
-\func{}{wxFSFile}{\param{wxInputStream }{*stream}, \param{const wxString\& }{loc}, \param{const wxString\& }{mimetype}, \param{const wxString\& }{anchor}}
+\func{}{wxFSFile}{\param{wxInputStream }{*stream}, \param{const wxString\& }{loc}, \param{const wxString\& }{mimetype}, \param{const wxString\& }{anchor}, \param{wxDateTime }{modif}}
 
 Constructor. You probably won't use it. See Notes for details.
 
@@ -52,7 +52,7 @@ functions.
 
 \wxheading{Notes}
 
-It is seldom used by the application programmer but you'll need it if
+It is seldom used by the application programmer but you will need it if
 you are writing your own virtual FS. For example you may need something
 similar to wxMemoryInputStream, but because wxMemoryInputStream
 doesn't free the memory when destroyed and thus passing a memory stream
@@ -71,6 +71,15 @@ class wxMyFSFile : public wxFSFile
 };
 \end{verbatim}
 
+\membersection{wxFSFile::DetachStream}\label{wxfsfiledetachstream}
+
+\func{void}{DetachStream}{\void}
+
+Detaches the stream from the wxFSFile object. That is, the
+stream obtained with {\tt GetStream()} will continue its existance
+after the wxFSFile object is deleted. You will have to delete
+the stream yourself.
+
 \membersection{wxFSFile::GetAnchor}\label{wxfsfilegetanchor}
 
 \constfunc{const wxString\&}{GetAnchor}{\void}
@@ -98,7 +107,7 @@ Returns full location of the file, including path and protocol.
 Examples : 
 
 \begin{verbatim}
-http://www.wxwindows.org
+http://www.wxwidgets.org
 http://www.ms.mff.cuni.cz/~vsla8348/wxhtml/archive.zip#zip:info.txt
 file:/home/vasek/index.htm
 relative-file.htm