<!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 Class Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><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="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>VSettings Class Reference</h1><!-- doxytag: class="VSettings" -->
<p><code>#include <<a class="el" href="_v_settings_8h_source.html">VSettings.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for VSettings:</div>
<div class="dynsection">
<div class="center">
<img src="class_v_settings.png" usemap="#VSettings_map" alt=""/>
<map id="VSettings_map" name="VSettings_map">
<area href="class_abstract_tor_settings.html" alt="AbstractTorSettings" shape="rect" coords="132,56,254,80"/>
<area href="class_vidalia_settings.html" alt="VidaliaSettings" shape="rect" coords="396,56,518,80"/>
<area href="class_network_settings.html" alt="NetworkSettings" shape="rect" coords="0,112,122,136"/>
<area href="class_server_settings.html" alt="ServerSettings" shape="rect" coords="132,112,254,136"/>
<area href="class_tor_settings.html" alt="TorSettings" shape="rect" coords="264,112,386,136"/>
<area href="class_service_settings.html" alt="ServiceSettings" shape="rect" coords="396,112,518,136"/>
</map>
</div>
</div>
<p><a href="class_v_settings-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_v_settings.html#aeaab1463f25a199e5cfbace57068fde8">VSettings</a> (const QString group=QString())</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual QVariant </td><td class="memItemRight" valign="bottom"><a class="el" href="class_v_settings.html#a62a887791657ba93e55fa98b71acde30">value</a> (const QString &key, const QVariant &defaultVal=QVariant()) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_v_settings.html#a44640c06071473ba0f484dd234593801">setValue</a> (const QString &key, const QVariant &val)</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_v_settings.html#a9f3f0215e755e7ab277cefa93c4eac98">settingsFile</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_v_settings.html#aecb8f048d2705630987c12ed041474ed">settingsFileExists</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_v_settings.html#afda87ebac929bf616eb94389c491b2e0">reset</a> ()</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_v_settings.html#aebcf7105467fb91077fbb4470fcf9624">setDefault</a> (const QString &key, const QVariant &val)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QVariant </td><td class="memItemRight" valign="bottom"><a class="el" href="class_v_settings.html#a76db82d5e923b9710c9318b50bd6ad67">defaultValue</a> (const QString &key) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMap< QString, QVariant > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_v_settings.html#a71959db59f3b3e9898d15b710e8a69b4">allSettings</a> () const </td></tr>
<tr><td colspan="2"><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QHash< QString, QVariant > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_v_settings.html#a1a3577a7e36af7622a656614f23f59f7">_defaults</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="_v_settings_8h_source.html#l00024">24</a> of file <a class="el" href="_v_settings_8h_source.html">VSettings.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aeaab1463f25a199e5cfbace57068fde8"></a><!-- doxytag: member="VSettings::VSettings" ref="aeaab1463f25a199e5cfbace57068fde8" args="(const QString group=QString())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">VSettings::VSettings </td>
<td>(</td>
<td class="paramtype">const QString </td>
<td class="paramname"> <em>settingsGroup</em> = <code>QString()</code></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor. The optional parameter <b>group</b> can be used to set a prefix that will be prepended to keys specified to <a class="el" href="class_v_settings.html">VSettings</a> in <a class="el" href="class_v_settings.html#a62a887791657ba93e55fa98b71acde30">value()</a> and <a class="el" href="class_v_settings.html#a44640c06071473ba0f484dd234593801">setValue()</a>.</p>
<p>Constructor </p>
<p>Definition at line <a class="el" href="_v_settings_8cpp_source.html#l00027">27</a> of file <a class="el" href="_v_settings_8cpp_source.html">VSettings.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a71959db59f3b3e9898d15b710e8a69b4"></a><!-- doxytag: member="VSettings::allSettings" ref="a71959db59f3b3e9898d15b710e8a69b4" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QMap< QString, QVariant > VSettings::allSettings </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a map of all currently saved settings at the last apply() point.</p>
<p>Returns a map of all currently saved settings at the last appyl() point. </p>
<p>Definition at line <a class="el" href="_v_settings_8cpp_source.html#l00098">98</a> of file <a class="el" href="_v_settings_8cpp_source.html">VSettings.cpp</a>.</p>
<p>References <a class="el" href="_v_settings_8cpp_source.html#l00054">value()</a>.</p>
<p>Referenced by <a class="el" href="_abstract_tor_settings_8cpp_source.html#l00026">AbstractTorSettings::AbstractTorSettings()</a>, and <a class="el" href="_abstract_tor_settings_8cpp_source.html#l00058">AbstractTorSettings::setChanged()</a>.</p>
</div>
</div>
<a class="anchor" id="a76db82d5e923b9710c9318b50bd6ad67"></a><!-- doxytag: member="VSettings::defaultValue" ref="a76db82d5e923b9710c9318b50bd6ad67" args="(const QString &key) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QVariant VSettings::defaultValue </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"> <em>key</em></td>
<td> ) </td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the default setting value associated with <b>key</b>. If <b>key</b> has no default value, then an empty QVariant is returned. </p>
<p>Definition at line <a class="el" href="_v_settings_8cpp_source.html#l00080">80</a> of file <a class="el" href="_v_settings_8cpp_source.html">VSettings.cpp</a>.</p>
<p>References <a class="el" href="_v_settings_8h_source.html#l00063">_defaults</a>.</p>
<p>Referenced by <a class="el" href="_server_settings_8cpp_source.html#l00083">ServerSettings::confValues()</a>, <a class="el" href="_tor_settings_8cpp_source.html#l00145">TorSettings::getExecutable()</a>, <a class="el" href="_v_settings_8cpp_source.html#l00062">setValue()</a>, <a class="el" href="_abstract_tor_settings_8cpp_source.html#l00097">AbstractTorSettings::torValue()</a>, and <a class="el" href="_v_settings_8cpp_source.html#l00054">value()</a>.</p>
</div>
</div>
<a class="anchor" id="afda87ebac929bf616eb94389c491b2e0"></a><!-- doxytag: member="VSettings::reset" ref="afda87ebac929bf616eb94389c491b2e0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void VSettings::reset </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resets all of Vidalia's settings. </p>
<p>Definition at line <a class="el" href="_v_settings_8cpp_source.html#l00089">89</a> of file <a class="el" href="_v_settings_8cpp_source.html">VSettings.cpp</a>.</p>
<p>References <a class="el" href="_v_settings_8cpp_source.html#l00023">SETTINGS_FILE</a>.</p>
<p>Referenced by <a class="el" href="_vidalia_8cpp_source.html#l00094">Vidalia::Vidalia()</a>.</p>
</div>
</div>
<a class="anchor" id="aebcf7105467fb91077fbb4470fcf9624"></a><!-- doxytag: member="VSettings::setDefault" ref="aebcf7105467fb91077fbb4470fcf9624" args="(const QString &key, const QVariant &val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void VSettings::setDefault </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QVariant & </td>
<td class="paramname"> <em>val</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the default setting for <b>key</b> to <b>val</b>. </p>
<p>Definition at line <a class="el" href="_v_settings_8cpp_source.html#l00072">72</a> of file <a class="el" href="_v_settings_8cpp_source.html">VSettings.cpp</a>.</p>
<p>References <a class="el" href="_v_settings_8h_source.html#l00063">_defaults</a>.</p>
<p>Referenced by <a class="el" href="_abstract_tor_settings_8cpp_source.html#l00026">AbstractTorSettings::AbstractTorSettings()</a>, <a class="el" href="_network_settings_8cpp_source.html#l00046">NetworkSettings::NetworkSettings()</a>, <a class="el" href="_server_settings_8cpp_source.html#l00056">ServerSettings::ServerSettings()</a>, <a class="el" href="_service_settings_8cpp_source.html#l00027">ServiceSettings::ServiceSettings()</a>, <a class="el" href="_tor_settings_8cpp_source.html#l00060">TorSettings::TorSettings()</a>, and <a class="el" href="_vidalia_settings_8cpp_source.html#l00049">VidaliaSettings::VidaliaSettings()</a>.</p>
</div>
</div>
<a class="anchor" id="a9f3f0215e755e7ab277cefa93c4eac98"></a><!-- doxytag: member="VSettings::settingsFile" ref="a9f3f0215e755e7ab277cefa93c4eac98" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString VSettings::settingsFile </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the location of Vidalia's configuration settings file. </p>
<p>Definition at line <a class="el" href="_v_settings_8cpp_source.html#l00036">36</a> of file <a class="el" href="_v_settings_8cpp_source.html">VSettings.cpp</a>.</p>
<p>References <a class="el" href="_v_settings_8cpp_source.html#l00023">SETTINGS_FILE</a>.</p>
<p>Referenced by <a class="el" href="_vidalia_8cpp_source.html#l00475">Vidalia::copyDefaultSettingsFile()</a>, and <a class="el" href="_v_settings_8cpp_source.html#l00043">settingsFileExists()</a>.</p>
</div>
</div>
<a class="anchor" id="aecb8f048d2705630987c12ed041474ed"></a><!-- doxytag: member="VSettings::settingsFileExists" ref="aecb8f048d2705630987c12ed041474ed" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool VSettings::settingsFileExists </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if Vidalia's configuration settings file already exists. </p>
<p>Definition at line <a class="el" href="_v_settings_8cpp_source.html#l00043">43</a> of file <a class="el" href="_v_settings_8cpp_source.html">VSettings.cpp</a>.</p>
<p>References <a class="el" href="_v_settings_8cpp_source.html#l00036">settingsFile()</a>.</p>
<p>Referenced by <a class="el" href="_vidalia_8cpp_source.html#l00094">Vidalia::Vidalia()</a>.</p>
</div>
</div>
<a class="anchor" id="a44640c06071473ba0f484dd234593801"></a><!-- doxytag: member="VSettings::setValue" ref="a44640c06071473ba0f484dd234593801" args="(const QString &key, const QVariant &val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void VSettings::setValue </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QVariant & </td>
<td class="paramname"> <em>val</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the value associated with <b>key</b> to <b>val</b>. </p>
<p>Reimplemented in <a class="el" href="class_abstract_tor_settings.html#a29b7abc52f7dfcb1453aafa28f902789">AbstractTorSettings</a>.</p>
<p>Definition at line <a class="el" href="_v_settings_8cpp_source.html#l00062">62</a> of file <a class="el" href="_v_settings_8cpp_source.html">VSettings.cpp</a>.</p>
<p>References <a class="el" href="_v_settings_8cpp_source.html#l00080">defaultValue()</a>, and <a class="el" href="_v_settings_8cpp_source.html#l00054">value()</a>.</p>
<p>Referenced by <a class="el" href="_vidalia_window_8cpp_source.html#l00101">VidaliaWindow::saveSetting()</a>, <a class="el" href="_vidalia_settings_8cpp_source.html#l00280">VidaliaSettings::setAutoUpdateEnabled()</a>, <a class="el" href="_vidalia_settings_8cpp_source.html#l00205">VidaliaSettings::setBrowserDirectory()</a>, <a class="el" href="_vidalia_settings_8cpp_source.html#l00190">VidaliaSettings::setBrowserExecutable()</a>, <a class="el" href="_service_settings_8cpp_source.html#l00136">ServiceSettings::setEnabled()</a>, <a class="el" href="_vidalia_settings_8cpp_source.html#l00221">VidaliaSettings::setIMExecutable()</a>, <a class="el" href="_vidalia_settings_8cpp_source.html#l00107">VidaliaSettings::setInterfaceStyle()</a>, <a class="el" href="_vidalia_settings_8cpp_source.html#l00093">VidaliaSettings::setLanguageCode()</a>, <a class="el" href="_vidalia_settings_8cpp_source.html#l00292">VidaliaSettings::setLastCheckedForUpdates()</a>, <a class="el" href="_service_settings_8cpp_source.html#l00122">ServiceSettings::setPhysicalAddressPort()</a>, <a class="el" href="_vidalia_settings_8cpp_source.html#l00252">VidaliaSettings::setProxyExecutable()</a>, <a class="el" href="_vidalia_settings_8cpp_source.html#l00267">VidaliaSettings::setProxyExecutableArguments()</a>, <a class="el" href="_vidalia_settings_8cpp_source.html#l00236">VidaliaSettings::setRunProxyAtStart()</a>, <a class="el" href="_vidalia_settings_8cpp_source.html#l00121">VidaliaSettings::setRunTorAtStart()</a>, <a class="el" href="_service_settings_8cpp_source.html#l00107">ServiceSettings::setServiceAddress()</a>, <a class="el" href="_service_settings_8cpp_source.html#l00037">ServiceSettings::setServices()</a>, <a class="el" href="_vidalia_settings_8cpp_source.html#l00136">VidaliaSettings::setShowMainWindowAtStart()</a>, and <a class="el" href="_service_settings_8cpp_source.html#l00092">ServiceSettings::setVirtualPort()</a>.</p>
</div>
</div>
<a class="anchor" id="a62a887791657ba93e55fa98b71acde30"></a><!-- doxytag: member="VSettings::value" ref="a62a887791657ba93e55fa98b71acde30" args="(const QString &key, const QVariant &defaultVal=QVariant()) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QVariant VSettings::value </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QVariant & </td>
<td class="paramname"> <em>defaultVal</em> = <code>QVariant()</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the saved value associated with <b>key</b>. If no value has been set, the default value is returned. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_v_settings.html#aebcf7105467fb91077fbb4470fcf9624">setDefault</a> </dd></dl>
<p>Definition at line <a class="el" href="_v_settings_8cpp_source.html#l00054">54</a> of file <a class="el" href="_v_settings_8cpp_source.html">VSettings.cpp</a>.</p>
<p>References <a class="el" href="_v_settings_8cpp_source.html#l00080">defaultValue()</a>.</p>
<p>Referenced by <a class="el" href="_v_settings_8cpp_source.html#l00098">allSettings()</a>, <a class="el" href="_vidalia_settings_8cpp_source.html#l00197">VidaliaSettings::getBrowserDirectory()</a>, <a class="el" href="_vidalia_settings_8cpp_source.html#l00182">VidaliaSettings::getBrowserExecutable()</a>, <a class="el" href="_service_settings_8cpp_source.html#l00143">ServiceSettings::getHiddenServiceDirectories()</a>, <a class="el" href="_vidalia_settings_8cpp_source.html#l00213">VidaliaSettings::getIMExecutable()</a>, <a class="el" href="_vidalia_settings_8cpp_source.html#l00100">VidaliaSettings::getInterfaceStyle()</a>, <a class="el" href="_vidalia_settings_8cpp_source.html#l00086">VidaliaSettings::getLanguageCode()</a>, <a class="el" href="_service_settings_8cpp_source.html#l00114">ServiceSettings::getPhysicalAddressPort()</a>, <a class="el" href="_vidalia_settings_8cpp_source.html#l00244">VidaliaSettings::getProxyExecutable()</a>, <a class="el" href="_vidalia_settings_8cpp_source.html#l00260">VidaliaSettings::getProxyExecutableArguments()</a>, <a class="el" href="_service_settings_8cpp_source.html#l00099">ServiceSettings::getServiceAddress()</a>, <a class="el" href="_service_settings_8cpp_source.html#l00051">ServiceSettings::getServices()</a>, <a class="el" href="_vidalia_window_8cpp_source.html#l00094">VidaliaWindow::getSetting()</a>, <a class="el" href="_service_settings_8cpp_source.html#l00084">ServiceSettings::getVirtualPort()</a>, <a class="el" href="_vidalia_settings_8cpp_source.html#l00274">VidaliaSettings::isAutoUpdateEnabled()</a>, <a class="el" href="_service_settings_8cpp_source.html#l00129">ServiceSettings::isEnabled()</a>, <a class="el" href="_vidalia_settings_8cpp_source.html#l00286">VidaliaSettings::lastCheckedForUpdates()</a>, <a class="el" href="_vidalia_settings_8cpp_source.html#l00229">VidaliaSettings::runProxyAtStart()</a>, <a class="el" href="_vidalia_settings_8cpp_source.html#l00114">VidaliaSettings::runTorAtStart()</a>, <a class="el" href="_v_settings_8cpp_source.html#l00062">setValue()</a>, and <a class="el" href="_vidalia_settings_8cpp_source.html#l00129">VidaliaSettings::showMainWindowAtStart()</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a1a3577a7e36af7622a656614f23f59f7"></a><!-- doxytag: member="VSettings::_defaults" ref="a1a3577a7e36af7622a656614f23f59f7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QHash<QString, QVariant> <a class="el" href="class_v_settings.html#a1a3577a7e36af7622a656614f23f59f7">VSettings::_defaults</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Association of setting key names to default setting values. </p>
<p>Definition at line <a class="el" href="_v_settings_8h_source.html#l00063">63</a> of file <a class="el" href="_v_settings_8h_source.html">VSettings.h</a>.</p>
<p>Referenced by <a class="el" href="_v_settings_8cpp_source.html#l00080">defaultValue()</a>, and <a class="el" href="_v_settings_8cpp_source.html#l00072">setDefault()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_v_settings_8h_source.html">VSettings.h</a></li>
<li><a class="el" href="_v_settings_8cpp_source.html">VSettings.cpp</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Aug 30 22:58:57 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
>
649
