summaryrefslogtreecommitdiffstats
path: root/sip/qt/qsettings.sip
blob: 122593e42efdd2de20df118a92f0c60859d76d57 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
// 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