X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9690b0065472c8683a4c9fc96ed9da769776d717..92c0fc34c104c8d7c12d6a3b78ea232690fc23f4:/interface/wx/wfstream.h?ds=sidebyside diff --git a/interface/wx/wfstream.h b/interface/wx/wfstream.h index d5c03564e4..27c1a3f406 100644 --- a/interface/wx/wfstream.h +++ b/interface/wx/wfstream.h @@ -2,8 +2,7 @@ // Name: wfstream.h // Purpose: interface of wxTempFileOutputStream // Author: wxWidgets team -// RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -57,7 +56,7 @@ public: 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. @@ -65,7 +64,7 @@ public: @library{wxbase} @category{streams} - @see wxBufferedOutputStream, wxFFileInputStream, wxFileInputStream + @see wxBufferedOutputStream, wxFFileInputStream, wxFileOutputStream, wxFileInputStream */ class wxFFileOutputStream : public wxOutputStream { @@ -98,6 +97,12 @@ public: Returns @true if the stream is initialized and ready. */ bool IsOk() const; + + /** + Returns the underlying file object. + @since 2.9.5 + */ + wxFFile* GetFile() const; }; @@ -107,7 +112,7 @@ public: 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. @@ -115,14 +120,14 @@ public: @library{wxbase} @category{streams} - @see wxBufferedOutputStream, wxFileInputStream, wxFFileInputStream + @see wxBufferedOutputStream, wxFileInputStream, wxFFileOutputStream, wxFFileInputStream */ class wxFileOutputStream : public wxOutputStream { public: /** 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. */ @@ -147,6 +152,12 @@ public: Returns @true if the stream is initialized and ready. */ bool IsOk() const; + + /** + Returns the underlying file object. + @since 2.9.5 + */ + wxFile* GetFile() const; }; @@ -171,7 +182,7 @@ class wxFileInputStream : public wxInputStream public: /** 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. */ @@ -196,6 +207,12 @@ public: Returns @true if the stream is initialized and ready. */ bool IsOk() const; + + /** + Returns the underlying file object. + @since 2.9.5 + */ + wxFile* GetFile() const; }; @@ -246,6 +263,12 @@ public: Returns @true if the stream is initialized and ready. */ bool IsOk() const; + + /** + Returns the underlying file object. + @since 2.9.5 + */ + wxFFile* GetFile() const; }; @@ -253,24 +276,34 @@ public: /** @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} - @see wxStreamBuffer + @see wxFFileInputStream, wxFFileOutputStream, wxFileStream */ -class wxFFileStream : public wxFFileOutputStream +class wxFFileStream : public wxFFileInputStream, + public wxFFileOutputStream { public: /** 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"); + + /** + 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; }; @@ -278,23 +311,34 @@ public: /** @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} - @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 @a iofileName name. - + @warning - You should use wxStreamBase::IsOk() to verify if the constructor succeeded. + You should use IsOk() to verify if the constructor succeeded. */ 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; };