// This is the SIP interface definition for QRegExp.
//
// 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>QRegExp</Title>
<Para>
The Python <Literal>==</Literal> and <Literal>!=</Literal> operators are
supported.
</Para>

<FuncSynopsis>
        <FuncDef>int <Function>match</Function></FuncDef>
        <ParamDef>const char *<Parameter>str</Parameter></ParamDef>
        <ParamDef>int <Parameter>index</Parameter> = 0</ParamDef>
        <ParamDef>int *<Parameter>len</Parameter> = 0</ParamDef>
</FuncSynopsis>
<Para>
This takes <Literal>str</Literal> and <Literal>index</Literal> parameters and
returns a tuple of the <Literal>int</Literal> result and the
<Literal>len</Literal> value. (Qt v1.x)
</Para>

<FuncSynopsis>
        <FuncDef>int <Function>match</Function></FuncDef>
        <ParamDef>const QString &<Parameter>str</Parameter></ParamDef>
        <ParamDef>int <Parameter>index</Parameter> = 0</ParamDef>
        <ParamDef>int *<Parameter>len</Parameter> = 0</ParamDef>
</FuncSynopsis>
<Para>
This takes <Literal>str</Literal> and <Literal>index</Literal> parameters and
returns a tuple of the <Literal>int</Literal> result and the
<Literal>len</Literal> value. (Qt v2+)
</Para>
</Sect2>
%End


class QRegExp
{
%TypeHeaderCode
#include <qregexp.h>
%End

public:
%If (Qt_3_1_0 -)
	enum CaretMode {
		CaretAtZero,
		CaretAtOffset,
		CaretWontMatch
	};
%End

	QRegExp();
%If (- Qt_2_00)
	QRegExp(const char *,bool = 1,bool = 0);
%End
%If (Qt_2_00 -)
	QRegExp(const QString &,bool = 1,bool = 0);
%End
	QRegExp(const QRegExp &);

	bool operator==(const QRegExp &) const;
	bool operator!=(const QRegExp &) const;

	bool isEmpty() const;
	bool isValid() const;
%If (- Qt_2_00)
	const char *pattern() const;
%End
%If (Qt_2_00 -)
	QString pattern() const;
%End
%If (Qt_2_2_0 -)
	void setPattern(const QString &);
%End
	bool caseSensitive() const;
	void setCaseSensitive(bool);
	bool wildcard() const;
	void setWildcard(bool);
%If (Qt_3_0_0 -)
	bool minimal() const;
	void setMinimal(bool);

	bool exactMatch(const QString &) const;
%End

%If (- Qt_2_00)
	int match(const char *,int = 0,int * = 0) const;
%End
%If (Qt_2_00 - Qt_3_0_0)
	int match(const QString &,int = 0,int * = 0) const;
%End

%If (Qt_2_2_0 - Qt_3_0_0)
	int find(const QString &,int);
%End

%If (Qt_3_0_0 -)
	int search(const QString &,int = 0) const;
%If (Qt_3_1_0 -)
	int search(const QString &,int,CaretMode) const;
%End
	int searchRev(const QString &,int = -1) const;
%If (Qt_3_1_0 -)
	int searchRev(const QString &,int,CaretMode) const;
%End
	int matchedLength() const;
%If (Qt_3_1_0 -)
	int numCaptures() const;
%End
	QStringList capturedTexts();
	QString cap(int = 0);
	int pos(int = 0);
%End
%If (Qt_3_1_0 -)
	QString errorString();

	static QString escape(const QString &);
%End
};
