source: trunk/doc/html/qsettings-h.html@ 208

Last change on this file since 208 was 190, checked in by rudi, 14 years ago

reference documentation added

File size: 6.7 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/include/qsettings.h:1 -->
3<html>
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6<title>qsettings.h Include File</title>
7<style type="text/css"><!--
8fn { margin-left: 1cm; text-indent: -1cm; }
9a:link { color: #004faf; text-decoration: none }
10a:visited { color: #672967; text-decoration: none }
11body { background: #ffffff; color: black; }
12--></style>
13</head>
14<body>
15
16<table border="0" cellpadding="0" cellspacing="0" width="100%">
17<tr bgcolor="#E5E5E5">
18<td valign=center>
19 <a href="index.html">
20<font color="#004faf">Home</font></a>
21 | <a href="classes.html">
22<font color="#004faf">All&nbsp;Classes</font></a>
23 | <a href="mainclasses.html">
24<font color="#004faf">Main&nbsp;Classes</font></a>
25 | <a href="annotated.html">
26<font color="#004faf">Annotated</font></a>
27 | <a href="groups.html">
28<font color="#004faf">Grouped&nbsp;Classes</font></a>
29 | <a href="functions.html">
30<font color="#004faf">Functions</font></a>
31</td>
32<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>
33
34<p>This is the verbatim text of the qsettings.h include file. It is provided only for illustration; the copyright remains with Trolltech.
35<hr>
36<pre>
37/****************************************************************************
38** $Id: qsettings-h.html 2051 2007-02-21 10:04:20Z chehrlic $
39**
40** Definition of QSettings class
41**
42** Created : 000626
43**
44** Copyright (C) 2000-2007 Trolltech ASA. All rights reserved.
45**
46** This file is part of the tools module of the Qt GUI Toolkit.
47**
48** This file may be distributed under the terms of the Q Public License
49** as defined by Trolltech ASA of Norway and appearing in the file
50** LICENSE.QPL included in the packaging of this file.
51**
52** This file may be distributed and/or modified under the terms of the
53** GNU General Public License version 2 as published by the Free Software
54** Foundation and appearing in the file LICENSE.GPL included in the
55** packaging of this file.
56**
57** Licensees holding valid Qt Enterprise Edition or Qt Professional Edition
58** licenses may use this file in accordance with the Qt Commercial License
59** Agreement provided with the Software.
60**
61** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
62** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
63**
64** See http://www.trolltech.com/pricing.html or email sales@trolltech.com for
65** information about Qt Commercial License Agreements.
66** See http://www.trolltech.com/qpl/ for QPL licensing information.
67** See http://www.trolltech.com/gpl/ for GPL licensing information.
68**
69** Contact info@trolltech.com if any conditions of this licensing are
70** not clear to you.
71**
72**********************************************************************/
73
74#ifndef QSETTINGS_H
75#define QSETTINGS_H
76
77#ifndef QT_H
78#include "qdatetime.h"
79#include "qstringlist.h"
80#endif // QT_H
81
82#ifndef QT_NO_SETTINGS
83
84class QSettingsPrivate;
85
86
87class Q_EXPORT QSettings
88{
89public:
90 enum Format {
91 Native = 0,
92 Ini
93 };
94 enum System {
95 Unix = 0,
96 Windows,
97 Mac
98 };
99 enum Scope {
100 User,
101 Global
102 };
103
104 QSettings();
105 QSettings( Format format );
106
107 ~QSettings();
108
109#if !defined(Q_NO_BOOL_TYPE)
110 bool writeEntry( const QString &amp;, bool );
111#endif
112 bool writeEntry( const QString &amp;, double );
113 bool writeEntry( const QString &amp;, int );
114 bool writeEntry( const QString &amp;, const char * );
115 bool writeEntry( const QString &amp;, const QString &amp; );
116 bool writeEntry( const QString &amp;, const QStringList &amp; );
117 bool writeEntry( const QString &amp;, const QStringList &amp;, const QChar&amp; sep );
118
119 QStringList entryList(const QString &amp;) const;
120 QStringList subkeyList(const QString &amp;) const;
121
122 //### remove non const versions in 4.0
123 QStringList readListEntry( const QString &amp;, bool * = 0 );
124 QStringList readListEntry( const QString &amp;, const QChar&amp; sep, bool * = 0 );
125 QString readEntry( const QString &amp;, const QString &amp;def = QString::null, bool * = 0 );
126 int readNumEntry( const QString &amp;, int def = 0, bool * = 0 );
127 double readDoubleEntry( const QString &amp;, double def = 0, bool * = 0 );
128 bool readBoolEntry( const QString &amp;, bool def = FALSE, bool * = 0 );
129
130 //### make those non-inlined in 4.0
131 QStringList readListEntry( const QString &amp;key, bool *ok = 0 ) const
132 {
133 QSettings *that = (QSettings*)this;
134 return that-&gt;readListEntry( key, ok );
135 }
136 QStringList readListEntry( const QString &amp;key, const QChar&amp; sep, bool *ok = 0 ) const
137 {
138 QSettings *that = (QSettings*)this;
139 return that-&gt;readListEntry( key, sep, ok );
140 }
141 QString readEntry( const QString &amp;key, const QString &amp;def = QString::null,
142 bool *ok = 0 ) const
143 {
144 QSettings *that = (QSettings*)this;
145 return that-&gt;readEntry( key, def, ok );
146 }
147 int readNumEntry( const QString &amp;key, int def = 0, bool *ok = 0 ) const
148 {
149 QSettings *that = (QSettings*)this;
150 return that-&gt;readNumEntry( key, def, ok );
151 }
152
153 double readDoubleEntry( const QString &amp;key, double def = 0, bool *ok = 0 ) const
154 {
155 QSettings *that = (QSettings*)this;
156 return that-&gt;readDoubleEntry( key, def, ok );
157 }
158 bool readBoolEntry( const QString &amp;key, bool def = FALSE, bool *ok = 0 ) const
159 {
160 QSettings *that = (QSettings*)this;
161 return that-&gt;readBoolEntry( key, def, ok );
162 }
163
164 bool removeEntry( const QString &amp; );
165
166 void insertSearchPath( System, const QString &amp; );
167 void removeSearchPath( System, const QString &amp; );
168
169 void setPath( const QString &amp;domain, const QString &amp;product, Scope = Global );
170
171 void beginGroup( const QString &amp;group );
172 void endGroup();
173 void resetGroup();
174 QString group() const;
175
176 bool sync();
177
178private:
179 QSettingsPrivate *d;
180
181#if defined(Q_DISABLE_COPY)
182 QSettings(const QSettings &amp;);
183 QSettings &amp;operator=(const QSettings &amp;);
184#endif
185
186 QDateTime lastModificationTime( const QString &amp; );
187
188 friend class QApplication;
189};
190
191#endif // QT_NO_SETTINGS
192#endif // QSETTINGS_H
193</pre>
194<!-- eof -->
195<p><address><hr><div align=center>
196<table width=100% cellspacing=0 border=0><tr>
197<td>Copyright &copy; 2007
198<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
199<td align=right><div align=right>Qt 3.3.8</div>
200</table></div></address></body>
201</html>
Note: See TracBrowser for help on using the repository browser.