// This is the SIP interface definition for QDataStream.
//
// Copyright (c) 2007
// 	Riverbank Computing Limited <info@riverbankcomputing.co.uk>
// 
// This file is part of PyQt.
// 
// This copy of PyQt is free software; you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the Free
// Software Foundation; either version 2, or (at your option) any later
// version.
// 
// PyQt is supplied in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
// details.
// 
// You should have received a copy of the GNU General Public License along with
// PyQt; see the file LICENSE.  If not, write to the Free Software Foundation,
// Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.


%ExportedDoc
<Sect2><Title>QDataStream</Title>
<FuncSynopsis>
	<FuncDef>QDataStream &amp;<Function>readBytes</Function></FuncDef>
	<ParamDef>const char *&amp;<Parameter>s</Parameter></ParamDef>
	<ParamDef>uint &amp;<Parameter>l</Parameter></ParamDef>
</FuncSynopsis>
<Para>
This takes no parameters.  The <Literal>QDataStream</Literal> result and the
data read are returned as a tuple.
</Para>

<FuncSynopsis>
	<FuncDef>QDataStream &amp;<Function>readRawBytes</Function></FuncDef>
	<ParamDef>const char *<Parameter>s</Parameter></ParamDef>
	<ParamDef>uint <Parameter>l</Parameter></ParamDef>
</FuncSynopsis>
<Para>
This takes only the <Literal>l</Literal> parameter.  The
<Literal>QDataStream</Literal> result and the data read are returned as a
tuple.
</Para>

<FuncSynopsis>
	<FuncDef>QDataStream &amp;<Function>writeBytes</Function></FuncDef>
	<ParamDef>const char *<Parameter>s</Parameter></ParamDef>
	<ParamDef>uint <Parameter>len</Parameter></ParamDef>
</FuncSynopsis>
<Para>
<Literal>len</Literal> is derived from <Literal>s</Literal> and not passed as a
parameter.
</Para>

<FuncSynopsis>
	<FuncDef>QDataStream &amp;<Function>writeRawBytes</Function></FuncDef>
	<ParamDef>const char *<Parameter>s</Parameter></ParamDef>
	<ParamDef>uint <Parameter>len</Parameter></ParamDef>
</FuncSynopsis>
<Para>
<Literal>len</Literal> is derived from <Literal>s</Literal> and not passed as a
parameter.
</Para>
</Sect2>
%End


class QDataStream
{
%TypeHeaderCode
#include <qdatastream.h>
%End

public:
	QDataStream();
	QDataStream(QIODevice *);
	QDataStream(QByteArray,int);

	QIODevice *device() const;
	void setDevice(QIODevice *);
	void unsetDevice();
%If (Qt_2_00 -)
	bool atEnd() const;
%End
	bool eof() const;

	enum ByteOrder {
		BigEndian,
		LittleEndian
	};

	int byteOrder() const;
	void setByteOrder(int);
	bool isPrintableData() const;
	void setPrintableData(bool);
	int version() const;
	void setVersion(int);

	SIP_PYTUPLE readBytes() /ReleaseGIL/;
%MethodCode
		char *c;
		uint l;

		Py_BEGIN_ALLOW_THREADS
		sipCpp -> QDataStream::readBytes(c,l);
		Py_END_ALLOW_THREADS

		sipRes = sipBuildResult(&sipIsErr,"(Sa)",sipSelf,c,l);

		if (c)
			delete[] c;
%End

	SIP_PYTUPLE readRawBytes(uint) /ReleaseGIL/;
%MethodCode
		char *buf;
 
		if ((buf = (char *)sipMalloc(a0)) == NULL)
			sipIsErr = 1;
		else
		{
			Py_BEGIN_ALLOW_THREADS
			sipCpp -> QDataStream::readRawBytes(buf,a0);
			Py_END_ALLOW_THREADS

                        sipRes = sipBuildResult(&sipIsErr,"(Sa)",sipSelf,buf,a0);
 
                        sipFree((ANY *)buf);
                }
%End

	QDataStream &writeBytes(const char * /Array/,
				uint /ArraySize/) /ReleaseGIL/;
	QDataStream &writeRawBytes(const char * /Array/,
				   uint /ArraySize/) /ReleaseGIL/;

%If (Qt_3_0_0 -)
	// These are taken from the corresponding class definitions.  We limit
	// them to Qt v3.0.0 and later just to avoid checking earlier versions.

	QDataStream &operator<<(const QBrush &);
	QDataStream &operator>>(QBrush & /Constrained/);

	QDataStream &operator<<(const QColor &);
	QDataStream &operator>>(QColor & /Constrained/);

	QDataStream &operator<<(const QByteArray &);
	QDataStream &operator>>(QByteArray & /Constrained/);

	QDataStream &operator<<(const QCString &);
	QDataStream &operator>>(QCString & /Constrained/);

	QDataStream &operator<<(const QCursor &);
	QDataStream &operator>>(QCursor & /Constrained/);

	QDataStream &operator<<(const QDate &);
	QDataStream &operator>>(QDate & /Constrained/);

	QDataStream &operator<<(const QTime &);
	QDataStream &operator>>(QTime & /Constrained/);

	QDataStream &operator<<(const QDateTime &);
	QDataStream &operator>>(QDateTime & /Constrained/);

	QDataStream &operator<<(const QFont &);
	QDataStream &operator>>(QFont & /Constrained/);

	QDataStream &operator<<(const QImage &);
	QDataStream &operator>>(QImage & /Constrained/);

	QDataStream &operator<<(const QKeySequence &);
	QDataStream &operator>>(QKeySequence & /Constrained/);

	QDataStream &operator<<(const QColorGroup &);
	QDataStream &operator>>(QColorGroup & /Constrained/);

	QDataStream &operator<<(const QPalette &);
	QDataStream &operator>>(QPalette & /Constrained/);

	QDataStream &operator<<(const QPen &);
	QDataStream &operator>>(QPen & /Constrained/);

	QDataStream &operator<<(const QPicture &);
	QDataStream &operator>>(QPicture & /Constrained/);

	QDataStream &operator<<(const QPixmap &);
	QDataStream &operator>>(QPixmap & /Constrained/);

	QDataStream &operator<<(const QPointArray &);
	QDataStream &operator>>(QPointArray & /Constrained/);

	QDataStream &operator<<(const QPoint &);
	QDataStream &operator>>(QPoint & /Constrained/);

	QDataStream &operator<<(const QRect &);
	QDataStream &operator>>(QRect & /Constrained/);

	QDataStream &operator<<(const QRegion &);
	QDataStream &operator>>(QRegion & /Constrained/);

	QDataStream &operator<<(const QSize &);
	QDataStream &operator>>(QSize & /Constrained/);

	QDataStream &operator<<(const QString &);
	QDataStream &operator>>(QString & /Constrained/);

	QDataStream &operator<<(const QStringList &);
	QDataStream &operator>>(QStringList & /Constrained/);

	QDataStream &operator<<(const QVariant &);
	QDataStream &operator>>(QVariant & /Constrained/);

	QDataStream &operator<<(const QWMatrix &);
	QDataStream &operator>>(QWMatrix & /Constrained/);
%End
%If (Qt_3_1_0 -)
	QDataStream &operator<<(const QUuid &);
	QDataStream &operator>>(QUuid & /Constrained/);
%End

private:
	QDataStream(const QDataStream &);
};
