fix assert because of passing more than one border bit in style to the base class...

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

diff --git a/docs/latex/wx/filesys.tex b/docs/latex/wx/filesys.tex
index 5f28f6f0920a58c05170a993a38b45f5d7877933..ddca00a1a2f94fbdb0a5d4d8f9583dd2561a92b9 100644 (file)
--- a/docs/latex/wx/filesys.tex
+++ b/docs/latex/wx/filesys.tex
@@ -38,8 +38,10 @@ Constructor.
 
 \func{static void}{AddHandler}{\param{wxFileSystemHandler }{*handler}}
 
-This static function adds new handler into the list of handlers.
-The \helpref{handlers}{wxfilesystemhandler} provide access to virtual FS.
+This static function adds new handler into the list of 
+\helpref{handlers}{wxfilesystemhandler} which provide access to virtual FS.
+Note that if two handlers for the same protocol are added, the last one added
+takes precedence.
 
 \wxheading{Note}
 
@@ -151,7 +153,7 @@ Returns the next filename that matches parameters passed to \helpref{FindFirst}{
 
 \membersection{wxFileSystem::OpenFile}\label{wxfilesystemopenfile}
 
-\func{wxFSFile*}{OpenFile}{\param{const wxString\& }{location}}
+\func{wxFSFile*}{OpenFile}{\param{const wxString\& }{location}, \param{int }{flags = wxFS\_READ}}
 
 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
@@ -159,6 +161,22 @@ or NULL if failed. It first tries to open the file in relative scope
 absolute path.  Note that the user is responsible for deleting the returned
 wxFSFile.  
 
+{\it flags} can be one or more of the following bit values ored together:
+
+\begin{verbatim}
+// Open Bit Flags
+enum {
+    wxFS_READ = 1,      // Open for reading
+    wxFS_SEEKABLE = 4   // Returned stream will be seekable
+};
+\end{verbatim}
+
+A stream opened with just the default {\it wxFS\_READ} flag may
+or may not be seekable depending on the underlying source.
+Passing {\it wxFS\_READ | wxFS\_SEEKABLE} for {\it flags} will
+back a stream that is not natively seekable with memory or a file
+and return a stream that is always seekable.
+
 
 \membersection{wxFileSystem::URLToFileName}\label{wxfilesystemurltofilename}