~oif-team/ubuntu/natty/qt4-x11/xi2.1

« back to all changes in this revision

Viewing changes to doc/html/qsettings-qt3.html

  • Committer: Bazaar Package Importer
  • Author(s): Adam Conrad
  • Date: 2005-08-24 04:09:09 UTC
  • Revision ID: james.westby@ubuntu.com-20050824040909-xmxe9jfr4a0w5671
Tags: upstream-4.0.0
ImportĀ upstreamĀ versionĀ 4.0.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="iso-8859-1"?>
 
2
<!DOCTYPE html
 
3
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
 
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
5
<!-- /tmp/qt-4.0.0-espenr-1119621036935/qt-x11-opensource-desktop-4.0.0/src/corelib/io/qsettings.cpp -->
 
6
<head>
 
7
    <title>Qt 4.0: Qt 3 Support Members for QSettings</title>
 
8
    <style>h3.fn,span.fn { margin-left: 1cm; text-indent: -1cm; }
 
9
a:link { color: #004faf; text-decoration: none }
 
10
a:visited { color: #672967; text-decoration: none }
 
11
td.postheader { font-family: sans-serif }
 
12
tr.address { font-family: sans-serif }
 
13
body { background: #ffffff; color: black; }</style>
 
14
</head>
 
15
<body>
 
16
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
17
<tr>
 
18
<td align="left" valign="top" width="32"><img src="images/qt-logo.png" align="left" width="32" height="32" border="0" /></td>
 
19
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot; <a href="classes.html"><font color="#004faf">All&nbsp;Classes</font></a>&nbsp;&middot; <a href="mainclasses.html"><font color="#004faf">Main&nbsp;Classes</font></a>&nbsp;&middot; <a href="annotated.html"><font color="#004faf">Annotated</font></a>&nbsp;&middot; <a href="groups.html"><font color="#004faf">Grouped&nbsp;Classes</font></a>&nbsp;&middot; <a href="functions.html"><font color="#004faf">Functions</font></a></td>
 
20
<td align="right" valign="top" width="230"><img src="images/trolltech-logo.png" align="right" width="203" height="32" border="0" /></td></tr></table><h1 align="center">Qt 3 Support Members for QSettings</h1>
 
21
<p><b>The following class members are part of the Qt 3 support layer.</b> They are provided to help you port old code to Qt 4. We advise against using them in new code.</p>
 
22
<p><ul><li><a href="qsettings.html">QSettings class reference</a></li></ul></p>
 
23
<h3>Public Types</h3>
 
24
<ul>
 
25
<li><div class="fn"/>enum <b><a href="qsettings-qt3.html#System-enum">System</a></b> { Unix, Windows, Mac }</li>
 
26
</ul>
 
27
<h3>Public Functions</h3>
 
28
<ul>
 
29
<li><div class="fn"/>QStringList <b><a href="qsettings-qt3.html#entryList">entryList</a></b> ( const QString &amp; <i>key</i> ) const</li>
 
30
<li><div class="fn"/>void <b><a href="qsettings-qt3.html#insertSearchPath">insertSearchPath</a></b> ( System <i>system</i>, const QString &amp; <i>path</i> )</li>
 
31
<li><div class="fn"/>bool <b><a href="qsettings-qt3.html#readBoolEntry">readBoolEntry</a></b> ( const QString &amp; <i>key</i>, bool <i>defaultValue</i> = false, bool * <i>ok</i> = 0 )</li>
 
32
<li><div class="fn"/>double <b><a href="qsettings-qt3.html#readDoubleEntry">readDoubleEntry</a></b> ( const QString &amp; <i>key</i>, double <i>defaultValue</i> = 0, bool * <i>ok</i> = 0 )</li>
 
33
<li><div class="fn"/>QString <b><a href="qsettings-qt3.html#readEntry">readEntry</a></b> ( const QString &amp; <i>key</i>, const QString &amp; <i>defaultValue</i> = QString(), bool * <i>ok</i> = 0 )</li>
 
34
<li><div class="fn"/>QStringList <b><a href="qsettings-qt3.html#readListEntry">readListEntry</a></b> ( const QString &amp; <i>key</i>, bool * <i>ok</i> = 0 )</li>
 
35
<li><div class="fn"/>QStringList <b><a href="qsettings-qt3.html#readListEntry-2">readListEntry</a></b> ( const QString &amp; <i>key</i>, QChar <i>separator</i>, bool * <i>ok</i> = 0 )</li>
 
36
<li><div class="fn"/>int <b><a href="qsettings-qt3.html#readNumEntry">readNumEntry</a></b> ( const QString &amp; <i>key</i>, int <i>defaultValue</i> = 0, bool * <i>ok</i> = 0 )</li>
 
37
<li><div class="fn"/>bool <b><a href="qsettings-qt3.html#removeEntry">removeEntry</a></b> ( const QString &amp; <i>key</i> )</li>
 
38
<li><div class="fn"/>void <b><a href="qsettings-qt3.html#removeSearchPath">removeSearchPath</a></b> ( System <i>system</i>, const QString &amp; <i>path</i> )</li>
 
39
<li><div class="fn"/>void <b><a href="qsettings-qt3.html#resetGroup">resetGroup</a></b> ()</li>
 
40
<li><div class="fn"/>void <b><a href="qsettings-qt3.html#setPath">setPath</a></b> ( const QString &amp; <i>organization</i>, const QString &amp; <i>application</i>, Scope <i>scope</i> = Global )</li>
 
41
<li><div class="fn"/>QStringList <b><a href="qsettings-qt3.html#subkeyList">subkeyList</a></b> ( const QString &amp; <i>key</i> ) const</li>
 
42
<li><div class="fn"/>bool <b><a href="qsettings-qt3.html#writeEntry">writeEntry</a></b> ( const QString &amp; <i>key</i>, bool <i>value</i> )</li>
 
43
<li><div class="fn"/>bool <b><a href="qsettings-qt3.html#writeEntry-2">writeEntry</a></b> ( const QString &amp; <i>key</i>, double <i>value</i> )</li>
 
44
<li><div class="fn"/>bool <b><a href="qsettings-qt3.html#writeEntry-3">writeEntry</a></b> ( const QString &amp; <i>key</i>, int <i>value</i> )</li>
 
45
<li><div class="fn"/>bool <b><a href="qsettings-qt3.html#writeEntry-4">writeEntry</a></b> ( const QString &amp; <i>key</i>, const char * <i>value</i> )</li>
 
46
<li><div class="fn"/>bool <b><a href="qsettings-qt3.html#writeEntry-5">writeEntry</a></b> ( const QString &amp; <i>key</i>, const QString &amp; <i>value</i> )</li>
 
47
<li><div class="fn"/>bool <b><a href="qsettings-qt3.html#writeEntry-6">writeEntry</a></b> ( const QString &amp; <i>key</i>, const QStringList &amp; <i>value</i> )</li>
 
48
<li><div class="fn"/>bool <b><a href="qsettings-qt3.html#writeEntry-7">writeEntry</a></b> ( const QString &amp; <i>key</i>, const QStringList &amp; <i>value</i>, QChar <i>separator</i> )</li>
 
49
</ul>
 
50
<ul>
 
51
<li><div class="fn"/>8 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
 
52
</ul>
 
53
<hr />
 
54
<h2>Member Type Documentation</h2>
 
55
<h3 class="fn"><a name="System-enum"></a>enum QSettings::System</h3>
 
56
<table border="1" cellpadding="2" cellspacing="1" width="100%">
 
57
<tr><th width="25%">Constant</th><th width="15%">Value</th><th width="60%">Description</th></tr>
 
58
<tr><td valign="top"><tt>QSettings::Unix</tt></td><td align="center" valign="top"><tt>0</tt></td><td valign="top">Unix/<a href="winsystem.html#x11">X11</a> systems</td></tr>
 
59
<tr><td valign="top"><tt>QSettings::Windows</tt></td><td align="center" valign="top"><tt>1</tt></td><td valign="top">Microsoft Windows systems</td></tr>
 
60
<tr><td valign="top"><tt>QSettings::Mac</tt></td><td align="center" valign="top"><tt>2</tt></td><td valign="top">Mac OS X systems</td></tr>
 
61
</table>
 
62
<p>See also <a href="qsettings-qt3.html#insertSearchPath">insertSearchPath</a>() and <a href="qsettings-qt3.html#removeSearchPath">removeSearchPath</a>().</p>
 
63
<hr />
 
64
<h2>Member Function Documentation</h2>
 
65
<h3 class="fn"><a name="entryList"></a><a href="qstringlist.html">QStringList</a> QSettings::entryList ( const <a href="qstring.html">QString</a> &amp; <i>key</i> ) const</h3>
 
66
<p>Returns a list of all sub-keys of <i>key</i>.</p>
 
67
<p>Use <a href="qsettings.html#childKeys">childKeys</a>() instead.</p>
 
68
<p>For example, if you have code like</p>
 
69
<pre><font color="#404040">    QSettings settings;
 
70
    QStringList keys = settings.entryList(&quot;cities&quot;);
 
71
    ...</font></pre>
 
72
<p>you can rewrite it as</p>
 
73
<pre>    QSettings settings;
 
74
    settings.beginGroup(&quot;cities&quot;);
 
75
    QStringList keys = settings.childKeys();
 
76
    ...
 
77
    settings.endGroup();</pre>
 
78
<h3 class="fn"><a name="insertSearchPath"></a>void QSettings::insertSearchPath ( <a href="qsettings-qt3.html#System-enum">System</a> <i>system</i>, const <a href="qstring.html">QString</a> &amp; <i>path</i> )</h3>
 
79
<p>This function is implemented as a no-op. It is provided for source compatibility with Qt 3. The new <a href="qsettings.html">QSettings</a> class has no concept of &quot;search path&quot;.</p>
 
80
<h3 class="fn"><a name="readBoolEntry"></a>bool QSettings::readBoolEntry ( const <a href="qstring.html">QString</a> &amp; <i>key</i>, bool <i>defaultValue</i> = false, bool * <i>ok</i> = 0 )</h3>
 
81
<p>Returns the value for setting <i>key</i> converted to a <tt>bool</tt>. If the setting doesn't exist, returns <i>defaultValue</i>.</p>
 
82
<p>If <i>ok</i> is not 0, *<i>ok</i> is set to true if the key exists, otherwise *<i>ok</i> is set to false.</p>
 
83
<p>Use <a href="qsettings.html#value">value</a>() instead.</p>
 
84
<p>For example, if you have code like</p>
 
85
<pre><font color="#404040">    bool ok;
 
86
    bool grid = settings.readBoolEntry(&quot;showGrid&quot;, true, &amp;ok);</font></pre>
 
87
<p>you can rewrite it as</p>
 
88
<pre>    bool ok = settings.contains(&quot;showGrid&quot;);
 
89
    bool grid = settings.value(&quot;showGrid&quot;, true).toBool();</pre>
 
90
<h3 class="fn"><a name="readDoubleEntry"></a>double QSettings::readDoubleEntry ( const <a href="qstring.html">QString</a> &amp; <i>key</i>, double <i>defaultValue</i> = 0, bool * <i>ok</i> = 0 )</h3>
 
91
<p>Returns the value for setting <i>key</i> converted to a <tt>double</tt>. If the setting doesn't exist, returns <i>defaultValue</i>.</p>
 
92
<p>If <i>ok</i> is not 0, *<i>ok</i> is set to true if the key exists, otherwise *<i>ok</i> is set to false.</p>
 
93
<p>Use <a href="qsettings.html#value">value</a>() instead.</p>
 
94
<p>For example, if you have code like</p>
 
95
<pre><font color="#404040">    bool ok;
 
96
    double pi = settings.readDoubleEntry(&quot;pi&quot;, 3.141592, &amp;ok);</font></pre>
 
97
<p>you can rewrite it as</p>
 
98
<pre>    bool ok = settings.contains(&quot;pi&quot;);
 
99
    double pi = settings.value(&quot;pi&quot;, 3.141592).toDouble();</pre>
 
100
<h3 class="fn"><a name="readEntry"></a><a href="qstring.html">QString</a> QSettings::readEntry ( const <a href="qstring.html">QString</a> &amp; <i>key</i>, const <a href="qstring.html">QString</a> &amp; <i>defaultValue</i> = QString(), bool * <i>ok</i> = 0 )</h3>
 
101
<p>Returns the value for setting <i>key</i> converted to a <a href="qstring.html">QString</a>. If the setting doesn't exist, returns <i>defaultValue</i>.</p>
 
102
<p>If <i>ok</i> is not 0, *<i>ok</i> is set to true if the key exists, otherwise *<i>ok</i> is set to false.</p>
 
103
<p>Use <a href="qsettings.html#value">value</a>() instead.</p>
 
104
<p>For example, if you have code like</p>
 
105
<pre><font color="#404040">    bool ok;
 
106
    QString str = settings.readEntry(&quot;userName&quot;, &quot;administrator&quot;, &amp;ok);</font></pre>
 
107
<p>you can rewrite it as</p>
 
108
<pre>    bool ok = settings.contains(&quot;userName&quot;);
 
109
    QString str = settings.value(&quot;userName&quot;, &quot;administrator&quot;).toString();</pre>
 
110
<h3 class="fn"><a name="readListEntry"></a><a href="qstringlist.html">QStringList</a> QSettings::readListEntry ( const <a href="qstring.html">QString</a> &amp; <i>key</i>, bool * <i>ok</i> = 0 )</h3>
 
111
<p>Returns the value of setting <i>key</i> converted to a <a href="qstringlist.html">QStringList</a>.</p>
 
112
<p>If <i>ok</i> is not 0, *<i>ok</i> is set to true if the key exists, otherwise *<i>ok</i> is set to false.</p>
 
113
<p>Use <a href="qsettings.html#value">value</a>() instead.</p>
 
114
<p>For example, if you have code like</p>
 
115
<pre><font color="#404040">    bool ok;
 
116
    QStringList list = settings.readListEntry(&quot;recentFiles&quot;, &amp;ok);</font></pre>
 
117
<p>you can rewrite it as</p>
 
118
<pre>    bool ok = settings.contains(&quot;recentFiles&quot;);
 
119
    QStringList list = settings.value(&quot;recentFiles&quot;).toStringList();</pre>
 
120
<h3 class="fn"><a name="readListEntry-2"></a><a href="qstringlist.html">QStringList</a> QSettings::readListEntry ( const <a href="qstring.html">QString</a> &amp; <i>key</i>, <a href="qchar.html">QChar</a> <i>separator</i>, bool * <i>ok</i> = 0 )</h3>
 
121
<p>This is an overloaded member function, provided for convenience. It behaves essentially like the above function.</p>
 
122
<p>Returns the value of setting <i>key</i> converted to a <a href="qstringlist.html">QStringList</a>. <i>separator</i> is ignored.</p>
 
123
<p>If <i>ok</i> is not 0, *<i>ok</i> is set to true if the key exists, otherwise *<i>ok</i> is set to false.</p>
 
124
<p>Use <a href="qsettings.html#value">value</a>() instead.</p>
 
125
<p>For example, if you have code like</p>
 
126
<pre><font color="#404040">    bool ok;
 
127
    QStringList list = settings.readListEntry(&quot;recentFiles&quot;, &quot;:&quot;, &amp;ok);</font></pre>
 
128
<p>you can rewrite it as</p>
 
129
<pre>    bool ok = settings.contains(&quot;recentFiles&quot;);
 
130
    QStringList list = settings.value(&quot;recentFiles&quot;).toStringList();</pre>
 
131
<h3 class="fn"><a name="readNumEntry"></a>int QSettings::readNumEntry ( const <a href="qstring.html">QString</a> &amp; <i>key</i>, int <i>defaultValue</i> = 0, bool * <i>ok</i> = 0 )</h3>
 
132
<p>Returns the value for setting <i>key</i> converted to an <tt>int</tt>. If the setting doesn't exist, returns <i>defaultValue</i>.</p>
 
133
<p>If <i>ok</i> is not 0, *<i>ok</i> is set to true if the key exists, otherwise *<i>ok</i> is set to false.</p>
 
134
<p>Use <a href="qsettings.html#value">value</a>() instead.</p>
 
135
<p>For example, if you have code like</p>
 
136
<pre><font color="#404040">    bool ok;
 
137
    int max = settings.readNumEntry(&quot;maxConnections&quot;, 30, &amp;ok);</font></pre>
 
138
<p>you can rewrite it as</p>
 
139
<pre>    bool ok = settings.contains(&quot;maxConnections&quot;);
 
140
    int max = settings.value(&quot;maxConnections&quot;, 30).toInt();</pre>
 
141
<h3 class="fn"><a name="removeEntry"></a>bool QSettings::removeEntry ( const <a href="qstring.html">QString</a> &amp; <i>key</i> )</h3>
 
142
<p>Use <a href="qsettings.html#remove">remove</a>() instead.</p>
 
143
<h3 class="fn"><a name="removeSearchPath"></a>void QSettings::removeSearchPath ( <a href="qsettings-qt3.html#System-enum">System</a> <i>system</i>, const <a href="qstring.html">QString</a> &amp; <i>path</i> )</h3>
 
144
<p>This function is implemented as a no-op. It is provided for source compatibility with Qt 3. The new <a href="qsettings.html">QSettings</a> class has no concept of &quot;search path&quot;.</p>
 
145
<h3 class="fn"><a name="resetGroup"></a>void QSettings::resetGroup ()</h3>
 
146
<p>Sets the current group to be the empty string.</p>
 
147
<p>Use <a href="qsettings.html#endGroup">endGroup</a>() instead (possibly multiple times).</p>
 
148
<p>For example, if you have code like</p>
 
149
<pre><font color="#404040">    QSettings settings;
 
150
    settings.beginGroup(&quot;mainWindow&quot;);
 
151
    settings.beginGroup(&quot;leftPanel&quot;);
 
152
    ...
 
153
    settings.resetGroup();</font></pre>
 
154
<p>you can rewrite it as</p>
 
155
<pre>    QSettings settings;
 
156
    settings.beginGroup(&quot;mainWindow&quot;);
 
157
    settings.beginGroup(&quot;leftPanel&quot;);
 
158
    ...
 
159
    settings.endGroup();
 
160
    settings.endGroup();</pre>
 
161
<h3 class="fn"><a name="setPath"></a>void QSettings::setPath ( const <a href="qstring.html">QString</a> &amp; <i>organization</i>, const <a href="qstring.html">QString</a> &amp; <i>application</i>, <a href="qsettings.html#Scope-enum">Scope</a> <i>scope</i> = Global )</h3>
 
162
<p>Specifies the <i>organization</i>, <i>application</i>, and <i>scope</i> to use by the <a href="qsettings.html">QSettings</a> object.</p>
 
163
<p>Use the appropriate constructor instead, with <a href="qsettings.html#Scope-enum">QSettings::UserScope</a> instead of <a href="qsettings.html#Scope-enum">QSettings::User</a> and <a href="qsettings.html#Scope-enum">QSettings::SystemScope</a> instead of <a href="qsettings.html#Scope-enum">QSettings::Global</a>.</p>
 
164
<p>For example, if you have code like</p>
 
165
<pre><font color="#404040">    QSettings settings;
 
166
    settings.setPath(&quot;twikimaster.com&quot;, &quot;Kanooth&quot;, QSettings::Global);</font></pre>
 
167
<p>you can rewrite it as</p>
 
168
<pre>    QSettings settings(QSettings::SystemScope, &quot;twikimaster.com&quot;, &quot;Kanooth&quot;);</pre>
 
169
<h3 class="fn"><a name="subkeyList"></a><a href="qstringlist.html">QStringList</a> QSettings::subkeyList ( const <a href="qstring.html">QString</a> &amp; <i>key</i> ) const</h3>
 
170
<p>Returns a list of all sub-keys of <i>key</i>.</p>
 
171
<p>Use <a href="qsettings.html#childGroups">childGroups</a>() instead.</p>
 
172
<p>For example, if you have code like</p>
 
173
<pre><font color="#404040">    QSettings settings;
 
174
    QStringList groups = settings.entryList(&quot;cities&quot;);
 
175
    ...</font></pre>
 
176
<p>you can rewrite it as</p>
 
177
<pre>    QSettings settings;
 
178
    settings.beginGroup(&quot;cities&quot;);
 
179
    QStringList groups = settings.childKeys();
 
180
    ...
 
181
    settings.endGroup();</pre>
 
182
<h3 class="fn"><a name="writeEntry"></a>bool QSettings::writeEntry ( const <a href="qstring.html">QString</a> &amp; <i>key</i>, bool <i>value</i> )</h3>
 
183
<p>Sets the value of setting <i>key</i> to <i>value</i>.</p>
 
184
<p>Use <a href="qsettings.html#setValue">setValue</a>() instead.</p>
 
185
<h3 class="fn"><a name="writeEntry-2"></a>bool QSettings::writeEntry ( const <a href="qstring.html">QString</a> &amp; <i>key</i>, double <i>value</i> )</h3>
 
186
<p>This is an overloaded member function, provided for convenience. It behaves essentially like the above function.</p>
 
187
<h3 class="fn"><a name="writeEntry-3"></a>bool QSettings::writeEntry ( const <a href="qstring.html">QString</a> &amp; <i>key</i>, int <i>value</i> )</h3>
 
188
<p>This is an overloaded member function, provided for convenience. It behaves essentially like the above function.</p>
 
189
<h3 class="fn"><a name="writeEntry-4"></a>bool QSettings::writeEntry ( const <a href="qstring.html">QString</a> &amp; <i>key</i>, const char * <i>value</i> )</h3>
 
190
<p>This is an overloaded member function, provided for convenience. It behaves essentially like the above function.</p>
 
191
<h3 class="fn"><a name="writeEntry-5"></a>bool QSettings::writeEntry ( const <a href="qstring.html">QString</a> &amp; <i>key</i>, const <a href="qstring.html">QString</a> &amp; <i>value</i> )</h3>
 
192
<p>This is an overloaded member function, provided for convenience. It behaves essentially like the above function.</p>
 
193
<h3 class="fn"><a name="writeEntry-6"></a>bool QSettings::writeEntry ( const <a href="qstring.html">QString</a> &amp; <i>key</i>, const <a href="qstringlist.html">QStringList</a> &amp; <i>value</i> )</h3>
 
194
<p>This is an overloaded member function, provided for convenience. It behaves essentially like the above function.</p>
 
195
<h3 class="fn"><a name="writeEntry-7"></a>bool QSettings::writeEntry ( const <a href="qstring.html">QString</a> &amp; <i>key</i>, const <a href="qstringlist.html">QStringList</a> &amp; <i>value</i>, <a href="qchar.html">QChar</a> <i>separator</i> )</h3>
 
196
<p>This is an overloaded member function, provided for convenience. It behaves essentially like the above function.</p>
 
197
<p>Use setValue(<i>key</i>, <i>value</i>) instead. You don't need <i>separator</i>.</p>
 
198
<p /><address><hr /><div align="center">
 
199
<table width="100%" cellspacing="0" border="0"><tr class="address">
 
200
<td width="30%">Copyright &copy; 2005 <a href="trolltech.html">Trolltech</a></td>
 
201
<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>
 
202
<td width="30%" align="right"><div align="right">Qt 4.0.0</div></td>
 
203
</tr></table></div></address></body>
 
204
</html>