summaryrefslogtreecommitdiffstats
path: root/doc/html/qsettings-h.html
blob: 6c177c355b6ab3303853f01c0fad256492713243 (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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/include/qsettings.h:1 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>qsettings.h Include File</title>
<style type="text/css"><!--
fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
body { background: #ffffff; color: black; }
--></style>
</head>
<body>

<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr bgcolor="#E5E5E5">
<td valign=center>
 <a href="index.html">
<font color="#004faf">Home</font></a>
 | <a href="classes.html">
<font color="#004faf">All&nbsp;Classes</font></a>
 | <a href="mainclasses.html">
<font color="#004faf">Main&nbsp;Classes</font></a>
 | <a href="annotated.html">
<font color="#004faf">Annotated</font></a>
 | <a href="groups.html">
<font color="#004faf">Grouped&nbsp;Classes</font></a>
 | <a href="functions.html">
<font color="#004faf">Functions</font></a>
</td>
<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>qsettings.h</h1>

<p>This is the verbatim text of the qsettings.h include file. It is provided only for illustration; the copyright remains with Trolltech.
<hr>
<pre>
/****************************************************************************
** $Id: qt/qsettings.h   3.3.8   edited Jan 11 14:46 $
**
** Definition of QSettings class
**
** Created : 000626
**
** Copyright (C) 2000-2007 Trolltech ASA.  All rights reserved.
**
** This file is part of the tools module of the Qt GUI Toolkit.
**
** This file may be used under the terms of the GNU General Public
** License versions 2.0 or 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Alternatively you may (at your option) use any
** later version of the GNU General Public License if such license has
** been publicly approved by Trolltech ASA (or its successors, if any)
** and the KDE Free Qt Foundation.
**
** Please review the following information to ensure GNU General
** Public Licensing requirements will be met:
** http://trolltech.com/products/qt/licenses/licensing/opensource/.
** If you are unsure which license is appropriate for your use, please
** review the following information:
** http://trolltech.com/products/qt/licenses/licensing/licensingoverview
** or contact the sales department at sales@trolltech.com.
**
** This file may be used under the terms of the Q Public License as
** defined by Trolltech ASA and appearing in the file LICENSE.QPL
** included in the packaging of this file.  Licensees holding valid Qt
** Commercial licenses may use this file in accordance with the Qt
** Commercial License Agreement provided with the Software.
**
** This file is provided "AS IS" with NO WARRANTY OF ANY KIND,
** INCLUDING THE WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE. Trolltech reserves all rights not granted
** herein.
**
**********************************************************************/

#ifndef QSETTINGS_H
#define QSETTINGS_H

#ifndef QT_H
#include "qdatetime.h"
#include "qstringlist.h"
#endif // QT_H

#ifndef QT_NO_SETTINGS

class QSettingsPrivate;


class Q_EXPORT QSettings
{
public:
    enum Format {
	Native = 0,
	Ini
    };
    enum System {
	Unix = 0,
	Windows,
	Mac
    };
    enum Scope {
	User,
	Global
    };

    QSettings();
    QSettings( Format format );

    ~QSettings();

#if !defined(Q_NO_BOOL_TYPE)
    bool	writeEntry( const QString &amp;, bool );
#endif
    bool	writeEntry( const QString &amp;, double );
    bool	writeEntry( const QString &amp;, int );
    bool	writeEntry( const QString &amp;, const char * );
    bool	writeEntry( const QString &amp;, const QString &amp; );
    bool	writeEntry( const QString &amp;, const QStringList &amp; );
    bool	writeEntry( const QString &amp;, const QStringList &amp;, const QChar&amp; sep );

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

    //### remove non const versions in 4.0
    QStringList readListEntry( const QString &amp;, bool * = 0 );
    QStringList readListEntry( const QString &amp;, const QChar&amp; sep, bool * = 0 );
    QString	readEntry( const QString &amp;, const QString &amp;def = QString::null, bool * = 0 );
    int		readNumEntry( const QString &amp;, int def = 0, bool * = 0 );
    double	readDoubleEntry( const QString &amp;, double def = 0, bool * = 0 );
    bool	readBoolEntry( const QString &amp;, bool def = FALSE, bool * = 0 );

    //### make those non-inlined in 4.0
    QStringList readListEntry( const QString &amp;key, bool *ok = 0 ) const
    {
	QSettings *that = (QSettings*)this;
	return that-&gt;readListEntry( key, ok );
    }
    QStringList readListEntry( const QString &amp;key, const QChar&amp; sep, bool *ok = 0 ) const
    {
	QSettings *that = (QSettings*)this;
	return that-&gt;readListEntry( key, sep, ok );
    }
    QString	readEntry( const QString &amp;key, const QString &amp;def = QString::null,
			   bool *ok = 0 ) const
    {
	QSettings *that = (QSettings*)this;
	return that-&gt;readEntry( key, def, ok );
    }
    int		readNumEntry( const QString &amp;key, int def = 0, bool *ok = 0 ) const
    {
	QSettings *that = (QSettings*)this;
	return that-&gt;readNumEntry( key, def, ok );
    }

    double	readDoubleEntry( const QString &amp;key, double def = 0, bool *ok = 0 ) const
    {
	QSettings *that = (QSettings*)this;
	return that-&gt;readDoubleEntry( key, def, ok );
    }
    bool	readBoolEntry( const QString &amp;key, bool def = FALSE, bool *ok = 0 ) const
    {
	QSettings *that = (QSettings*)this;
	return that-&gt;readBoolEntry( key, def, ok );
    }

    bool	removeEntry( const QString &amp; );

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

    void setPath( const QString &amp;domain, const QString &amp;product, Scope = Global );

    void beginGroup( const QString &amp;group );
    void endGroup();
    void resetGroup();
    QString group() const;

    bool sync();

private:
    QSettingsPrivate *d;

#if defined(Q_DISABLE_COPY)
    QSettings(const QSettings &amp;);
    QSettings &amp;operator=(const QSettings &amp;);
#endif

    QDateTime lastModificationTime( const QString &amp; );

    friend class QApplication;
};

#endif // QT_NO_SETTINGS
#endif // QSETTINGS_H
</pre>
<!-- eof -->
<p><address><hr><div align=center>
<table width=100% cellspacing=0 border=0><tr>
<td>Copyright &copy; 2007
<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
<td align=right><div align=right>Qt 3.3.8</div>
</table></div></address></body>
</html>