Sophie

Sophie

distrib > Mandriva > 2010.2 > i586 > by-pkgid > 9601c7beb4ff23e834bfa171795ed560 > files > 403

vidalia-0.2.9-1mdv2010.1.i586.rpm

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Vidalia: VSettings.cpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
      <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="dir_b47abd1aad201a152869566145babb61.html">src</a>&nbsp;&raquo;&nbsp;<a class="el" href="dir_695ba8f8357372e02d38c40b3c6dbe81.html">vidalia</a>&nbsp;&raquo;&nbsp;<a class="el" href="dir_738aec08306f4b898e01f7a551299457.html">config</a>
  </div>
</div>
<div class="contents">
<h1>VSettings.cpp</h1><a href="_v_settings_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">**  This file is part of Vidalia, and is subject to the license terms in the</span>
<a name="l00003"></a>00003 <span class="comment">**  LICENSE file, found in the top level directory of this distribution. If you</span>
<a name="l00004"></a>00004 <span class="comment">**  did not receive the LICENSE file with this file, you may obtain it from the</span>
<a name="l00005"></a>00005 <span class="comment">**  Vidalia source package distributed by the Vidalia Project at</span>
<a name="l00006"></a>00006 <span class="comment">**  http://www.vidalia-project.net/. No part of Vidalia, including this file,</span>
<a name="l00007"></a>00007 <span class="comment">**  may be copied, modified, propagated, or distributed except according to the</span>
<a name="l00008"></a>00008 <span class="comment">**  terms described in the LICENSE file.</span>
<a name="l00009"></a>00009 <span class="comment">*/</span>
<a name="l00010"></a>00010 
<a name="l00011"></a>00011 <span class="comment">/*</span>
<a name="l00012"></a>00012 <span class="comment">** \file VSettings.cpp</span>
<a name="l00013"></a>00013 <span class="comment">** \version $Id: VSettings.cpp 3735 2009-04-28 20:28:01Z edmanm $</span>
<a name="l00014"></a>00014 <span class="comment">** \brief Stores and retrieves settings from Vidalia&#39;s configuration file. </span>
<a name="l00015"></a>00015 <span class="comment">*/</span>
<a name="l00016"></a>00016 
<a name="l00017"></a>00017 <span class="preprocessor">#include &quot;<a class="code" href="_v_settings_8h.html">VSettings.h</a>&quot;</span>
<a name="l00018"></a>00018 <span class="preprocessor">#include &quot;<a class="code" href="_vidalia_8h.html">Vidalia.h</a>&quot;</span>
<a name="l00019"></a>00019 
<a name="l00020"></a>00020 <span class="preprocessor">#include &lt;QFileInfo&gt;</span>
<a name="l00021"></a>00021 <span class="comment"></span>
<a name="l00022"></a>00022 <span class="comment">/** The file in which all settings will read and written. */</span>
<a name="l00023"></a><a class="code" href="_v_settings_8cpp.html#ad13ef9fc86d531a6c7ead593b38e3d12">00023</a> <span class="preprocessor">#define SETTINGS_FILE (Vidalia::dataDirectory() + &quot;/vidalia.conf&quot;)</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="comment"></span>
<a name="l00026"></a>00026 <span class="comment">/** Constructor */</span>
<a name="l00027"></a><a class="code" href="class_v_settings.html#aeaab1463f25a199e5cfbace57068fde8">00027</a> <a class="code" href="class_v_settings.html#aeaab1463f25a199e5cfbace57068fde8">VSettings::VSettings</a>(<span class="keyword">const</span> QString settingsGroup)
<a name="l00028"></a>00028 : QSettings(<a class="code" href="_v_settings_8cpp.html#ad13ef9fc86d531a6c7ead593b38e3d12">SETTINGS_FILE</a>, QSettings::IniFormat)
<a name="l00029"></a>00029 {
<a name="l00030"></a>00030   <span class="keywordflow">if</span> (!settingsGroup.isEmpty())
<a name="l00031"></a>00031     beginGroup(settingsGroup);
<a name="l00032"></a>00032 }
<a name="l00033"></a>00033 <span class="comment"></span>
<a name="l00034"></a>00034 <span class="comment">/** Returns the location of Vidalia&#39;s configuration settings file. */</span>
<a name="l00035"></a>00035 QString
<a name="l00036"></a><a class="code" href="class_v_settings.html#a9f3f0215e755e7ab277cefa93c4eac98">00036</a> <a class="code" href="class_v_settings.html#a9f3f0215e755e7ab277cefa93c4eac98">VSettings::settingsFile</a>()
<a name="l00037"></a>00037 {
<a name="l00038"></a>00038   <span class="keywordflow">return</span> <a class="code" href="_v_settings_8cpp.html#ad13ef9fc86d531a6c7ead593b38e3d12">SETTINGS_FILE</a>;
<a name="l00039"></a>00039 }
<a name="l00040"></a>00040 <span class="comment"></span>
<a name="l00041"></a>00041 <span class="comment">/** Returns true if Vidalia&#39;s configuration settings file already exists. */</span>
<a name="l00042"></a>00042 <span class="keywordtype">bool</span>
<a name="l00043"></a><a class="code" href="class_v_settings.html#aecb8f048d2705630987c12ed041474ed">00043</a> <a class="code" href="class_v_settings.html#aecb8f048d2705630987c12ed041474ed">VSettings::settingsFileExists</a>()
<a name="l00044"></a>00044 {
<a name="l00045"></a>00045   QFileInfo fi(<a class="code" href="class_v_settings.html#a9f3f0215e755e7ab277cefa93c4eac98">settingsFile</a>());
<a name="l00046"></a>00046   <span class="keywordflow">return</span> fi.exists();
<a name="l00047"></a>00047 }
<a name="l00048"></a>00048 <span class="comment"></span>
<a name="l00049"></a>00049 <span class="comment">/** Returns the saved value associated with &lt;b&gt;key&lt;/b&gt;. If no value has been</span>
<a name="l00050"></a>00050 <span class="comment"> * set, the default value is returned.</span>
<a name="l00051"></a>00051 <span class="comment"> * \sa setDefault</span>
<a name="l00052"></a>00052 <span class="comment"> */</span>
<a name="l00053"></a>00053 QVariant
<a name="l00054"></a><a class="code" href="class_v_settings.html#a62a887791657ba93e55fa98b71acde30">00054</a> <a class="code" href="class_v_settings.html#a62a887791657ba93e55fa98b71acde30">VSettings::value</a>(<span class="keyword">const</span> QString &amp;key, <span class="keyword">const</span> QVariant &amp;defaultVal)<span class="keyword"> const</span>
<a name="l00055"></a>00055 <span class="keyword"></span>{
<a name="l00056"></a>00056   <span class="keywordflow">return</span> <a class="code" href="class_v_settings.html#a62a887791657ba93e55fa98b71acde30">QSettings::value</a>(key, defaultVal.isNull() ? <a class="code" href="class_v_settings.html#a76db82d5e923b9710c9318b50bd6ad67">defaultValue</a>(key)
<a name="l00057"></a>00057                                                    : defaultVal);
<a name="l00058"></a>00058 }
<a name="l00059"></a>00059 <span class="comment"></span>
<a name="l00060"></a>00060 <span class="comment">/** Sets the value associated with &lt;b&gt;key&lt;/b&gt; to &lt;b&gt;val&lt;/b&gt;. */</span>
<a name="l00061"></a>00061 <span class="keywordtype">void</span>
<a name="l00062"></a><a class="code" href="class_v_settings.html#a44640c06071473ba0f484dd234593801">00062</a> <a class="code" href="class_v_settings.html#a44640c06071473ba0f484dd234593801">VSettings::setValue</a>(<span class="keyword">const</span> QString &amp;key, <span class="keyword">const</span> QVariant &amp;val)
<a name="l00063"></a>00063 {
<a name="l00064"></a>00064   <span class="keywordflow">if</span> (val == <a class="code" href="class_v_settings.html#a76db82d5e923b9710c9318b50bd6ad67">defaultValue</a>(key))
<a name="l00065"></a>00065     QSettings::remove(key);
<a name="l00066"></a>00066   <span class="keywordflow">else</span> <span class="keywordflow">if</span> (val != <a class="code" href="class_v_settings.html#a62a887791657ba93e55fa98b71acde30">value</a>(key))
<a name="l00067"></a>00067     <a class="code" href="class_v_settings.html#a44640c06071473ba0f484dd234593801">QSettings::setValue</a>(key, val);
<a name="l00068"></a>00068 }
<a name="l00069"></a>00069 <span class="comment"></span>
<a name="l00070"></a>00070 <span class="comment">/** Sets the default setting for &lt;b&gt;key&lt;/b&gt; to &lt;b&gt;val&lt;/b&gt;. */</span>
<a name="l00071"></a>00071 <span class="keywordtype">void</span>
<a name="l00072"></a><a class="code" href="class_v_settings.html#aebcf7105467fb91077fbb4470fcf9624">00072</a> <a class="code" href="class_v_settings.html#aebcf7105467fb91077fbb4470fcf9624">VSettings::setDefault</a>(<span class="keyword">const</span> QString &amp;key, <span class="keyword">const</span> QVariant &amp;val)
<a name="l00073"></a>00073 {
<a name="l00074"></a>00074   <a class="code" href="class_v_settings.html#a1a3577a7e36af7622a656614f23f59f7">_defaults</a>.insert(key, val);
<a name="l00075"></a>00075 }
<a name="l00076"></a>00076 <span class="comment"></span>
<a name="l00077"></a>00077 <span class="comment">/** Returns the default setting value associated with &lt;b&gt;key&lt;/b&gt;. If</span>
<a name="l00078"></a>00078 <span class="comment"> * &lt;b&gt;key&lt;/b&gt; has no default value, then an empty QVariant is returned. */</span>
<a name="l00079"></a>00079 QVariant
<a name="l00080"></a><a class="code" href="class_v_settings.html#a76db82d5e923b9710c9318b50bd6ad67">00080</a> <a class="code" href="class_v_settings.html#a76db82d5e923b9710c9318b50bd6ad67">VSettings::defaultValue</a>(<span class="keyword">const</span> QString &amp;key)<span class="keyword"> const</span>
<a name="l00081"></a>00081 <span class="keyword"></span>{
<a name="l00082"></a>00082   <span class="keywordflow">if</span> (<a class="code" href="class_v_settings.html#a1a3577a7e36af7622a656614f23f59f7">_defaults</a>.contains(key))
<a name="l00083"></a>00083     <span class="keywordflow">return</span> <a class="code" href="class_v_settings.html#a1a3577a7e36af7622a656614f23f59f7">_defaults</a>.value(key);
<a name="l00084"></a>00084   <span class="keywordflow">return</span> QVariant();
<a name="l00085"></a>00085 }
<a name="l00086"></a>00086 <span class="comment"></span>
<a name="l00087"></a>00087 <span class="comment">/** Resets all of Vidalia&#39;s settings. */</span>
<a name="l00088"></a>00088 <span class="keywordtype">void</span>
<a name="l00089"></a><a class="code" href="class_v_settings.html#afda87ebac929bf616eb94389c491b2e0">00089</a> <a class="code" href="class_v_settings.html#afda87ebac929bf616eb94389c491b2e0">VSettings::reset</a>()
<a name="l00090"></a>00090 {
<a name="l00091"></a>00091   <span class="comment">/* Static method, so we have to create a QSettings object. */</span>
<a name="l00092"></a>00092   QSettings settings(<a class="code" href="_v_settings_8cpp.html#ad13ef9fc86d531a6c7ead593b38e3d12">SETTINGS_FILE</a>, QSettings::IniFormat);
<a name="l00093"></a>00093   settings.clear();
<a name="l00094"></a>00094 }
<a name="l00095"></a>00095 <span class="comment"></span>
<a name="l00096"></a>00096 <span class="comment">/** Returns a map of all currently saved settings at the last appyl() point. */</span>
<a name="l00097"></a>00097 QMap&lt;QString, QVariant&gt;
<a name="l00098"></a><a class="code" href="class_v_settings.html#a71959db59f3b3e9898d15b710e8a69b4">00098</a> <a class="code" href="class_v_settings.html#a71959db59f3b3e9898d15b710e8a69b4">VSettings::allSettings</a>()<span class="keyword"> const</span>
<a name="l00099"></a>00099 <span class="keyword"></span>{
<a name="l00100"></a>00100   QMap&lt;QString, QVariant&gt; settings;
<a name="l00101"></a>00101   <span class="keywordflow">foreach</span> (QString key, allKeys()) {
<a name="l00102"></a>00102     settings.insert(key, <a class="code" href="class_v_settings.html#a62a887791657ba93e55fa98b71acde30">value</a>(key));
<a name="l00103"></a>00103   }
<a name="l00104"></a>00104   <span class="keywordflow">return</span> settings;
<a name="l00105"></a>00105 }
<a name="l00106"></a>00106 
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Aug 30 22:58:55 2010 for Vidalia by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>