pytqt/sip/qt/qsettings.sip

// This is the SIP interface definition for QSettings.
//
// 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>QSettings (Qt v3+)</Title>
<FuncSynopsis>
	<FuncDef>bool <Function>readBoolEntry</Function></FuncDef>
	<ParamDef>const QString &amp;<Parameter>key</Parameter></ParamDef>
	<ParamDef>bool <Parameter>def</Parameter> = 0</ParamDef>
	<ParamDef>bool *<Parameter>ok</Parameter> = 0</ParamDef>
</FuncSynopsis>
<Para>
The <Literal>ok</Literal> is not passed and the returned value is a tuple of
the <Literal>bool</Literal> result and the <Literal>ok</Literal> flag.
</Para>

<FuncSynopsis>
<FuncDef>double <Function>readDoubleEntry</Function></FuncDef>
	<ParamDef>const QString &amp;<Parameter>key</Parameter></ParamDef>
	<ParamDef>double <Parameter>def</Parameter> = 0</ParamDef>
	<ParamDef>bool *<Parameter>ok</Parameter> = 0</ParamDef>
</FuncSynopsis>
<Para>
The <Literal>ok</Literal> is not passed and the returned value is a tuple of
the <Literal>double</Literal> result and the <Literal>ok</Literal> flag.
</Para>

<FuncSynopsis>
<FuncDef>QString <Function>readEntry</Function></FuncDef>
	<ParamDef>const QString &amp;<Parameter>key</Parameter></ParamDef>
	<ParamDef>const QString &amp;<Parameter>def</Parameter> = QString::null</ParamDef>
	<ParamDef>bool *<Parameter>ok</Parameter> = 0</ParamDef>
</FuncSynopsis>
<Para>
The <Literal>ok</Literal> is not passed and the returned value is a tuple of
the <Literal>QString</Literal> result and the <Literal>ok</Literal> flag.
</Para>

<FuncSynopsis>
<FuncDef>QStringList <Function>readListEntry</Function></FuncDef>
	<ParamDef>const QString &amp;<Parameter>key</Parameter></ParamDef>
	<ParamDef>bool *<Parameter>ok</Parameter> = 0</ParamDef>
</FuncSynopsis>
<Para>
The <Literal>ok</Literal> is not passed and the returned value is a tuple of
the <Literal>QStringList</Literal> result and the <Literal>ok</Literal> flag.
</Para>

<FuncSynopsis>
<FuncDef>QStringList <Function>readListEntry</Function></FuncDef>
	<ParamDef>const QString &amp;<Parameter>key</Parameter></ParamDef>
	<ParamDef>const QChar &amp;<Parameter>separator</Parameter></ParamDef>
	<ParamDef>bool *<Parameter>ok</Parameter> = 0</ParamDef>
</FuncSynopsis>
<Para>
The <Literal>ok</Literal> is not passed and the returned value is a tuple of
the <Literal>QStringList</Literal> result and the <Literal>ok</Literal> flag.
</Para>

<FuncSynopsis>
<FuncDef>int <Function>readNumEntry</Function></FuncDef>
	<ParamDef>const QString &amp;<Parameter>key</Parameter></ParamDef>
	<ParamDef>int <Parameter>def</Parameter> = 0</ParamDef>
	<ParamDef>bool *<Parameter>ok</Parameter> = 0</ParamDef>
</FuncSynopsis>
<Para>
The <Literal>ok</Literal> is not passed and the returned value is a tuple of
the <Literal>int</Literal> result and the <Literal>ok</Literal> flag.
</Para>

<FuncSynopsis>
	<FuncDef>bool <Function>writeEntry</Function></FuncDef>
	<ParamDef>const QString &amp;<Parameter>key</Parameter></ParamDef>
	<ParamDef>bool <Parameter>value</Parameter></ParamDef>
</FuncSynopsis>
<Para>
Not implemented.
</Para>
</Sect2>
%End


%If (Qt_3_0_0 -)

class QSettings
{
%TypeHeaderCode
#include <qsettings.h>
%End

public:
%If (Qt_3_1_0 -)
	enum Format {
		Native,
		Ini
	};
%End

	enum System {
		Unix,
		Windows,
		Mac
	};

%If (Qt_3_1_0 -)
	enum Scope {
		User,
		Global
	};
%End

	QSettings();
%If (Qt_3_1_0 -)
	QSettings(Format);
%End

//	bool writeEntry(const QString &,bool);
	bool writeEntry(const QString &,int /Constrained/);
	bool writeEntry(const QString &,double);
//	bool writeEntry(const QString &,const char *);
	bool writeEntry(const QString &,const QString &);
	bool writeEntry(const QString &,const QStringList &);
	bool writeEntry(const QString &,const QStringList &,const QChar &);

	QStringList entryList(const QString &) const;
	QStringList subkeyList(const QString &) const;

	QStringList readListEntry(const QString &,bool * = 0);
	QStringList readListEntry(const QString &,const QChar &,bool * = 0);
	QString readEntry(const QString &,const QString & = QString::null,
			  bool * = 0);
	int readNumEntry(const QString &,int = 0,bool * = 0);
	double readDoubleEntry(const QString &,double = 0,bool * = 0);
	bool readBoolEntry(const QString &,bool = 0,bool * = 0);

	bool removeEntry(const QString &);

	void insertSearchPath(System,const QString &);
	void removeSearchPath(System,const QString &);

%If (Qt_3_1_0 -)
	void setPath(const QString &,const QString &,Scope = Global);

	void beginGroup(const QString &);
	void endGroup();
	void resetGroup();
	QString group() const;
%End

%If (Qt_3_2_0 -)
	bool sync();
%End

private:
	QSettings(const QSettings &);
};

%End