<!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: ConfigPage.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>ConfigPage.h</h1><a href="_config_page_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 ConfigPage.h</span> <a name="l00013"></a>00013 <span class="comment">** \version $Id: ConfigPage.h 3735 2009-04-28 20:28:01Z edmanm $</span> <a name="l00014"></a>00014 <span class="comment">** \brief Pure-virtual class for a configuration page</span> <a name="l00015"></a>00015 <span class="comment">*/</span> <a name="l00016"></a>00016 <a name="l00017"></a>00017 <span class="preprocessor">#ifndef _CONFIGPAGE_H</span> <a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define _CONFIGPAGE_H</span> <a name="l00019"></a>00019 <span class="preprocessor"></span> <a name="l00020"></a>00020 <span class="preprocessor">#include <QWidget></span> <a name="l00021"></a>00021 <a name="l00022"></a>00022 <a name="l00023"></a><a class="code" href="class_config_page.html">00023</a> <span class="keyword">class </span><a class="code" href="class_config_page.html">ConfigPage</a> : <span class="keyword">public</span> QWidget <a name="l00024"></a>00024 { <a name="l00025"></a>00025 Q_OBJECT <a name="l00026"></a>00026 <a name="l00027"></a>00027 <span class="keyword">public</span>:<span class="comment"></span> <a name="l00028"></a>00028 <span class="comment"> /** Default Constructor */</span> <a name="l00029"></a><a class="code" href="class_config_page.html#a9e4ac3da19017ce9b027eb2a9aafdd2c">00029</a> <a class="code" href="class_config_page.html#a9e4ac3da19017ce9b027eb2a9aafdd2c">ConfigPage</a>(QWidget *parent = 0, <span class="keyword">const</span> QString <a class="code" href="class_config_page.html#aabe42f1f82e9412de2d35ddde6ae965e">title</a> = QString()) <a name="l00030"></a>00030 : QWidget(parent), <a class="code" href="class_config_page.html#a8bb61b5bd9152530b815cd8d14770e18">_title</a>(<a class="code" href="class_config_page.html#aabe42f1f82e9412de2d35ddde6ae965e">title</a>) {} <a name="l00031"></a>00031 <span class="comment"></span> <a name="l00032"></a>00032 <span class="comment"> /** Returns the title of this configuration page. */</span> <a name="l00033"></a><a class="code" href="class_config_page.html#aabe42f1f82e9412de2d35ddde6ae965e">00033</a> QString <a class="code" href="class_config_page.html#aabe42f1f82e9412de2d35ddde6ae965e">title</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_config_page.html#a8bb61b5bd9152530b815cd8d14770e18">_title</a>; } <a name="l00034"></a>00034 <span class="comment"></span> <a name="l00035"></a>00035 <span class="comment"> /** Pure virtual method. Subclassed pages load their config settings here. */</span> <a name="l00036"></a>00036 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_config_page.html#af24af763436558c6db62c8ec04a6cb11">load</a>() = 0;<span class="comment"></span> <a name="l00037"></a>00037 <span class="comment"> /** Pure virtual method. Subclassed pages save their config settings here</span> <a name="l00038"></a>00038 <span class="comment"> * and return true if everything was saved successfully. */</span> <a name="l00039"></a>00039 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_config_page.html#a69161e9c64091a451508566cf5799223">save</a>(QString &errmsg) = 0; <a name="l00040"></a>00040 <span class="comment"></span> <a name="l00041"></a>00041 <span class="comment"> /** Subclassed pages can overload this method to return true if they</span> <a name="l00042"></a>00042 <span class="comment"> * contain settings that have been modified since they were last applied to</span> <a name="l00043"></a>00043 <span class="comment"> * Tor. The default implementation always returns false. */</span> <a name="l00044"></a><a class="code" href="class_config_page.html#a68319b29ef76c67dae682a2323f4fac8">00044</a> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_config_page.html#a68319b29ef76c67dae682a2323f4fac8">changedSinceLastApply</a>() { <a name="l00045"></a>00045 <span class="keywordflow">return</span> <span class="keyword">false</span>; <a name="l00046"></a>00046 }<span class="comment"></span> <a name="l00047"></a>00047 <span class="comment"> /** Subclassed pages can overload this method to apply any settings to</span> <a name="l00048"></a>00048 <span class="comment"> * Tor that have been modified since they were last applied (e.g., the</span> <a name="l00049"></a>00049 <span class="comment"> * changes were made while Tor was not running). Returns true if the changes</span> <a name="l00050"></a>00050 <span class="comment"> * were applied successfully. */</span> <a name="l00051"></a><a class="code" href="class_config_page.html#ae6cfa2d8018a96d778208783ecf296e5">00051</a> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_config_page.html#ae6cfa2d8018a96d778208783ecf296e5">apply</a>(QString &errmsg) { <a name="l00052"></a>00052 Q_UNUSED(errmsg); <a name="l00053"></a>00053 <span class="keywordflow">return</span> <span class="keyword">true</span>; <a name="l00054"></a>00054 }<span class="comment"></span> <a name="l00055"></a>00055 <span class="comment"> /** Subclassed pages can overload this method to revert any cancelled</span> <a name="l00056"></a>00056 <span class="comment"> * settings. */</span> <a name="l00057"></a><a class="code" href="class_config_page.html#a635d9aa1b0b54087c76c680d8a10a076">00057</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_config_page.html#a635d9aa1b0b54087c76c680d8a10a076">revert</a>() {} <a name="l00058"></a>00058 <a name="l00059"></a><a class="code" href="class_config_page.html#a0dc2d1cb496af21276f9e440ea584854">00059</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_config_page.html#a0dc2d1cb496af21276f9e440ea584854">retranslateUi</a>() {} <a name="l00060"></a>00060 <a name="l00061"></a>00061 signals:<span class="comment"></span> <a name="l00062"></a>00062 <span class="comment"> /** Signal emitted when a ConfigPage requests help information on a given</span> <a name="l00063"></a>00063 <span class="comment"> * <b>topic</b>. */</span> <a name="l00064"></a>00064 <span class="keywordtype">void</span> <a class="code" href="class_config_page.html#a9b3b555e76ae5de294cea3afb1b8e741">helpRequested</a>(<span class="keyword">const</span> QString &topic); <a name="l00065"></a>00065 <a name="l00066"></a>00066 <span class="keyword">private</span>: <a name="l00067"></a><a class="code" href="class_config_page.html#a8bb61b5bd9152530b815cd8d14770e18">00067</a> QString <a class="code" href="class_config_page.html#a8bb61b5bd9152530b815cd8d14770e18">_title</a>; <span class="comment">/**< Title of this configuration page. */</span> <a name="l00068"></a>00068 }; <a name="l00069"></a>00069 <a name="l00070"></a>00070 <span class="preprocessor">#endif</span> <a name="l00071"></a>00071 <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>