make it explicitly clear that the len parameter of SetData() is in bytes

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

diff --git a/interface/wx/wfstream.h b/interface/wx/wfstream.h
index de501d0490d6041b2cc723c23d4d1188cccdffd4..d5c03564e4e20ee7da059088d4bc71506139ad54 100644 (file)
--- a/interface/wx/wfstream.h
+++ b/interface/wx/wfstream.h
@@ -8,10 +8,9 @@
 
 /**
     @class wxTempFileOutputStream
 
 /**
     @class wxTempFileOutputStream

-    @wxheader{wfstream.h}

 
 

-    wxTempFileOutputStream is an output stream based on wxTempFile. It
-    provides a relatively safe way to replace the contents of the
+    wxTempFileOutputStream is an output stream based on wxTempFile.
+    It provides a relatively safe way to replace the contents of the

     existing file.
 
     @library{wxbase}
     existing file.
 
     @library{wxbase}


@@ -24,44 +23,44 @@ 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.

-        You should use
-        wxStreamBase::IsOk to verify if the constructor succeeded.
-        Call Commit() or wxOutputStream::Close to
-        replace the old file and close this one. Calling Discard()
-        (or allowing the destructor to do it) will discard the changes.
+
+        @warning
+        You should use wxStreamBase::IsOk() to verify if the constructor succeeded.
+
+        Call Commit() or wxOutputStream::Close() to replace the old file and close
+        this one. Calling Discard() (or allowing the destructor to do it) will
+        discard the changes.

     */
     wxTempFileOutputStream(const wxString& fileName);
 
     /**
         Validate changes: deletes the old file of the given name and renames the new
     */
     wxTempFileOutputStream(const wxString& fileName);
 
     /**
         Validate changes: deletes the old file of the given name and renames the new

-        file to the old name. Returns @true if both actions succeeded. If @false is
-        returned it may unfortunately mean two quite different things: either that
+        file to the old name. Returns @true if both actions succeeded.
+
+        If @false is returned it may unfortunately mean two quite different things: either that

         either the old file couldn't be deleted or that the new file couldn't be renamed
         to the old name.
     */
         either the old file couldn't be deleted or that the new file couldn't be renamed
         to the old name.
     */

-    bool Commit();
+    virtual bool Commit();

 
     /**
         Discard changes: the old file contents are not changed, the temporary file is
         deleted.
     */
 
     /**
         Discard changes: the old file contents are not changed, the temporary file is
         deleted.
     */

-    void Discard();
+    virtual void Discard();

 };
 
 
 
 /**
     @class wxFFileOutputStream
 };
 
 
 
 /**
     @class wxFFileOutputStream

-    @wxheader{wfstream.h}

 
 

-    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.
+    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.

 
 

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

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


@@ -71,20 +70,29 @@ public:
 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,
                         const wxString& mode = "wb");
     */
     wxFFileOutputStream(const wxString& filename,
                         const wxString& mode = "wb");

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

     wxFFileOutputStream(wxFFile& file);
     wxFFileOutputStream(wxFFile& file);

+
+    /**
+        Initializes a file stream in write-only mode using the file descriptor fp.
+    */

     wxFFileOutputStream(FILE* fp);
     wxFFileOutputStream(FILE* fp);

-    //@}

 
     /**
         Destructor.
     */
 
     /**
         Destructor.
     */

-    ~wxFFileOutputStream();
+    virtual ~wxFFileOutputStream();

 
     /**
         Returns @true if the stream is initialized and ready.
 
     /**
         Returns @true if the stream is initialized and ready.


@@ -96,16 +104,13 @@ public:
 
 /**
     @class wxFileOutputStream
 
 /**
     @class wxFileOutputStream

-    @wxheader{wfstream.h}

 
 

-    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.
+    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.

 
 

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

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


@@ -115,19 +120,28 @@ public:
 class wxFileOutputStream : public wxOutputStream
 {
 public:
 class wxFileOutputStream : public wxOutputStream
 {
 public:

-    //@{

     /**
     /**

-        Initializes a file stream in write-only mode using the file descriptor @e fd.
+        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);

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

     wxFileOutputStream(wxFile& file);
     wxFileOutputStream(wxFile& file);

+
+    /**
+        Initializes a file stream in write-only mode using the file descriptor @e fd.
+    */

     wxFileOutputStream(int fd);
     wxFileOutputStream(int fd);

-    //@}

 
     /**
         Destructor.
     */
 
     /**
         Destructor.
     */

