pytqt/sip/qtsql/qsqlcursor.sip

// This is the SIP interface definition for QSqlCursor.
//
// 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>QSqlCursor (Qt v3+)</Title>
<FuncSynopsis>
	<FuncDef>virtual int <Function>del</Function></FuncDef>
	<ParamDef>bool <Parameter>invalidate</Parameter> = TRUE</ParamDef>
</FuncSynopsis>
<Para>
This has been renamed <Literal>delRecords</Literal> in Python.
</Para>

<FuncSynopsis>
	<FuncDef>virtual int <Function>del</Function></FuncDef>
	<ParamDef>const QString &amp;<Parameter>filter</Parameter></ParamDef>
	<ParamDef>bool <Parameter>invalidate</Parameter> = TRUE</ParamDef>
</FuncSynopsis>
<Para>
This has been renamed <Literal>delRecords</Literal> in Python.
</Para>

<FuncSynopsis>
	<FuncDef>bool <Function>exec</Function></FuncDef>
	<ParamDef>const QString &amp;<Parameter>query</Parameter></ParamDef>
</FuncSynopsis>
<Para>
This has been renamed <Literal>execQuery</Literal> in Python.
</Para>
</Sect2>
%End


%If (Qt_3_0_0 -)

class QSqlCursor : QSqlRecord, QSqlQuery
{
%TypeHeaderCode
#include <qsqlcursor.h>
%End

public:
	QSqlCursor(const QString & = QString::null,bool = 1,QSqlDatabase * = 0);
	QSqlCursor(const QSqlCursor &);

	enum Mode {
		ReadOnly,
		Insert,
		Update,
		Delete,
		Writable
	};

	QVariant value(int) const;
	QVariant value(const QString &) const;
%If (Qt_3_1_0 -)
	void setValue(int,const QVariant &);
	void setValue(const QString &,const QVariant &);
%End
	virtual QSqlIndex primaryIndex(bool = 1) const;
	virtual QSqlIndex index(const QStringList &) const;
	QSqlIndex index(const QString &) const;
//	QSqlIndex index(const char *) const;
	virtual void setPrimaryIndex(const QSqlIndex &);

	virtual void append(const QSqlFieldInfo &);
	virtual void insert(int,const QSqlFieldInfo &);
	void remove(int);
	void clear();
	void setGenerated(const QString &,bool);
	void setGenerated(int,bool);

	virtual QSqlRecord *editBuffer(bool = 0);
	virtual QSqlRecord *primeInsert();
	virtual QSqlRecord *primeUpdate();
	virtual QSqlRecord *primeDelete();
	virtual int insert(bool = 1) /ReleaseGIL/;
	virtual int update(bool = 1) /ReleaseGIL/;
	virtual int del(bool = 1) /PyName=delRecords, ReleaseGIL/;

	virtual void setMode(int);
	int mode() const;
	virtual void setCalculated(const QString &,bool);
	bool isCalculated(const QString &) const;
	virtual void setTrimmed(const QString &,bool);
	bool isTrimmed(const QString &) const;

	bool isReadOnly() const;
	bool canInsert() const;
	bool canUpdate() const;
	bool canDelete() const;

	bool select() /ReleaseGIL/;
	bool select(const QSqlIndex &) /ReleaseGIL/;
	bool select(const QSqlIndex &,const QSqlIndex &) /ReleaseGIL/;
	virtual bool select(const QString &,const QSqlIndex & = QSqlIndex()) /ReleaseGIL/;

	virtual void setSort(const QSqlIndex &);
	QSqlIndex sort() const;
	virtual void setFilter(const QString &);
	QString filter() const;
	virtual void setName(const QString &,bool = 1);
	QString name() const;
	QString toString(const QString & = QString::null,
			 const QString & = ",") const;

%If (Qt_3_1_0 -)
	bool isNull(int) const;
	bool isNull(const QString &) const;
%End

protected:
	void afterSeek();
	bool exec(const QString &) /PyName=execQuery, ReleaseGIL/;

	virtual QVariant calculateField(const QString &);
	virtual int update(const QString &,bool = 1);
	virtual int del(const QString &,bool = 1) /PyName=delRecords, ReleaseGIL/;

	virtual QString	toString(const QString &,QSqlField *,
				 const QString &) const;
	virtual QString	toString(QSqlRecord *,const QString &,const QString &,
				 const QString &) const;
	virtual QString	toString(const QSqlIndex &,QSqlRecord *,
				 const QString &,const QString &,
				 const QString &) const;
};

%End