synchronize GTK2 minimum version in docs

[wxWidgets.git] / interface / wx / wfstream.h

diff --git a/interface/wx/wfstream.h b/interface/wx/wfstream.h
index 489551294dca0dc6f09e2bc9dc8a653509d638f3..2e3049b3ebd9be299d9587fcf1ddd0c7d20c6f3c 100644 (file)
--- a/interface/wx/wfstream.h
+++ b/interface/wx/wfstream.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxTempFileOutputStream
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxTempFileOutputStream
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**


@@ -23,6 +23,8 @@ class wxTempFileOutputStream : public wxOutputStream
 public:
     /**
         Associates wxTempFileOutputStream with the file to be replaced and opens it.
 public:
     /**
         Associates wxTempFileOutputStream with the file to be replaced and opens it.

+
+        @warning

         You should use wxStreamBase::IsOk() to verify if the constructor succeeded.
 
         Call Commit() or wxOutputStream::Close() to replace the old file and close
         You should use wxStreamBase::IsOk() to verify if the constructor succeeded.
 
         Call Commit() or wxOutputStream::Close() to replace the old file and close


@@ -55,7 +57,7 @@ public:
 
     This class represents data written to a file.
     There are actually two such groups of classes: this one is based on wxFFile
 
     This class represents data written to a file.
     There are actually two such groups of classes: this one is based on wxFFile

-    whereas wxFileInputStream is based in the wxFile class.
+    whereas wxFileOutputStream is based in the wxFile class.

 
     Note that wxOutputStream::SeekO() can seek beyond the end of the stream
     (file) and will thus not return ::wxInvalidOffset for that.
 
     Note that wxOutputStream::SeekO() can seek beyond the end of the stream
     (file) and will thus not return ::wxInvalidOffset for that.


@@ -63,16 +65,19 @@ public:
     @library{wxbase}
     @category{streams}
 
     @library{wxbase}
     @category{streams}
 

-    @see wxBufferedOutputStream, wxFFileInputStream, wxFileInputStream
+    @see wxBufferedOutputStream, wxFFileInputStream, wxFileOutputStream, wxFileInputStream

 */
 class wxFFileOutputStream : public wxOutputStream
 {
 public:
     /**
 */
 class wxFFileOutputStream : public wxOutputStream
 {
 public:
     /**

-        Initializes a file stream in write-only mode using the file descriptor @e fp.
+        Open the given file @a filename with mode @a mode.
+
+        @warning
+        You should use wxStreamBase::IsOk() to verify if the constructor succeeded.

     */
     wxFFileOutputStream(const wxString& filename,
     */
     wxFFileOutputStream(const wxString& filename,

-                        const wxString& mode = "w+b");
+                        const wxString& mode = "wb");

 
     /**
         Initializes a file stream in write-only mode using the file I/O object file.
 
     /**
         Initializes a file stream in write-only mode using the file I/O object file.


@@ -102,7 +107,7 @@ public:
 
     This class represents data written to a file.
     There are actually two such groups of classes: this one is based on wxFile
 
     This class represents data written to a file.
     There are actually two such groups of classes: this one is based on wxFile

-    whereas wxFFileInputStream is based in the wxFFile class.
+    whereas wxFFileOutputStream is based in the wxFFile class.

 
     Note that wxOutputStream::SeekO() can seek beyond the end of the stream
     (file) and will thus not return ::wxInvalidOffset for that.
 
     Note that wxOutputStream::SeekO() can seek beyond the end of the stream
     (file) and will thus not return ::wxInvalidOffset for that.


@@ -110,13 +115,16 @@ public:
     @library{wxbase}
     @category{streams}
 
     @library{wxbase}
     @category{streams}
 

-    @see wxBufferedOutputStream, wxFileInputStream, wxFFileInputStream
+    @see wxBufferedOutputStream, wxFileInputStream, wxFFileOutputStream, wxFFileInputStream

 */
 class wxFileOutputStream : public wxOutputStream
 {
 public:
     /**
 */
 class wxFileOutputStream : public wxOutputStream
 {
 public:
     /**

-        Creates a new file with ofilename name and initializes the stream in write-only mode.
+        Creates a new file with @a ofileName name and initializes the stream in write-only mode.
+
+        @warning
+        You should use wxStreamBase::IsOk() to verify if the constructor succeeded.

     */
     wxFileOutputStream(const wxString& ofileName);
 
     */
     wxFileOutputStream(const wxString& ofileName);
 


@@ -162,7 +170,10 @@ class wxFileInputStream : public wxInputStream
 {
 public:
     /**
 {
 public:
     /**

-        Opens the specified file using its ifilename name in read-only mode.
+        Opens the specified file using its @a ifileName name in read-only mode.
+
+        @warning
+        You should use wxStreamBase::IsOk() to verify if the constructor succeeded.

     */
     wxFileInputStream(const wxString& ifileName);
 
     */
     wxFileInputStream(const wxString& ifileName);
 


@@ -208,7 +219,10 @@ class wxFFileInputStream : public wxInputStream
 {
 public:
     /**
 {
 public:
     /**

-        Opens the specified file using its filename name using the specified mode.
+        Opens the specified file using its @a filename name using the specified @a mode.
+
+        @warning
+        You should use wxStreamBase::IsOk() to verify if the constructor succeeded.

     */
     wxFFileInputStream(const wxString& filename,
                        const wxString& mode = "rb");
     */
     wxFFileInputStream(const wxString& filename,
                        const wxString& mode = "rb");


@@ -239,21 +253,34 @@ public:
 /**
     @class wxFFileStream
 
 /**
     @class wxFFileStream
 

-    @todo describe this class.
+    This stream allows to both read from and write to a file using buffered
+    STDIO functions.

 
     @library{wxbase}
     @category{streams}
 
 
     @library{wxbase}
     @category{streams}
 

-    @see wxStreamBuffer
+    @see wxFFileInputStream, wxFFileOutputStream, wxFileStream

 */
 */

-class wxFFileStream : public wxFFileOutputStream
+class wxFFileStream : public wxFFileInputStream,
+                      public wxFFileOutputStream

 {
 public:
     /**
 {
 public:
     /**

-        Initializes a new file stream in read-write mode using the specified
-        @a iofilename name.
+        Initializes a new file stream in the given @a mode using the specified
+        @a iofileName name.
+
+        @warning
+        You should use wxStreamBase::IsOk() to verify if the constructor succeeded.

     */
     wxFFileStream(const wxString& iofileName, const wxString& mode = "w+b");
     */
     wxFFileStream(const wxString& iofileName, const wxString& mode = "w+b");

+
+    /**
+        Returns @true if the stream is initialized and ready.
+
+        This method returns @true if the stream can be both read from and
+        written to.
+    */
+    bool IsOk() const;

 };
 
 
 };
 
 


@@ -261,20 +288,34 @@ public:
 /**
     @class wxFileStream
 
 /**
     @class wxFileStream
 

-    @todo describe this class.
+    This class represents data that can be both read from and written to a file.
+    There are actually two such groups of classes: this one is based on wxFile
+    whereas wxFFileStream is based in the wxFFile class.

 
     @library{wxbase}
     @category{streams}
 
 
     @library{wxbase}
     @category{streams}
 

-    @see wxStreamBuffer
+    @see wxFileInputStream, wxFileOutputStream, wxFFileStream

 */
 */

-class wxFileStream : public wxFileOutputStream
+class wxFileStream : public wxFileOutputStream,
+                     public wxFileInputStream

 {
 public:
     /**
         Initializes a new file stream in read-write mode using the specified
 {
 public:
     /**
         Initializes a new file stream in read-write mode using the specified

-        @a iofilename name.
+        @a iofileName name.
+
+        @warning
+        You should use IsOk() to verify if the constructor succeeded.

     */
     wxFileStream(const wxString& iofileName);
     */
     wxFileStream(const wxString& iofileName);

+
+    /**
+        Returns @true if the stream is initialized and ready.
+
+        This method returns @true if the stream can be both read from and
+        written to.
+    */
+    bool IsOk() const;

 };
 
 };