// This is the SIP interface definition for QTextCodec, QTextDecoder and
// QTextEncoder.
//
// 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>QTextCodec (Qt v2+)</Title>
<FuncSynopsis>
	<FuncDef>virtual QCString <Function>fromUnicode</Function></FuncDef>
	<ParamDef>const QString &amp;<Parameter>uc</Parameter></ParamDef>
	<ParamDef>int &amp;<Parameter>lenInOut</Parameter></ParamDef>
</FuncSynopsis>
<Para>
The returned value is a tuple of the <Literal>QCString</Literal> result and the
updated <Literal>lenInOut</Literal>.
</Para>
</Sect2>
 
<Sect2><Title>QTextDecoder (Qt v2+)</Title>
<Para>
<Literal>QTextDecoder</Literal> is fully implemented.
</Para>
</Sect2>
 
<Sect2><Title>QTextEncoder (Qt v2+)</Title>
<FuncSynopsis>
	<FuncDef>virtual QCString <Function>fromUnicode</Function> = 0</FuncDef>
	<ParamDef>const QString &amp;<Parameter>uc</Parameter></ParamDef>
	<ParamDef>int &amp;<Parameter>lenInOut</Parameter></ParamDef>
</FuncSynopsis>
<Para>
The returned value is a tuple of the <Literal>QCString</Literal> result and the
updated <Literal>lenInOut</Literal>.
</Para>
</Sect2>
%End


%If (Qt_2_00 -)

class QTextEncoder
{
%TypeHeaderCode
#include <qtextcodec.h>
%End

public:
	virtual QCString fromUnicode(const QString &,int & /In,Out/) = 0;
};


class QTextDecoder
{
%TypeHeaderCode
#include <qtextcodec.h>
%End

public:
	virtual QString toUnicode(const char *,int) = 0;
};


class QTextCodec
{
%TypeHeaderCode
#include <qtextcodec.h>
%End

public:
%If (Qt_CODECS)
	static QTextCodec *loadCharmap(QIODevice *);
	static QTextCodec *loadCharmapFile(QString);
%End
	static QTextCodec *codecForMib(int);
	static QTextCodec *codecForName(const char *,int = 0);
	static QTextCodec *codecForContent(const char *,int);
	static QTextCodec *codecForIndex(int);
	static QTextCodec *codecForLocale();
%If (Qt_3_0_0 -)
	static void setCodecForLocale(QTextCodec *);
%End

%If (Qt_3_1_0 -)
	static QTextCodec *codecForTr();
	static void setCodecForTr(QTextCodec *);
	static QTextCodec *codecForCStrings();
	static void setCodecForCStrings(QTextCodec *);
%End

	static void deleteAllCodecs();

	static const char *locale();

	virtual const char *name() const = 0;
%If (Qt_3_0_0 -)
	virtual const char *mimeName() const;
%End
	virtual int mibEnum() const = 0;

	virtual QTextDecoder *makeDecoder() const /Factory/;
	virtual QTextEncoder *makeEncoder() const /Factory/;

	virtual QString toUnicode(const char *,int) const;
	virtual QCString fromUnicode(const QString &,int & /In,Out/) const;
	QCString fromUnicode(const QString &) const;
	QString toUnicode(const QByteArray &,int) const;
	QString toUnicode(const QByteArray &) const;
%If (Qt_3_0_0 -)
	QString toUnicode(const QCString &,int) const;
	QString toUnicode(const QCString &) const;
%End
	QString toUnicode(const char *) const;
	virtual bool canEncode(QChar) const;
	virtual bool canEncode(const QString &) const;

	virtual int heuristicContentMatch(const char *,int) const = 0;
	virtual int heuristicNameMatch(const char *) const;

%If (Qt_3_0_0 -)
	virtual QByteArray fromUnicode(const QString &,int,int) const;
	virtual unsigned short characterFromUnicode(const QString &,int) const;
%End

protected:
	QTextCodec();
};

%End
