Version: 3.0.2
wxFilterOutputStream Class Reference

#include <wx/stream.h>

+ Inheritance diagram for wxFilterOutputStream:

Detailed Description

A filter stream has the capability of a normal stream but it can be placed on top of another stream.

So, for example, it can compress, encrypt the data which are passed to it and write them to another stream.

Note
The use of this class is exactly the same as of wxOutputStream. Only a constructor differs and it is documented below.

Library:  wxBase
Category:  Streams
See Also
wxFilterClassFactory, wxFilterInputStream

Public Member Functions

 wxFilterOutputStream (wxOutputStream &stream)
 Initializes a "filter" stream.
 
 wxFilterOutputStream (wxOutputStream *stream)
 Initializes a "filter" stream.
 
- Public Member Functions inherited from wxOutputStream
 wxOutputStream ()
 Creates a dummy wxOutputStream object.
 
virtual ~wxOutputStream ()
 Destructor.
 
virtual bool Close ()
 Closes the stream, returning false if an error occurs.
 
virtual size_t LastWrite () const
 Returns the number of bytes written during the last Write().
 
void PutC (char c)
 Puts the specified character in the output queue and increments the stream position.
 
virtual wxFileOffset SeekO (wxFileOffset pos, wxSeekMode mode=wxFromStart)
 Changes the stream current position.
 
virtual wxFileOffset TellO () const
 Returns the current stream position.
 
virtual wxOutputStreamWrite (const void *buffer, size_t size)
 Writes up to the specified amount of bytes using the data of buffer.
 
wxOutputStreamWrite (wxInputStream &stream_in)
 Reads data from the specified input stream and stores them in the current stream.
 
bool WriteAll (const void *buffer, size_t size)
 Writes exactly the specified number of bytes from the buffer.
 
- Public Member Functions inherited from wxStreamBase
 wxStreamBase ()
 Creates a dummy stream object.
 
virtual ~wxStreamBase ()
 Destructor.
 
wxStreamError GetLastError () const
 This function returns the last error.
 
virtual wxFileOffset GetLength () const
 Returns the length of the stream in bytes.
 
virtual size_t GetSize () const
 This function returns the size of the stream.
 
virtual bool IsOk () const
 Returns true if no error occurred on the stream.
 
virtual bool IsSeekable () const
 Returns true if the stream supports seeking to arbitrary offsets.
 
void Reset (wxStreamError error=wxSTREAM_NO_ERROR)
 Resets the stream state.
 
bool operator! () const
 Returns the opposite of IsOk().
 

Additional Inherited Members

- Protected Member Functions inherited from wxOutputStream
size_t OnSysWrite (const void *buffer, size_t bufsize)
 Internal function.
 

Constructor & Destructor Documentation

wxFilterOutputStream::wxFilterOutputStream ( wxOutputStream stream)

Initializes a "filter" stream.

If the parent stream is passed as a pointer then the new filter stream takes ownership of it. If it is passed by reference then it does not.

wxFilterOutputStream::wxFilterOutputStream ( wxOutputStream stream)

Initializes a "filter" stream.

If the parent stream is passed as a pointer then the new filter stream takes ownership of it. If it is passed by reference then it does not.