summaryrefslogtreecommitdiffstats
path: root/sip/qt/qsettings.sip
blob: 3831bfddb0aafe718affd36356a1d10a80ffa168 (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
// This is the SIP interface definition for TQSettings.
//
// Copyright (c) 2007
// 	Riverbank Computing Limited <info@riverbankcomputing.co.uk>
// 
// This file is part of PyTQt.
// 
// This copy of PyTQt 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.
// 
// PyTQt 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
// PyTQt; 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>TQSettings (TQt v3+)</Title>
<FuncSynopsis>
	<FuncDef>bool <Function>readBoolEntry</Function></FuncDef>
	<ParamDef>const TQString &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 TQString &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>TQString <Function>readEntry</Function></FuncDef>
	<ParamDef>const TQString &amp;<Parameter>key</Parameter></ParamDef>
	<ParamDef>const TQString &amp;<Parameter>def</Parameter> = TQString::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>TQString</Literal> result and the <Literal>ok</Literal> flag.
</Para>

<FuncSynopsis>
<FuncDef>TQStringList <Function>readListEntry</Function></FuncDef>
	<ParamDef>const TQString &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>TQStringList</Literal> result and the <Literal>ok</Literal> flag.
</Para>

<FuncSynopsis>
<FuncDef>TQStringList <Function>readListEntry</Function></FuncDef>
	<ParamDef>const TQString &amp;<Parameter>key</Parameter></ParamDef>
	<ParamDef>const TQChar &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>TQStringList</Literal> result and the <Literal>ok</Literal> flag.
</Para>

<FuncSynopsis>
<FuncDef>int <Function>readNumEntry</Function></FuncDef>
	<ParamDef>const TQString &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 TQString &amp;<Parameter>key</Parameter></ParamDef>
	<ParamDef>bool <Parameter>value</Parameter></ParamDef>
</FuncSynopsis>
<Para>
Not implemented.
</Para>
</Sect2>
%End


class TQSettings
{
%TypeHeaderCode
#include <tqsettings.h>
%End

public:
	enum Format {
		Native,
		Ini
	};

	enum System {
		Unix,
		Windows,
		Mac
	};

	enum Scope {
		User,
		Global
	};

	TQSettings();
	TQSettings(Format);

//	bool writeEntry(const TQString &,bool);
	bool writeEntry(const TQString &,int /Constrained/);
	bool writeEntry(const TQString &,double);
//	bool writeEntry(const TQString &,const char *);
	bool writeEntry(const TQString &,const TQString &);
	bool writeEntry(const TQString &,const TQStringList &);
	bool writeEntry(const TQString &,const TQStringList &,const TQChar &);

	TQStringList entryList(const TQString &) const;
	TQStringList subkeyList(const TQString &) const;

	TQStringList readListEntry(const TQString &,bool * = 0);
	TQStringList readListEntry(const TQString &,const TQChar &,bool * = 0);
	TQString readEntry(const TQString &,const TQString & = TQString::null,
			  bool * = 0);
	int readNumEntry(const TQString &,int = 0,bool * = 0);
	double readDoubleEntry(const TQString &,double = 0,bool * = 0);
	bool readBoolEntry(const TQString &,bool = 0,bool * = 0);

	bool removeEntry(const TQString &);

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

	void setPath(const TQString &,const TQString &,Scope = Global);

	void beginGroup(const TQString &);
	void endGroup();
	void resetGroup();
	TQString group() const;

	bool sync();

private:
	TQSettings(const TQSettings &);
};