/////////////////////////////////////////////////////////////////////////////
// Name: wfstream.h
-// Purpose: documentation for wxTempFileOutputStream class
+// Purpose: interface of wxTempFileOutputStream
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@library{wxbase}
@category{streams}
- @seealso
- wxTempFile
+ @see wxTempFile
*/
class wxTempFileOutputStream : public wxOutputStream
{
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.
};
+
/**
@class wxFFileOutputStream
@wxheader{wfstream.h}
@library{wxbase}
@category{streams}
- @seealso
- wxBufferedOutputStream, wxFFileInputStream, wxFileInputStream
+ @see wxBufferedOutputStream, wxFFileInputStream, wxFileInputStream
*/
class wxFFileOutputStream : public wxOutputStream
{
Initializes a file stream in write-only mode using the file descriptor @e fp.
*/
wxFFileOutputStream(const wxString& filename,
- const wxString& mode="w+b");
+ const wxString& mode = "w+b");
wxFFileOutputStream(wxFFile& file);
- wxFFileOutputStream(FILE * fp);
+ wxFFileOutputStream(FILE* fp);
//@}
/**
/**
Returns @true if the stream is initialized and ready.
*/
-#define bool IsOk() /* implementation is private */
+ bool IsOk() const;
};
+
/**
@class wxFileOutputStream
@wxheader{wfstream.h}
@library{wxbase}
@category{streams}
- @seealso
- wxBufferedOutputStream, wxFileInputStream, wxFFileInputStream
+ @see wxBufferedOutputStream, wxFileInputStream, wxFFileInputStream
*/
class wxFileOutputStream : public wxOutputStream
{
/**
Returns @true if the stream is initialized and ready.
*/
-#define bool IsOk() /* implementation is private */
+ bool IsOk() const;
};
+
/**
@class wxFileInputStream
@wxheader{wfstream.h}
@library{wxbase}
@category{streams}
- @seealso
- wxBufferedInputStream, wxFileOutputStream, wxFFileOutputStream
+ @see wxBufferedInputStream, wxFileOutputStream, wxFFileOutputStream
*/
class wxFileInputStream : public wxInputStream
{
/**
Returns @true if the stream is initialized and ready.
*/
-#define bool IsOk() /* implementation is private */
+ bool IsOk() const;
};
+
/**
@class wxFFileInputStream
@wxheader{wfstream.h}
@library{wxbase}
@category{streams}
- @seealso
- wxBufferedInputStream, wxFFileOutputStream, wxFileOutputStream
+ @see wxBufferedInputStream, wxFFileOutputStream, wxFileOutputStream
*/
class wxFFileInputStream : public wxInputStream
{
wxFFileInputStream(const wxString& filename,
const wxString& mode = "rb");
wxFFileInputStream(wxFFile& file);
- wxFFileInputStream(FILE * fp);
+ wxFFileInputStream(FILE* fp);
//@}
/**
/**
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
{
};
+
/**
@class wxFileStream
@wxheader{wfstream.h}
@library{wxbase}
@category{FIXME}
- @seealso
- wxStreamBuffer
+ @see wxStreamBuffer
*/
class wxFileStream : public wxFileOutputStream
{
*/
wxFileStream(const wxString& iofileName);
};
+