]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/fsfile.tex
sorting support for generic version (patch 1765087 from Bo)
[wxWidgets.git] / docs / latex / wx / fsfile.tex
index cece4a2aef26f680464960d527d8244c05276da4..d45bcfb7269a87903758d17330178372257affa9 100644 (file)
@@ -12,7 +12,7 @@ It provides more information than wxWindow's input stream
 {\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 will obtain ten identical
+other words after 10 calls to GetStream() you will have obtained ten identical
 pointers.
 
 \wxheading{Derived from}
@@ -23,6 +23,10 @@ pointers.
 
 <wx/filesys.h>
 
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
 \wxheading{See Also}
 
 \helpref{wxFileSystemHandler}{wxfilesystemhandler}, 
@@ -33,7 +37,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.
 
@@ -43,7 +47,9 @@ Constructor. You probably won't use it. See Notes for details.
 
 \docparam{location}{The full location (aka filename) of the file}
 
-\docparam{mimetype}{MIME type of this file. Mime type is either extension-based or HTTP Content-Type}
+\docparam{mimetype}{MIME type of this file. It may be left empty, in which
+case the type will be determined from file's extension (\arg{location} must
+not be empty in this case).}
 
 \docparam{anchor}{Anchor. See \helpref{GetAnchor()}{wxfsfilegetanchor} for details.}
 
@@ -71,6 +77,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 +113,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