<!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: AbstractTorSettings.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>AbstractTorSettings.h</h1><a href="_abstract_tor_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 AbstractTorSettings.h</span>
<a name="l00013"></a>00013 <span class="comment">** \version $Id: AbstractTorSettings.h 3735 2009-04-28 20:28:01Z edmanm $</span>
<a name="l00014"></a>00014 <span class="comment">** \brief Manages settings that need to be SETCONF'ed to Tor</span>
<a name="l00015"></a>00015 <span class="comment">*/</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef _ABSTRACTTORSETTINGS_H</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define _ABSTRACTTORSETTINGS_H</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a>00020 <span class="preprocessor">#include "<a class="code" href="_v_settings_8h.html">VSettings.h</a>"</span>
<a name="l00021"></a>00021 <span class="preprocessor">#include "<a class="code" href="_tor_control_8h.html">TorControl.h</a>"</span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023
<a name="l00024"></a><a class="code" href="class_abstract_tor_settings.html">00024</a> <span class="keyword">class </span><a class="code" href="class_abstract_tor_settings.html">AbstractTorSettings</a> : <span class="keyword">public</span> <a class="code" href="class_v_settings.html">VSettings</a>
<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"> /** Constructor. All settings will be under the heading <b>group</b> and</span>
<a name="l00030"></a>00030 <span class="comment"> * <b>torControl</b> will be used to <i>getconf</i> values from Tor. */</span>
<a name="l00031"></a>00031 <a class="code" href="class_abstract_tor_settings.html#af90864f7b59ceaa8f3e43cb5004dfd20">AbstractTorSettings</a>(<span class="keyword">const</span> QString &group, <a class="code" href="class_tor_control.html">TorControl</a> *<a class="code" href="class_abstract_tor_settings.html#a1fd0bb636bfa8131f6261b1bc11aeee4">torControl</a> = 0);
<a name="l00032"></a>00032 <span class="comment"></span>
<a name="l00033"></a>00033 <span class="comment"> /** Sets a value indicating that the server settings have changed since</span>
<a name="l00034"></a>00034 <span class="comment"> * apply() was last called. */</span>
<a name="l00035"></a>00035 <span class="keywordtype">void</span> <a class="code" href="class_abstract_tor_settings.html#a3ed5e24b841e62a5fc04afbc8ce80d76">setChanged</a>(<span class="keywordtype">bool</span> changed);<span class="comment"></span>
<a name="l00036"></a>00036 <span class="comment"> /** Returns true if any settings have changed since the last time apply()</span>
<a name="l00037"></a>00037 <span class="comment"> * was called. */</span>
<a name="l00038"></a>00038 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_abstract_tor_settings.html#ad99b94f5f0e35609bd3ed288a68f8700">changedSinceLastApply</a>() <span class="keyword">const</span>;<span class="comment"></span>
<a name="l00039"></a>00039 <span class="comment"> /** Reverts all settings to their values at the last time apply() was</span>
<a name="l00040"></a>00040 <span class="comment"> * called. */</span>
<a name="l00041"></a>00041 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_abstract_tor_settings.html#a8435bf9b86fa632ac2c61edf35de889b">revert</a>();<span class="comment"></span>
<a name="l00042"></a>00042 <span class="comment"> /** Subclasses must implement this to <i>setconf</i> values to apply them</span>
<a name="l00043"></a>00043 <span class="comment"> * to a running Tor instance. */</span>
<a name="l00044"></a>00044 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_abstract_tor_settings.html#a823e0a28a531e160efa6fa62a2400151">apply</a>(QString *errmsg) = 0;
<a name="l00045"></a>00045
<a name="l00046"></a>00046 <span class="keyword">protected</span>:<span class="comment"></span>
<a name="l00047"></a>00047 <span class="comment"> /** If Vidalia is connected to Tor, this returns the value associated with</span>
<a name="l00048"></a>00048 <span class="comment"> * <b>key</b> by calling torValue(). Otherwise, this calls localValue()</span>
<a name="l00049"></a>00049 <span class="comment"> * to get the locally saved value associated with <b>key</b>. */</span>
<a name="l00050"></a>00050 <span class="keyword">virtual</span> QVariant <a class="code" href="class_abstract_tor_settings.html#a6c2c0255bf7d89a14f1ad9ebdd6bf2ef">value</a>(<span class="keyword">const</span> QString &key) <span class="keyword">const</span>;<span class="comment"></span>
<a name="l00051"></a>00051 <span class="comment"> /** Returns the value associated with <b>key</b> saved in the local</span>
<a name="l00052"></a>00052 <span class="comment"> * configuration file. */</span>
<a name="l00053"></a>00053 <span class="keyword">virtual</span> QVariant <a class="code" href="class_abstract_tor_settings.html#a169f730fd477acb8f61cb5cf1026204f">localValue</a>(<span class="keyword">const</span> QString &key) <span class="keyword">const</span>;<span class="comment"></span>
<a name="l00054"></a>00054 <span class="comment"> /** Returns the value associated with <b>key</b> by querying TOr via </span>
<a name="l00055"></a>00055 <span class="comment"> * <i>getconf key</i>. */</span>
<a name="l00056"></a>00056 <span class="keyword">virtual</span> QVariant <a class="code" href="class_abstract_tor_settings.html#ac2a8f1b813921e6928f0d3f53e9cbfed">torValue</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"> /** Saves the value <b>val</b> for the setting <b>key</b> to the local</span>
<a name="l00058"></a>00058 <span class="comment"> * settings file. */</span>
<a name="l00059"></a>00059 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_abstract_tor_settings.html#a29b7abc52f7dfcb1453aafa28f902789">setValue</a>(<span class="keyword">const</span> QString &key, <span class="keyword">const</span> QVariant &value);
<a name="l00060"></a>00060 <span class="comment"></span>
<a name="l00061"></a>00061 <span class="comment"> /** Returns true if the given QVariant contains an empty value, depending on</span>
<a name="l00062"></a>00062 <span class="comment"> * the data type. For example, 0 is considered an empty integer and "" is</span>
<a name="l00063"></a>00063 <span class="comment"> * an empty string. */</span>
<a name="l00064"></a>00064 <span class="keywordtype">bool</span> <a class="code" href="class_abstract_tor_settings.html#a52e0ce036d031a3b5523f9dfa02d21b9">isEmptyValue</a>(<span class="keyword">const</span> QVariant &value) <span class="keyword">const</span>;
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="keyword">protected</span>:<span class="comment"></span>
<a name="l00067"></a>00067 <span class="comment"> /** Returns the TorControl object used for reading settings from or writing</span>
<a name="l00068"></a>00068 <span class="comment"> * settings to Tor, if one was specified. Returns 0 if no TorControl object</span>
<a name="l00069"></a>00069 <span class="comment"> * was given. */</span>
<a name="l00070"></a><a class="code" href="class_abstract_tor_settings.html#a1fd0bb636bfa8131f6261b1bc11aeee4">00070</a> <a class="code" href="class_tor_control.html">TorControl</a>* <a class="code" href="class_abstract_tor_settings.html#a1fd0bb636bfa8131f6261b1bc11aeee4">torControl</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_abstract_tor_settings.html#ab5bfd59fbb8e45433b5ce5a9847f90d4">_torControl</a>; };
<a name="l00071"></a>00071
<a name="l00072"></a>00072 <span class="keyword">private</span>:<span class="comment"></span>
<a name="l00073"></a>00073 <span class="comment"> /** TorControl object used for reading settings from or applying settings to</span>
<a name="l00074"></a>00074 <span class="comment"> * Tor. */</span>
<a name="l00075"></a>00075 <a class="code" href="class_tor_control.html">TorControl</a>* <a class="code" href="class_abstract_tor_settings.html#ab5bfd59fbb8e45433b5ce5a9847f90d4">_torControl</a>;<span class="comment"></span>
<a name="l00076"></a>00076 <span class="comment"> /** Collection of settings values at the last time apply() was called. */</span>
<a name="l00077"></a><a class="code" href="class_abstract_tor_settings.html#a072b59c0043ab8dcb2d55f483bc1b680">00077</a> QMap<QString, QVariant> <a class="code" href="class_abstract_tor_settings.html#a072b59c0043ab8dcb2d55f483bc1b680">_backupSettings</a>;
<a name="l00078"></a>00078 };
<a name="l00079"></a>00079
<a name="l00080"></a>00080 <span class="preprocessor">#endif</span>
<a name="l00081"></a>00081 <span class="preprocessor"></span>
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Aug 30 22:58:54 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>