-    ~wxFileOutputStream();
+    virtual ~wxFileOutputStream();

 
     /**
         Returns @true if the stream is initialized and ready.
 
     /**
         Returns @true if the stream is initialized and ready.


@@ -139,16 +153,13 @@ public:
 
 /**
     @class wxFileInputStream
 
 /**
     @class wxFileInputStream

-    @wxheader{wfstream.h}

 
 

-    This class represents data read in from a file. There are actually
-    two such groups of classes: this one is based on wxFile
-    whereas wxFFileInputStream is based in
-    the wxFFile class.
+    This class represents data read in from a file.
+    There are actually two such groups of classes: this one is based on wxFile
+    whereas wxFFileInputStream is based in the wxFFile class.

 
 

-    Note that wxInputStream::SeekI
-    can seek beyond the end of the stream (file) and will thus not return
-    @e wxInvalidOffset for that.
+    Note that wxInputStream::SeekI() can seek beyond the end of the stream (file)
+    and will thus not return ::wxInvalidOffset for that.

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


@@ -158,19 +169,28 @@ public:
 class wxFileInputStream : public wxInputStream
 {
 public:
 class wxFileInputStream : public wxInputStream
 {
 public:

-    //@{

     /**
     /**

-        Initializes a file stream in read-only mode using the specified file descriptor.
+        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);

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

     wxFileInputStream(wxFile& file);
     wxFileInputStream(wxFile& file);

+
+    /**
+        Initializes a file stream in read-only mode using the specified file descriptor.
+    */

     wxFileInputStream(int fd);
     wxFileInputStream(int fd);

-    //@}

 
     /**
         Destructor.
     */
 
     /**
         Destructor.
     */

-    ~wxFileInputStream();
+    virtual ~wxFileInputStream();

 
     /**
         Returns @true if the stream is initialized and ready.
 
     /**
         Returns @true if the stream is initialized and ready.


@@ -182,16 +202,13 @@ public:
 
 /**
     @class wxFFileInputStream
 
 /**
     @class wxFFileInputStream

-    @wxheader{wfstream.h}

 
 

-    This class represents data read in from a file. There are actually
-    two such groups of classes: this one is based on wxFFile
-    whereas wxFileInputStream is based in
-    the wxFile class.
+    This class represents data read in from a file.
+    There are actually two such groups of classes: this one is based on wxFFile
+    whereas wxFileInputStream is based in the wxFile class.

 
 

-    Note that wxInputStream::SeekI
-    can seek beyond the end of the stream (file) and will thus not return
-    @e wxInvalidOffset for that.
+    Note that wxInputStream::SeekI() can seek beyond the end of the stream (file)
+    and will thus not return ::wxInvalidOffset for that.

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


@@ -201,21 +218,29 @@ public:
 class wxFFileInputStream : public wxInputStream
 {
 public:
 class wxFFileInputStream : public wxInputStream
 {
 public:

-    //@{

     /**
     /**

-        Initializes a file stream in read-only mode using the specified file pointer @e
-        fp.
+        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");

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

     wxFFileInputStream(wxFFile& file);
     wxFFileInputStream(wxFFile& file);

+
+    /**
+        Initializes a file stream in read-only mode using the specified file pointer @a fp.
+    */

     wxFFileInputStream(FILE* fp);
     wxFFileInputStream(FILE* fp);

-    //@}

 
     /**
         Destructor.
     */
 
     /**
         Destructor.
     */

-    ~wxFFileInputStream();
+    virtual ~wxFFileInputStream();

 
     /**
         Returns @true if the stream is initialized and ready.
 
     /**
         Returns @true if the stream is initialized and ready.


@@ -227,11 +252,11 @@ public:
 
 /**
     @class wxFFileStream
 
 /**
     @class wxFFileStream

-    @wxheader{wfstream.h}

 
 

+    @todo describe this class.

 
     @library{wxbase}
 
     @library{wxbase}

-    @category{FIXME}
+    @category{streams}

 
     @see wxStreamBuffer
 */
 
     @see wxStreamBuffer
 */


@@ -239,8 +264,11 @@ class wxFFileStream : public wxFFileOutputStream
 {
 public:
     /**
 {
 public:
     /**

-        Initializes a new file stream in read-write mode using the specified
-        @e 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");
 };


@@ -249,11 +277,11 @@ public:
 
 /**
     @class wxFileStream
 
 /**
     @class wxFileStream

-    @wxheader{wfstream.h}

 
 

+    @todo describe this class.

 
     @library{wxbase}
 
     @library{wxbase}

-    @category{FIXME}
+    @category{streams}

 
     @see wxStreamBuffer
 */
 
     @see wxStreamBuffer
 */


@@ -262,7 +290,10 @@ class wxFileStream : public wxFileOutputStream
 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

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

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