Inkscape::IO::OutputStream Class Reference

This interface is the base of all input stream classes. More...

#include <inkscapestream.h>

Inheritance diagram for Inkscape::IO::OutputStream:

Public Member Functions
	OutputStream ()=default
	Constructor.
virtual	~OutputStream ()=default
	Destructor.
virtual void	close ()=0
	This call should.
virtual void	flush ()=0
	This call should push any pending data it might have to the destination stream.
virtual int	put (char ch)=0
	Send one byte to the destination stream.

Detailed Description

This interface is the base of all input stream classes.

Users who wish to make an OutputStream that is part of a chain should inherit from BasicOutputStream. Inherit from this class to make a destination endpoint, such as a URI or buffer.

Definition at line 162 of file inkscapestream.h.

Constructor & Destructor Documentation

OutputStream()

Inkscape::IO::OutputStream::OutputStream ( )

default

Constructor.

~OutputStream()

virtual Inkscape::IO::OutputStream::~OutputStream ( )

virtualdefault

Destructor.

Member Function Documentation

close()

virtual void Inkscape::IO::OutputStream::close ( )

pure virtual

This call should.

1. flush itself
2. close itself
3. close the destination stream

Implemented in Inkscape::IO::BufferOutputStream, Inkscape::IO::GzipOutputStream, Inkscape::IO::BasicOutputStream, Inkscape::IO::StdOutputStream, Inkscape::IO::StringOutputStream, Inkscape::IO::FileOutputStream, and Inkscape::IO::XsltOutputStream.

Referenced by Inkscape::IO::GzipOutputStream::close(), Inkscape::IO::BasicOutputStream::close(), Inkscape::IO::OutputStreamWriter::close(), Inkscape::IO::StdWriter::close(), and Inkscape::IO::XsltOutputStream::close().

flush()

virtual void Inkscape::IO::OutputStream::flush ( )

pure virtual

This call should push any pending data it might have to the destination stream.

It should NOT call flush() on the destination stream.

Implemented in Inkscape::IO::BufferOutputStream, Inkscape::IO::GzipOutputStream, Inkscape::IO::BasicOutputStream, Inkscape::IO::StdOutputStream, Inkscape::IO::StringOutputStream, Inkscape::IO::FileOutputStream, and Inkscape::IO::XsltOutputStream.

Referenced by Inkscape::IO::GzipOutputStream::flush(), Inkscape::IO::BasicOutputStream::flush(), Inkscape::IO::OutputStreamWriter::flush(), Inkscape::IO::StdWriter::flush(), Inkscape::IO::XsltOutputStream::flush(), and Inkscape::IO::pipeStream().

put()

virtual int Inkscape::IO::OutputStream::put ( char  ch )

pure virtual

Send one byte to the destination stream.

Implemented in Inkscape::IO::BufferOutputStream, Inkscape::IO::GzipOutputStream, Inkscape::IO::BasicOutputStream, Inkscape::IO::StdOutputStream, Inkscape::IO::StringOutputStream, Inkscape::IO::FileOutputStream, and Inkscape::IO::XsltOutputStream.

Referenced by Inkscape::IO::GzipOutputStream::close(), Inkscape::IO::GzipOutputStream::flush(), Inkscape::IO::XsltOutputStream::flush(), Inkscape::IO::GzipOutputStream::GzipOutputStream(), Inkscape::IO::pipeStream(), Inkscape::IO::BasicOutputStream::put(), Inkscape::IO::OutputStreamWriter::put(), and Inkscape::IO::StdWriter::put().

---

The documentation for this class was generated from the following file:

• /builds/inkscape/inkscape/src/io/stream/inkscapestream.h