<!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.h 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 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 List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_b47abd1aad201a152869566145babb61.html">src</a> » <a class="el" href="dir_695ba8f8357372e02d38c40b3c6dbe81.html">vidalia</a> » <a class="el" href="dir_738aec08306f4b898e01f7a551299457.html">config</a>
</div>
</div>
<div class="contents">
<h1>VSettings.h</h1><a href="_v_settings_8h.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.h</span>
<a name="l00013"></a>00013 <span class="comment">** \version $Id: VSettings.h 3735 2009-04-28 20:28:01Z edmanm $</span>
<a name="l00014"></a>00014 <span class="comment">** \brief Stores and retrieves settings from Vidalia'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">#ifndef _VSETTINGS_H</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define _VSETTINGS_H</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a>00020 <span class="preprocessor">#include <QHash></span>
<a name="l00021"></a>00021 <span class="preprocessor">#include <QSettings></span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023
<a name="l00024"></a><a class="code" href="class_v_settings.html">00024</a> <span class="keyword">class </span><a class="code" href="class_v_settings.html">VSettings</a> : <span class="keyword">public</span> QSettings
<a name="l00025"></a>00025 {
<a name="l00026"></a>00026 Q_OBJECT
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00029"></a>00029 <span class="comment"> /** Default constructor. The optional parameter <b>group</b> can be used to</span>
<a name="l00030"></a>00030 <span class="comment"> * set a prefix that will be prepended to keys specified to VSettings in</span>
<a name="l00031"></a>00031 <span class="comment"> * value() and setValue(). */</span>
<a name="l00032"></a>00032 <a class="code" href="class_v_settings.html#aeaab1463f25a199e5cfbace57068fde8">VSettings</a>(<span class="keyword">const</span> QString group = QString());
<a name="l00033"></a>00033 <span class="comment"></span>
<a name="l00034"></a>00034 <span class="comment"> /** Returns the location of Vidalia's configuration settings file. */</span>
<a name="l00035"></a>00035 <span class="keyword">static</span> QString <a class="code" href="class_v_settings.html#a9f3f0215e755e7ab277cefa93c4eac98">settingsFile</a>();<span class="comment"></span>
<a name="l00036"></a>00036 <span class="comment"> /** Returns true if Vidalia's configuration settings file already exists. */</span>
<a name="l00037"></a>00037 <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="class_v_settings.html#aecb8f048d2705630987c12ed041474ed">settingsFileExists</a>();
<a name="l00038"></a>00038 <span class="comment"></span>
<a name="l00039"></a>00039 <span class="comment"> /** Resets all of Vidalia's settings. */</span>
<a name="l00040"></a>00040 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_v_settings.html#afda87ebac929bf616eb94389c491b2e0">reset</a>();
<a name="l00041"></a>00041 <span class="comment"></span>
<a name="l00042"></a>00042 <span class="comment"> /** Returns the saved value associated with <b>key</b>. If no value has been</span>
<a name="l00043"></a>00043 <span class="comment"> * set, the default value is returned.</span>
<a name="l00044"></a>00044 <span class="comment"> * \sa setDefault</span>
<a name="l00045"></a>00045 <span class="comment"> */</span>
<a name="l00046"></a>00046 <span class="keyword">virtual</span> QVariant <a class="code" href="class_v_settings.html#a62a887791657ba93e55fa98b71acde30">value</a>(<span class="keyword">const</span> QString &key,
<a name="l00047"></a>00047 <span class="keyword">const</span> QVariant &defaultVal = QVariant()) <span class="keyword">const</span>;<span class="comment"></span>
<a name="l00048"></a>00048 <span class="comment"> /** Sets the value associated with <b>key</b> to <b>val</b>. */</span>
<a name="l00049"></a>00049 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_v_settings.html#a44640c06071473ba0f484dd234593801">setValue</a>(<span class="keyword">const</span> QString &key, <span class="keyword">const</span> QVariant &val);
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <span class="keyword">protected</span>:<span class="comment"></span>
<a name="l00052"></a>00052 <span class="comment"> /** Sets the default setting for <b>key</b> to <b>val</b>. */</span>
<a name="l00053"></a>00053 <span class="keywordtype">void</span> <a class="code" href="class_v_settings.html#aebcf7105467fb91077fbb4470fcf9624">setDefault</a>(<span class="keyword">const</span> QString &key, <span class="keyword">const</span> QVariant &val);<span class="comment"></span>
<a name="l00054"></a>00054 <span class="comment"> /** Returns the default setting value associated with <b>key</b>. If</span>
<a name="l00055"></a>00055 <span class="comment"> * <b>key</b> has no default value, then an empty QVariant is returned. */</span>
<a name="l00056"></a>00056 QVariant <a class="code" href="class_v_settings.html#a76db82d5e923b9710c9318b50bd6ad67">defaultValue</a>(<span class="keyword">const</span> QString &key) <span class="keyword">const</span>;<span class="comment"></span>
<a name="l00057"></a>00057 <span class="comment"> /** Returns a map of all currently saved settings at the last apply()</span>
<a name="l00058"></a>00058 <span class="comment"> * point. */</span>
<a name="l00059"></a>00059 QMap<QString, QVariant> <a class="code" href="class_v_settings.html#a71959db59f3b3e9898d15b710e8a69b4">allSettings</a>() <span class="keyword">const</span>;
<a name="l00060"></a>00060
<a name="l00061"></a>00061 <span class="keyword">private</span>:<span class="comment"></span>
<a name="l00062"></a>00062 <span class="comment"> /** Association of setting key names to default setting values. */</span>
<a name="l00063"></a><a class="code" href="class_v_settings.html#a1a3577a7e36af7622a656614f23f59f7">00063</a> QHash<QString, QVariant> <a class="code" href="class_v_settings.html#a1a3577a7e36af7622a656614f23f59f7">_defaults</a>;
<a name="l00064"></a>00064 };
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="preprocessor">#endif</span>
<a name="l00067"></a>00067 <span class="preprocessor"></span>
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Aug 30 22:58:55 2010 for Vidalia by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.2
>
i586
>
media
>
contrib-backports
>
by-pkgid
>
9601c7beb4ff23e834bfa171795ed560
>
files
>
405
