X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/23324ae1c7938ba904770fc456d3c07764b9c5e9..a25484eb1391b53e6f0c1205af4b3a23183e512e:/interface/wfstream.h diff --git a/interface/wfstream.h b/interface/wfstream.h index ec346a8039..62c1399238 100644 --- a/interface/wfstream.h +++ b/interface/wfstream.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: wfstream.h -// Purpose: documentation for wxTempFileOutputStream class +// Purpose: interface of wxTempFileOutputStream // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -9,27 +9,25 @@ /** @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 existing file. - + @library{wxbase} @category{streams} - - @seealso - wxTempFile + + @see wxTempFile */ class wxTempFileOutputStream : public wxOutputStream { public: /** Associates wxTempFileOutputStream with the file to be replaced and opens it. - You should use + 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() + 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); @@ -51,24 +49,24 @@ public: }; + /** @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 + 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 + + Note that wxOutputStream::SeekO + can seek beyond the end of the stream (file) and will thus not return @e wxInvalidOffset for that. - + @library{wxbase} @category{streams} - - @seealso - wxBufferedOutputStream, wxFFileInputStream, wxFileInputStream + + @see wxBufferedOutputStream, wxFFileInputStream, wxFileInputStream */ class wxFFileOutputStream : public wxOutputStream { @@ -78,9 +76,9 @@ public: Initializes a file stream in write-only mode using the file descriptor @e fp. */ wxFFileOutputStream(const wxString& filename, - const wxString& mode="w+b"); - wxFFileOutputStream(wxFFile& file); - wxFFileOutputStream(FILE * fp); + const wxString& mode = "w+b"); + wxFFileOutputStream(wxFFile& file); + wxFFileOutputStream(FILE* fp); //@} /** @@ -91,28 +89,28 @@ public: /** Returns @true if the stream is initialized and ready. */ -#define bool IsOk() /* implementation is private */ + bool IsOk() const; }; + /** @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 + 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 + + Note that wxOutputStream::SeekO + can seek beyond the end of the stream (file) and will thus not return @e wxInvalidOffset for that. - + @library{wxbase} @category{streams} - - @seealso - wxBufferedOutputStream, wxFileInputStream, wxFFileInputStream + + @see wxBufferedOutputStream, wxFileInputStream, wxFFileInputStream */ class wxFileOutputStream : public wxOutputStream { @@ -122,8 +120,8 @@ public: Initializes a file stream in write-only mode using the file descriptor @e fd. */ wxFileOutputStream(const wxString& ofileName); - wxFileOutputStream(wxFile& file); - wxFileOutputStream(int fd); + wxFileOutputStream(wxFile& file); + wxFileOutputStream(int fd); //@} /** @@ -134,28 +132,28 @@ public: /** Returns @true if the stream is initialized and ready. */ -#define bool IsOk() /* implementation is private */ + bool IsOk() const; }; + /** @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 + 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 + + Note that wxInputStream::SeekI + can seek beyond the end of the stream (file) and will thus not return @e wxInvalidOffset for that. - + @library{wxbase} @category{streams} - - @seealso - wxBufferedInputStream, wxFileOutputStream, wxFFileOutputStream + + @see wxBufferedInputStream, wxFileOutputStream, wxFFileOutputStream */ class wxFileInputStream : public wxInputStream { @@ -165,8 +163,8 @@ public: Initializes a file stream in read-only mode using the specified file descriptor. */ wxFileInputStream(const wxString& ifileName); - wxFileInputStream(wxFile& file); - wxFileInputStream(int fd); + wxFileInputStream(wxFile& file); + wxFileInputStream(int fd); //@} /** @@ -177,28 +175,28 @@ public: /** Returns @true if the stream is initialized and ready. */ -#define bool IsOk() /* implementation is private */ + bool IsOk() const; }; + /** @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 + 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 + + Note that wxInputStream::SeekI + can seek beyond the end of the stream (file) and will thus not return @e wxInvalidOffset for that. - + @library{wxbase} @category{streams} - - @seealso - wxBufferedInputStream, wxFFileOutputStream, wxFileOutputStream + + @see wxBufferedInputStream, wxFFileOutputStream, wxFileOutputStream */ class wxFFileInputStream : public wxInputStream { @@ -210,8 +208,8 @@ public: */ wxFFileInputStream(const wxString& filename, const wxString& mode = "rb"); - wxFFileInputStream(wxFFile& file); - wxFFileInputStream(FILE * fp); + wxFFileInputStream(wxFFile& file); + wxFFileInputStream(FILE* fp); //@} /** @@ -222,49 +220,50 @@ public: /** Returns @true if the stream is initialized and ready. */ -#define bool IsOk() /* implementation is private */ + bool IsOk() const; }; + /** @class wxFFileStream @wxheader{wfstream.h} - - + + @library{wxbase} @category{FIXME} - - @seealso - wxStreamBuffer + + @see wxStreamBuffer */ class wxFFileStream : public wxFFileOutputStream { public: /** - Initializes a new file stream in read-write mode using the specified + Initializes a new file stream in read-write mode using the specified @e iofilename name. */ wxFFileStream(const wxString& iofileName); }; + /** @class wxFileStream @wxheader{wfstream.h} - - + + @library{wxbase} @category{FIXME} - - @seealso - wxStreamBuffer + + @see wxStreamBuffer */ class wxFileStream : public wxFileOutputStream { public: /** - Initializes a new file stream in read-write mode using the specified + Initializes a new file stream in read-write mode using the specified @e iofilename name. */ wxFileStream(const wxString& iofileName); }; +