X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/12f5e1e78fe906050ff2fee9529476db332633f0..d58526d55433162cef8ad2ed7f422689862c3019:/interface/wx/wfstream.h diff --git a/interface/wx/wfstream.h b/interface/wx/wfstream.h index 46939778e5..d5c03564e4 100644 --- a/interface/wx/wfstream.h +++ b/interface/wx/wfstream.h @@ -9,8 +9,8 @@ /** @class wxTempFileOutputStream - 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} @@ -23,28 +23,31 @@ class wxTempFileOutputStream : public wxOutputStream 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 - 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. */ - bool Commit(); + virtual bool Commit(); /** Discard changes: the old file contents are not changed, the temporary file is deleted. */ - void Discard(); + virtual void Discard(); }; @@ -52,14 +55,12 @@ public: /** @class wxFFileOutputStream - 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} @@ -69,20 +70,29 @@ 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"); + + /** + Initializes a file stream in write-only mode using the file I/O object file. + */ wxFFileOutputStream(wxFFile& file); + + /** + Initializes a file stream in write-only mode using the file descriptor fp. + */ wxFFileOutputStream(FILE* fp); - //@} /** Destructor. */ - ~wxFFileOutputStream(); + virtual ~wxFFileOutputStream(); /** Returns @true if the stream is initialized and ready. @@ -95,14 +105,12 @@ public: /** @class wxFileOutputStream - 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} @@ -112,19 +120,28 @@ 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); + + /** + Initializes a file stream in write-only mode using the file I/O object file. + */ wxFileOutputStream(wxFile& file); + + /** + Initializes a file stream in write-only mode using the file descriptor @e fd. + */ wxFileOutputStream(int fd); - //@} /** Destructor. */ - ~wxFileOutputStream(); + virtual ~wxFileOutputStream(); /** Returns @true if the stream is initialized and ready. @@ -137,14 +154,12 @@ public: /** @class wxFileInputStream - 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} @@ -154,19 +169,28 @@ 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); + + /** + Initializes a file stream in read-only mode using the file I/O object file. + */ wxFileInputStream(wxFile& file); + + /** + Initializes a file stream in read-only mode using the specified file descriptor. + */ wxFileInputStream(int fd); - //@} /** Destructor. */ - ~wxFileInputStream(); + virtual ~wxFileInputStream(); /** Returns @true if the stream is initialized and ready. @@ -179,14 +203,12 @@ public: /** @class wxFFileInputStream - 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} @@ -196,21 +218,29 @@ 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"); + + /** + Initializes a file stream in read-only mode using the file I/O object file. + */ wxFFileInputStream(wxFFile& file); + + /** + Initializes a file stream in read-only mode using the specified file pointer @a fp. + */ wxFFileInputStream(FILE* fp); - //@} /** Destructor. */ - ~wxFFileInputStream(); + virtual ~wxFFileInputStream(); /** Returns @true if the stream is initialized and ready. @@ -223,9 +253,10 @@ public: /** @class wxFFileStream + @todo describe this class. @library{wxbase} - @category{FIXME} + @category{streams} @see wxStreamBuffer */ @@ -233,8 +264,11 @@ class wxFFileStream : public wxFFileOutputStream { 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"); }; @@ -244,9 +278,10 @@ public: /** @class wxFileStream + @todo describe this class. @library{wxbase} - @category{FIXME} + @category{streams} @see wxStreamBuffer */ @@ -255,7 +290,10 @@ class wxFileStream : public wxFileOutputStream 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); };